From c5d30baf60c5b8acd81a6fa5dd5ea0b2392de10e Mon Sep 17 00:00:00 2001 From: Michael R Sweet Date: Mon, 1 Mar 2004 02:05:02 +0000 Subject: Documentation updates (STR #245, STR #250, STR #277, STR #281) Fl_Preferences incorrectly created the preferences directory before necessary (STR #247) The WIN32 project files still defined the (obsolete) FL_STATIC constant (STR #279) Fl_Text_Display::buffer() did not support NULL values, making it impossible to clean up text buffers from a subclass (STR #295) Fl_Text_Display did not support a NULL unfinishedStyleCB function (STR #241) git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@3219 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/Fl_Input_.html | 9 +++++---- documentation/Fl_Menu_.html | 20 +++++++++++++++----- documentation/Fl_Text_Buffer.html | 21 ++++++++++++++------- 3 files changed, 34 insertions(+), 16 deletions(-) (limited to 'documentation') diff --git a/documentation/Fl_Input_.html b/documentation/Fl_Input_.html index 72792528f..5123405f3 100644 --- a/documentation/Fl_Input_.html +++ b/documentation/Fl_Input_.html @@ -223,12 +223,13 @@ l=0) leave the mark and position after it. If l is not zero then it is assumed to be strlen(t). -

int Fl_Input_::copy()

+

int Fl_Input_::copy(int clipboard)

Put the current selection between mark() and -position() into the clipboard. Does not replace the -old clipboard contents if position() and -mark() are equal. +position() into the specified clipboard. Does not +replace the old clipboard contents if position() and +mark() are equal. Clipboard 0 maps to the current text +selection and clipboard 1 maps to the cut/paste clipboard.

int Fl_Input_::undo()

diff --git a/documentation/Fl_Menu_.html b/documentation/Fl_Menu_.html index 7a1bbe7f5..19aebbe7d 100644 --- a/documentation/Fl_Menu_.html +++ b/documentation/Fl_Menu_.html @@ -50,22 +50,23 @@ be "private": a dynamically allocated array managed by the Fl_Menu_. @@ -93,10 +94,19 @@ deleted. NULL is allowed and acts the same as a zero-length menu. If you try to modify the array (with add(), replace(), or delete()) a private copy is automatically done. +

const Fl_Menu_Item* Fl_Menu_::mvalue() +const

+ +

Returns a pointer to the last menu item that was picked. +

void Fl_Menu_::copy(const -Fl_Menu_Item*)

-The menu is set to a private copy of the passed Fl_Menu_Item array. -This is useful if you want to modify the flags of the menu items. +Fl_Menu_Item*, void* user_data = 0) + +

The menu is set to a private copy of the passed Fl_Menu_Item +array. This is useful if you want to modify the flags of the +menu items. If the user_data argument is non-NULL, then +the user_data members of the menu items are set to the +given value.

void Fl_Menu_::clear()

Same as menu(NULL), set the array pointer to null, indicating diff --git a/documentation/Fl_Text_Buffer.html b/documentation/Fl_Text_Buffer.html index a7629e26b..5fe02c47c 100644 --- a/documentation/Fl_Text_Buffer.html +++ b/documentation/Fl_Text_Buffer.html @@ -223,7 +223,8 @@ int* rectEnd);

const char* highlight_text();

-

Returns the highlighted text. +

Returns the highlighted text. When you are done with the +text, free it using the free() function.

void insert_column(int column, int startPos, const char* text, int* charsInserted, int* charsDeleted);

@@ -253,7 +254,8 @@ int* charsInserted, int* charsDeleted);

const char* line_text(int pos);

Returns the text for the line containing the specified -character position. +character position. When you are done with the text, free it +using the free() function.

int loadfile(const char *file, int buflen = 128*1024);

@@ -340,7 +342,8 @@ int* rectStart, int* rectEnd);

const char* secondary_selection_text();

-

Returns the text in the secondary selection. +

Returns the text in the secondary selection. When you are +done with the text, free it using the free() function.

void secondary_select_rectangular(int start, int end, int rectStart, int rectEnd);

@@ -367,7 +370,8 @@ int selection_position(int* start, int* end, int* isRect, int* rectStart, int* r

const char* selection_text();

-

Returns the currently selected text. +

Returns the currently selected text. When you are done with +the text, free it using the free() function.

void select_rectangular(int start, int end, int rectStart, int rectEnd);

@@ -399,16 +403,19 @@ void tab_distance(int tabDist);

const char* text_in_rectangle(int start, int end, int rectStart, int rectEnd);

-

Returns the text from the given rectangle. +

Returns the text from the given rectangle. When you are done +with the text, free it using the free() function.

const char* text_range(int start, int end);

-

Returns the text from the range of characters. +

Returns the text from the range of characters. When you are +done with the text, free it using the free() function.

const char* text();
void text(const char* text);

-

Gets or sets the text in the buffer. +

Gets or sets the text in the buffer. When you are done with +the text, free it using the free() function.

void unhighlight();

-- cgit v1.2.3