diff options
Diffstat (limited to 'documentation/Fl_Browser.html')
| -rw-r--r-- | documentation/Fl_Browser.html | 136 |
1 files changed, 68 insertions, 68 deletions
diff --git a/documentation/Fl_Browser.html b/documentation/Fl_Browser.html index 22541b057..96a6ef5a7 100644 --- a/documentation/Fl_Browser.html +++ b/documentation/Fl_Browser.html @@ -19,32 +19,32 @@ </PRE> </UL> <H3>Description</H3> - The <TT>Fl_Browser</TT> widget displays a scrolling list of text -lines, and manages all the storage for the text. This is not a text -editor or spreadsheet! But it is useful for showing a vertical list of -named objects to the user. -<P>Each line in the browser is identified by number. <I>The numbers -start at one</I> (this is so that zero can be reserved for "no line" in -the selective browsers). <I>Unless otherwise noted, the methods do not -check to see if the passed line number is in range and legal. It must + The <TT>Fl_Browser</TT> widget displays a scrolling list of text +lines, and manages all the storage for the text. This is not a text +editor or spreadsheet! But it is useful for showing a vertical list of +named objects to the user. +<P>Each line in the browser is identified by number. <I>The numbers +start at one</I> (this is so that zero can be reserved for "no line" in +the selective browsers). <I>Unless otherwise noted, the methods do not +check to see if the passed line number is in range and legal. It must always be greater than zero and <= <TT>size()</TT>.</I></P> <P>Each line contains a null-terminated string of text and a <TT>void *</TT> data pointer. The text string is displayed, the <TT>void *</TT> - pointer can be used by the callbacks to reference the object the text + pointer can be used by the callbacks to reference the object the text describes. </P> -<P>The base class does nothing when the user clicks on it. The +<P>The base class does nothing when the user clicks on it. The subclasses <A href=Fl_Select_Browser.html#Fl_Select_Browser><TT> Fl_Select_Browser</TT></A>, <A href=Fl_Hold_Browser.html#Fl_Hold_Browser> <TT>Fl_Hold_Browser</TT></A>, and <A href=Fl_Multi_Browser.html#Fl_Multi_Browser> -<TT>Fl_Multi_Browser</TT></A> react to user clicks to select lines in +<TT>Fl_Multi_Browser</TT></A> react to user clicks to select lines in the browser and do callbacks. </P> <P>The base class called <A href=Fl_Browser_.html#Fl_Browser_><TT> -Fl_Browser_</TT></A> provides the scrolling and selection mechanisms of -this and all the subclasses, but the dimensions and appearance of each +Fl_Browser_</TT></A> provides the scrolling and selection mechanisms of +this and all the subclasses, but the dimensions and appearance of each item are determined by the subclass. You can use <TT>Fl_Browser_</TT> - to display information other than text, or text that is dynamically -produced from your own data structures. If you find that loading the -browser is a lot of work or is inefficient, you may want to make a + to display information other than text, or text that is dynamically +produced from your own data structures. If you find that loading the +browser is a lot of work or is inefficient, you may want to make a subclass of <TT>Fl_Browser_</TT>. </P> <H3>Methods</H3> <CENTER> @@ -88,51 +88,51 @@ subclass of <TT>Fl_Browser_</TT>. </P> </TD></TR> </TABLE> </CENTER> -<H4><A name=Fl_Browser.Fl_Browser>Fl_Browser::Fl_Browser(int, int, int, +<H4><A name=Fl_Browser.Fl_Browser>Fl_Browser::Fl_Browser(int, int, int, int, const char * = 0)</A></H4> - The constructor makes an empty browser. + The constructor makes an empty browser. <H4><A name=Fl_Browser.~Fl_Browser>Fl_Browser::~Fl_Browser(void)</A></H4> - The destructor deletes all list items and destroys the browser. -<H4><A name=Fl_Browser.add>void Fl_Browser::add(const char *, void * = + The destructor deletes all list items and destroys the browser. +<H4><A name=Fl_Browser.add>void Fl_Browser::add(const char *, void * = 0)</A></H4> - Add a new line to the end of the browser. The text is copied using -the <TT>strdup()</TT> function. It may also be <TT>NULL</TT> to make a + Add a new line to the end of the browser. The text is copied using +the <TT>strdup()</TT> function. It may also be <TT>NULL</TT> to make a blank line. The <TT>void *</TT> argument is returned as the <TT>data()</TT> - of the new item. + of the new item. <H4><A name=Fl_Browser.bottomline>void Fl_Browser::bottomline(int n)</A></H4> Scrolls the browser so the bottom line in the browser is <TT>n</TT>. <H4><A name=Fl_Browser.clear>void Fl_Browser::clear()</A></H4> - Remove all the lines in the browser. + Remove all the lines in the browser. <H4><A name=Fl_Browser.column_char>uchar Fl_Browser::column_char() const <BR> void Fl_Browser::column_char(char c)</A></H4> - The first form gets the current column separator character. By default -this is <TT>'\t'</TT> (tab). -<P>The second form sets the column separator to <TT>c</TT>. This will + The first form gets the current column separator character. By default +this is <TT>'\t'</TT> (tab). +<P>The second form sets the column separator to <TT>c</TT>. This will only have an effect if you also set <TT>column_widths()</TT>. </P> -<H4><A name=Fl_Browser.column_widths>const int +<H4><A name=Fl_Browser.column_widths>const int *Fl_Browser::column_widths() const <BR> void Fl_Browser::column_widths(const int *w)</A></H4> - The first form gets the current column width array. This array is -zero-terminated and specifies the widths in pixels of each column. The -text is split at each <TT>column_char()</TT> and each part is formatted -into it's own column. After the last column any remaining text is -formatted into the space between the last column and the right edge of + The first form gets the current column width array. This array is +zero-terminated and specifies the widths in pixels of each column. The +text is split at each <TT>column_char()</TT> and each part is formatted +into it's own column. After the last column any remaining text is +formatted into the space between the last column and the right edge of the browser, even if the text contains instances of <TT>column_char()</TT> -. The default value is a one-element array of just a zero, which makes -there are no columns. -<P>The second form sets the current array to <TT>w</TT>. Make sure the +. The default value is a one-element array of just a zero, which makes +there are no columns. +<P>The second form sets the current array to <TT>w</TT>. Make sure the last entry is zero. </P> <H4><A name=Fl_Browser.data>void *Fl_Browser::data(int n) const <BR> void Fl_Browser::data(int n, void *)</A></H4> - The first form returns the data for line <TT>n</TT>. If <TT>n</TT> is -out of range this returns <TT>NULL</TT>. + The first form returns the data for line <TT>n</TT>. If <TT>n</TT> is +out of range this returns <TT>NULL</TT>. <P>The second form sets the data for line <TT>n</TT>. </P> <H4><A name=Fl_Browser.format_char>uchar Fl_Browser::format_char() const <BR> void Fl_Browser::format_char(char c)</A></H4> - The first form gets the current format code prefix character, which by -default is <TT>@</TT>. A string of formatting codes at the start of -each column are stripped off and used to modify how the rest of the -line is printed: + The first form gets the current format code prefix character, which by +default is <TT>@</TT>. A string of formatting codes at the start of +each column are stripped off and used to modify how the rest of the +line is printed: <UL> <LI><CODE>@.</CODE> Print rest of line, don't look for more '@' signs </LI> <LI><CODE>@@</CODE> Print rest of line starting with '@' </LI> @@ -145,7 +145,7 @@ line is printed: font (sets font to FL_COURIER) </LI> <LI><CODE>@c</CODE> Center the line horizontally </LI> <LI><CODE>@r</CODE> Right-justify the text </LI> -<LI><CODE>@B0, @B1, ... @B255</CODE> Fill the backgound with +<LI><CODE>@B0, @B1, ... @B255</CODE> Fill the backgound with fl_color(n) </LI> <LI><CODE>@C0, @C1, ... @C255</CODE> Use fl_color(n) to draw the text </LI> <LI><CODE>@F0, @F1, ... </CODE> Use fl_font(n) to draw the text </LI> @@ -153,54 +153,54 @@ fl_color(n) </LI> <LI><CODE>@u</CODE> or <CODE>@_</CODE> Underline the text. </LI> <LI><CODE>@-</CODE> draw an engraved line through the middle. </LI> </UL> - Notice that the <CODE>@.</CODE> command can be used to reliably + Notice that the <CODE>@.</CODE> command can be used to reliably terminate the parsing. To print a random string in a random color, use <TT> -sprintf("@C%d@.%s", color, string)</TT> and it will work even if the -string starts with a digit or has the format character in it. -<P>The second form sets the current prefix to <TT>c</TT>. Set the +sprintf("@C%d@.%s", color, string)</TT> and it will work even if the +string starts with a digit or has the format character in it. +<P>The second form sets the current prefix to <TT>c</TT>. Set the prefix to 0 to disable formatting. </P> <H4><A name=Fl_Browser.hide>void Fl_Browser::hide(int n)</A></H4> - Makes line <TT>n</TT> invisible, preventing selection by the user. - The line can still be selected under program control. -<H4><A name=Fl_Browser.insert>void Fl_Browser::insert(int n, const char + Makes line <TT>n</TT> invisible, preventing selection by the user. + The line can still be selected under program control. +<H4><A name=Fl_Browser.insert>void Fl_Browser::insert(int n, const char *, void * = 0)</A></H4> Insert a new line <I>before</I> line <TT>n</TT>. If <TT>n</TT> > <TT> -size()</TT> then the line is added to the end. +size()</TT> then the line is added to the end. <H4><A name=Fl_Browser.load>int Fl_Browser::load(const char *filename)</A> </H4> - Clears the browser and reads the file, adding each line from the file -to the browser. If the filename is <TT>NULL</TT> or a zero-length -string then this just clears the browser. This returns zero if there + Clears the browser and reads the file, adding each line from the file +to the browser. If the filename is <TT>NULL</TT> or a zero-length +string then this just clears the browser. This returns zero if there was any error in opening or reading the file, in which case <TT>errno</TT> - is set to the system error. The <TT>data()</TT> of each line is set -to <TT>NULL</TT>. + is set to the system error. The <TT>data()</TT> of each line is set +to <TT>NULL</TT>. <H4><A name=Fl_Browser.middleline>void Fl_Browser::middleline(int n)</A></H4> Scrolls the browser so the middle line in the browser is <TT>n</TT>. <H4><A name=Fl_Browser.move>void Fl_Browser::move(int to, int from)</A></H4> Line <TT>from</TT> is removed and reinserted at <TT>to</TT>; <TT>to</TT> - is calculated after the line is removed. + is calculated after the line is removed. <H4><A name=Fl_Browser.position>int Fl_Browser::position() const <BR> void Fl_Browser::position(int p)</A></H4> - The first form returns the current vertical scrollbar position, where -0 corresponds to the top. If there is not vertical scrollbar then this -will always return 0. + The first form returns the current vertical scrollbar position, where +0 corresponds to the top. If there is not vertical scrollbar then this +will always return 0. <P>The second form sets the vertical scrollbar position to <TT>p</TT>. </P> <H4><A name=Fl_Browser.remove>void Fl_Browser::remove(int n)</A></H4> - Remove line <TT>n</TT> and make the browser one line shorter. + Remove line <TT>n</TT> and make the browser one line shorter. <H4><A name=Fl_Browser.show>void Fl_Browser::show(int n)</A></H4> - Makes line <TT>n</TT> visible for selection. + Makes line <TT>n</TT> visible for selection. <H4><A name=Fl_Browser.size>int Fl_Browser::size() const</A></H4> - Returns how many lines are in the browser. The last line number is -equal to this. + Returns how many lines are in the browser. The last line number is +equal to this. <H4><A name=Fl_Browser.text>const char *Fl_Browser::text(int n) const <BR> void Fl_Browser::text(int n, const char *)</A></H4> - The first form returns the text for line <TT>n</TT>. If <TT>n</TT> is -out of range it returns <TT>NULL</TT>. + The first form returns the text for line <TT>n</TT>. If <TT>n</TT> is +out of range it returns <TT>NULL</TT>. <P>The second form sets the text for line <TT>n</TT>. </P> <H4><A name=Fl_Browser.topline>int Fl_Browser::topline() const <BR> void Fl_Browser::topline(int n)</A></H4> -The first form returns the current top line in the browser. If there -is no vertical scrollbar then this will always return 1. +The first form returns the current top line in the browser. If there +is no vertical scrollbar then this will always return 1. <P>The second form scrolls the browser so the top line in the browser is <TT>n</TT>.</P> <H4><A name=Fl_Browser.visible>int Fl_Browser::visible(int n) const</A></H4> Returns a non-zero value if line <TT>n</TT> is visible. </BODY></HTML> |