From 9ca9171e7a35f4a2b3b6c8b52bdc966218b8137f Mon Sep 17 00:00:00 2001 From: Michael R Sweet Date: Thu, 18 Apr 2002 19:10:56 +0000 Subject: [PATCH] Fl_Text_Buffer docos. Reformat function reference (still need to add rest of drawing functions...) git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@2096 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/Fl.html | 2 +- documentation/Fl_Text_Buffer.html | 163 +++++ documentation/enumerations.html | 41 +- documentation/functions.html | 1003 ++++++++++++++++++++++++----- 4 files changed, 994 insertions(+), 215 deletions(-) diff --git a/documentation/Fl.html b/documentation/Fl.html index 7b4e6f5c3..15e52dece 100644 --- a/documentation/Fl.html +++ b/documentation/Fl.html @@ -15,7 +15,7 @@

Include Files

Description

diff --git a/documentation/Fl_Text_Buffer.html b/documentation/Fl_Text_Buffer.html index 2a9ac0e05..ebc4a913b 100644 --- a/documentation/Fl_Text_Buffer.html +++ b/documentation/Fl_Text_Buffer.html @@ -108,157 +108,320 @@ excellent NEdit text editor engine - see

Fl_Text_Buffer(int requestedSize = 0);

+

Creates a new text buffer of the specified initial size. +

~Fl_Text_Buffer();

+

Destroys a text buffer. +

void add_modify_callback(Fl_Text_Modify_Cb bufModifiedCB, void* cbArg);

+

Adds a callback function that is called whenever the text buffer is +modified. The callback function is declared as follows: + +

+

void append(const char* text);

+

Appends the text string to the end of the buffer. +

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

+

Appends the named file to the end of the buffer. +

void call_modify_callbacks();

+

Calls all modify callbacks that have been registered using +the add_modify_callback() +method. +

char character(int pos);

+

Returns the character at the specified position in the buffer. +

static int character_width(char c, int indent, int tabDist, char nullSubsChar);

+

Returns the column width of the specified character. The +indent argument specifies the current column position, +and tabDist specifies the number of columns to use for +each tab. + +

The nullSubsChar argument specifies the current +nul character. +

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

+

Clears text in the specified area. +

void copy(Fl_Text_Buffer* fromBuf, int fromStart, int fromEnd, int toPos);

+

Copies text from one buffer to this one; fromBuf may +be the same as this. +

int count_displayed_characters(int lineStartPos, int targetPos);

+

Determines the number of characters that will be displayed +between lineStartPos and targetPos. +

int count_lines(int startPos, int endPos);

+

Determines the number of lines between startPos and +endPos. +

int expand_character(int pos, int indent, char *outStr);
static int expand_character(char c, int indent, char* outStr, int tabDist, char nullSubsChar);

+

Expands the given character to a displayable format. Tabs and +other control characters are given special treatment. +

int findchar_backward(int startPos, char searchChar, int* foundPos);

+

Finds the previous occurrence of the specified character. +

int findchar_forward(int startPos, char searchChar, int* foundPos);

+

Finds the next occurrence of the specified character. +

int findchars_backward(int startPos, const char* searchChars, int* foundPos);

+

Finds the previous occurrence of the specified characters. +

int findchars_forward(int startPos, const char* searchChars, int* foundPos);

+

Finds the next occurrence of the specified characters. +

void highlight(int start, int end);

+

Highlights the specified text within the buffer. +

int highlight_position(int* start, int* end, int* isRect, int* rectStart, int* rectEnd);

+

Returns the current highlight positions. +

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

+

Highlights the specified rectangle of text within the buffer. +

Fl_Text_Selection* highlight_selection();

+

Returns the current highlight selection. +

const char* highlight_text();

+

Returns the highlighted text. +

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

+

Inserts a column of text without calling the modify callbacks. +

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

+

Inserts a file at the specified position. +

void insert(int pos, const char* text);

+

Inserts text at the specified position. +

int length();

+

Returns the number of characters in the buffer. +

int line_end(int pos);

+

Returns the end position of the line. +

int line_start(int pos);

+

Returns the start position of the line. +

const char* line_text(int pos);

+

Returns the text for the line containing the specified +character position. +

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

+

Replaces the current buffer with the contents of a file. +

char null_substitution_character();

+

Returns the current nul substitution character. +

int outputfile(const char *file, int start, int end, int buflen = 128*1024);

+

Writes the specified portions of the file to a file. +

void overlay_rectangular(int startPos, int rectStart, int rectEnd, const char* text, int* charsInserted, int* charsDeleted);

+

Replaces a rectangular region of text with the given text. +

Fl_Text_Selection* primary_selection();

+

Returns the primary selection. +

void remove_modify_callback(Fl_Text_Modify_Cb bufModifiedCB, void* cbArg);

+

Removes a modify callback. +

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

+

Deletes a rectangular area of text in the buffer. +

void remove(int start, int end);

+

Deletes a range of characters in the buffer. +

void remove_secondary_selection();

+

Removes the text in the secondary selection. +

void remove_selection();

+

Removes the text in the primary selection. +

void replace_rectangular(int start, int end, int rectStart, int rectEnd, const char* text);

+

Replaces the text in a rectangular area. +

void replace(int start, int end, const char *text);

+

Replaces the text in the specified range of characters in the buffer. +

void replace_secondary_selection(const char* text);

+

Replaces the text in the secondary selection. +

void replace_selection(const char* text);

+

Replaces the text in the primary selection. +

int rewind_lines(int startPos, int nLines);

+

Returns the buffer position for the Nth previous line. +

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

+

Saves the entire buffer to a file. +

int search_backward(int startPos, const char* searchString, int* foundPos, int matchCase = 0);

+

Searches backwards for the specified string. +

int search_forward(int startPos, const char* searchString, int* foundPos, int matchCase = 0);

+

Searches forwards for the specified string. +

int secondary_selection_position(int* start, int* end, int* isRect, int* rectStart, int* rectEnd);

Fl_Text_Selection* secondary_selection();

+

Returns the secondary selection. +

const char* secondary_selection_text();

+

Returns the text in the secondary selection. +

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

+

Selects a rectangle of characters in the secondary selection. +

void secondary_select(int start, int end);

+

Selects a range of characters in the secondary selection. +

void secondary_unselect();

+

Turns the secondary selection off. +

int selected();

+

Returns a non-zero number if any text has been selected, or 0 +if no text is selected. +

int selection_position(int* start, int* end);
int selection_position(int* start, int* end, int* isRect, int* rectStart, int* rectEnd);

+

Returns the current selection. +

const char* selection_text();

+

Returns the currently selected text. +

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

+

Selects a rectangle of characters in the buffer. +

void select(int start, int end);

+

Selects a range of characters in the buffer. +

int skip_displayed_characters(int lineStartPos, int nChars);

+

Skips forward the indicated number of characters in the +buffer from the start position. +

int skip_lines(int startPos, int nLines);

+

Returns the buffer position for the Nth line after the start +position. +

int substitute_null_characters(char* string, int length);

+

Replaces nul characters in the given string with the +nul substitution character. +

int tab_distance();
void tab_distance(int tabDist);

+

Gets or sets the tab width. +

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

+

Returns the text from the given rectangle. +

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

+

Returns the text from the range of characters. +

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

+

Gets or sets the text in the buffer. +

void unhighlight();

+

Unhighlights text in the buffer. +

void unselect();

+

Unselects text in the buffer. +

void unsubstitute_null_characters(char* string);

+

Replaces the nul substitution characters in the +provided string with the nul character. +

int word_end(int pos);

+

Returns the position for the end of the word. +

int word_start(int pos);

+

Returns the position for the start of the word. diff --git a/documentation/enumerations.html b/documentation/enumerations.html index 8c6c98951..032eb33d8 100644 --- a/documentation/enumerations.html +++ b/documentation/enumerations.html @@ -132,6 +132,7 @@ FL_KEYBOARD and FL_SHORTCUT events:

  • FL_BUTTON2 - Mouse button 2 is pushed.
  • FL_BUTTON3 - Mouse button 3 is pushed.
    • +

    Alignment Values

    The following constants define bits that can be used with Fl_Widget::align() to control the positioning of the @@ -230,42 +231,10 @@ FLTK standard color cube: -

    The inline methods for getting a grayscale, color cube, or RGB color -value are described next. - -

    Color Functions

    - -

    Fl_Color fl_gray_ramp(int i)

    - -

    Returns a gray color value from black (i == 0) to -white (i == FL_NUM_GRAY - 1). FL_NUM_GRAY is -defined to be 24 in the current FLTK release. To get the closest -FLTK gray value to an 8-bit grayscale color 'I' use: - -

    - -

    Fl_Color fl_color_cube(int r, int g, int b)

    - -

    Returns a color out of the color cube. -r must be in the range 0 to FL_NUM_RED (5) minus 1. -g must be in the range 0 to FL_NUM_GREEN (8) minus 1. -b must be in the range 0 to FL_NUM_BLUE (5) minus 1. - -

    To get the closest color to a 8-bit set of R,G,B values use: - -

    - -

    Fl_Color fl_rgb_color(uchar r, uchar g, uchar b)
    -Fl_Color fl_rgb_color(uchar g)

    - -

    Returns the 24-bit RGB color value for the specified 8-bit -RGB or grayscale values. +

    The inline methods for getting a grayscale, color cube, or +RGB color value are described in Appendix B - Function +Reference.

    Cursors

    diff --git a/documentation/functions.html b/documentation/functions.html index e999f4214..6dd68e13e 100644 --- a/documentation/functions.html +++ b/documentation/functions.html @@ -1,14 +1,194 @@ - + + -

    B - Function Reference

    +

    B - Function Reference

    -This appendix describes all of the fl_ functions. For a +

    This appendix describes all of the fl_ functions. For a description of the FLTK classes, see Appendix A. -

    Functions

    +

    Function List by Name

    -

    void fl_beep(int type = FL_BEEP_DEFAULT)

    + + +

    Function List by Category

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    fl_alert

    + +
    + +

    Include Files

    + + + +

    Prototype

    + + + +

    Description

    + +

    Same as fl_message() except for the "!" symbol. + +

    The fl_alert window + + + +

    fl_ask

    + +
    + +

    Include Files

    + + + +

    Prototype

    + + + +

    Description

    + +

    Displays a printf-style message in a pop-up box with an +"Yes" and "No" button and waits for the user +to hit a button. The return value is 1 if the user hits Yes, 0 +if they pick No. The enter key is a shortcut for Yes and ESC is +a shortcut for No. + +

    The fl_ask window. + + + +

    fl_beep

    + +
    + +

    Include Files

    + + + +

    Prototype

    + + + +

    Description

    Sounds an audible notification; the default type argument sounds a simple "beep" sound. Other values for type may use @@ -35,233 +215,700 @@ a system or user-defined sound file: -

    int fl_color_chooser(const char -*title, double &r, double &g, double &b) -
    int fl_color_chooser(const char *title, uchar &r, uchar &g, uchar &b)

    + + +

    fl_choice

    + +
    + +

    Include Files

    + + + +

    Prototype

    + + + +

    Description

    + +

    Shows the message with three buttons below it marked with the +strings b0, b1, and b2. Returns 0, +1, or 2 depending on which button is hit. ESC is a shortcut for +button 0 and the enter key is a shortcut for button 1. Notice +the buttons are positioned "backwards". You can hide +buttons by passing NULL as their labels. + +

    The fl_choice window. + + + +

    fl_color_chooser

    + +
    + +

    Include Files

    + + + +

    Prototype

    + + + +

    Description

    The double version takes RGB values in the range 0.0 to 1.0. The uchar version takes RGB values in the range 0 to 255. The title argument specifies the label (title) for the window. -

    The fl_color_chooser dialog. +

    The fl_color_chooser dialog.

    -

    fl_color_chooser() pops up a window to let the user pick an -arbitrary RGB color. They can pick the hue and saturation in the "hue -box" on the left (hold down CTRL to just change the saturation), and -the brighness using the vertical slider. Or they can type the 8-bit -numbers into the RGB -Fl_Value_Input fields, or drag the mouse across them to adjust -them. The pull-down menu lets the user set the input fields to show -RGB, HSV, or 8-bit RGB (0 to 255). +

    fl_color_chooser() pops up a window to let the user +pick an arbitrary RGB color. They can pick the hue and +saturation in the "hue box" on the left (hold down +CTRL to just change the saturation), and the brighness using the +vertical slider. Or they can type the 8-bit numbers into the +RGB +Fl_Value_Input fields, or drag the mouse across them to +adjust them. The pull-down menu lets the user set the input +fields to show RGB, HSV, or 8-bit RGB (0 to 255). -

    This returns non-zero if the user picks ok, and updates the RGB -values. If the user picks cancel or closes the window this returns -zero and leaves RGB unchanged. +

    This returns non-zero if the user picks ok, and updates the +RGB values. If the user picks cancel or closes the window this +returns zero and leaves RGB unchanged. -

    If you use the color chooser on an 8-bit screen, it will allocate -all the available colors, leaving you no space to exactly represent the -color the user picks! You can however use -fl_rectf() to fill a region with a simulated color using -dithering. +

    If you use the color chooser on an 8-bit screen, it will +allocate all the available colors, leaving you no space to +exactly represent the color the user picks! You can however use + fl_rectf() to fill a +region with a simulated color using dithering. -

    int fl_show_colormap(int oldcol)

    -fl_show_colormap() pops up a panel of the 256 colors you can -access with fl_color() and lets the user -pick one of them. It returns the new color index, or the old one if -the user types ESC or clicks outside the window. -

    The fl_show_colormap dialog + +

    fl_color_cube

    -

    void fl_message(const char *, ...)

    +
    -Displays a printf-style message in a pop-up box with an "OK" button, -waits for the user to hit the button. The message will wrap to fit the -window, or may be many lines by putting \n characters into it. -The enter key is a shortcut for the OK button. -

    The fl_message window. +

    Include File

    -

    void fl_alert(const char *, ...)

    + -Same as fl_message() except for the "!" symbol. -

    The fl_alert window +

    Prototype

    -

    int fl_ask(const char *, ...)

    + -Displays a printf-style message in a pop-up box with an -"Yes" and "No" button and waits for the user to -hit a button. The return value is 1 if the user hits Yes, 0 if they -pick No. The enter key is a shortcut for Yes and ESC is a shortcut -for No. +

    Description

    -

    The fl_ask window. +

    Returns a color out of the color cube. r must be in +the range 0 to FL_NUM_RED (5) minus 1. g must be in the +range 0 to FL_NUM_GREEN (8) minus 1. b must be in the +range 0 to FL_NUM_BLUE (5) minus 1. -

    int fl_choice(const char *q, const char *b0, -const char *b1, const char *b2, ...)

    +

    To get the closest color to a 8-bit set of R,G,B values use: -Shows the message with three buttons below it marked with the strings - b0, b1, and b2. Returns 0, 1, or 2 -depending on which button is hit. ESC is a shortcut for button 0 and -the enter key is a shortcut for button 1. Notice the buttons are -positioned "backwards" You can hide buttons by passing -NULL as their labels. +

    -

    The fl_choice window. -

    const char *fl_input(const char *label, const char -*deflt = 0, ...)

    + +

    fl_file_chooser

    -Pops up a window displaying a string, lets the user edit it, and -return the new value. The cancel button returns NULL. The -returned pointer is only valid until the next time fl_input() -is called. Due to back-compatability, the arguments to any printf -commands in the label are after the default value. +
    -

    The fl_input window. +

    Include Files

    -

    const char *fl_password(const char *label, -const char *deflt = 0, ...)

    + -Same as fl_input() except an Fl_Secret_Input field is used. +

    Prototype

    -

    The fl_password window. +

    -

    void fl_message_font(Fl_Font fontid, uchar -size)

    +

    Description

    -Change the font and font size used for the messages in all the popups. +

    FLTK provides a "tab completion" file chooser that +makes it easy to choose files from large directories. This file +chooser has several unique features, the major one being that +the Tab key completes filenames like it does in Emacs or tcsh, +and the list always shows all possible completions. -

    Fl_Widget *fl_message_icon()

    +

    The fl_file_chooser window. -Returns a pointer to the box at the left edge of all the popups. You -can alter the font, color, or label (including making it a Pixmap), -before calling the functions. - -

    char *fl_file_chooser(const char * message, -const char *pattern, const char *fname)

    - -FLTK provides a "tab completion" file chooser that makes it easy to -choose files from large directories. This file chooser has several -unique features, the major one being that the Tab key completes -filenames like it does in Emacs or tcsh, and the list always shows all -possible completions. - -

    The fl_file_chooser window. - -fl_file_chooser() pops up the file chooser, waits for the user -to pick a file or Cancel, and then returns a pointer to that filename -or NULL if Cancel is chosen. +

    fl_file_chooser() pops up the file chooser, waits +for the user to pick a file or Cancel, and then returns a +pointer to that filename or NULL if Cancel is chosen.

    message is a string used to title the window. -

    pattern is used to limit the files listed in a directory to -those matching the pattern. This matching is done by -fl_filename_match(). Use NULL to show all files. +

    pattern is used to limit the files listed in a +directory to those matching the pattern. This matching is done +by fl_filename_match(). Use +NULL to show all files. -

    fname is a default filename to fill in the chooser with. -If this is NULL then the last filename that was choosen is -used (unless that had a different pattern, in which case just the last -directory with no name is used). The first time the file chooser is -called this defaults to a blank string. +

    fname is a default filename to fill in the chooser +with. If this is NULL then the last filename that was +choosen is used (unless that had a different pattern, in which +case just the last directory with no name is used). The first +time the file chooser is called this defaults to a blank string. -

    The returned value points at a static buffer that is only good until -the next time fl_file_chooser() is called. +

    The returned value points at a static buffer that is only +good until the next time fl_file_chooser() is called. -

    void fl_file_chooser_callback(void -(*cb)(const char *))

    -Set a function that is called every time the user clicks a file in the -currently popped-up file chooser. This could be used to preview the -contents of the file. It has to be reasonably fast, and cannot create -FLTK windows. + +

    fl_file_chooser_callback

    -

    int fl_filename_list(const char *d, dirent -***list)

    +
    -This is a portable and const-correct wrapper for the -fl_scandir function. d is the name of a directory -(it does not matter if it has a trailing slash or not). For each file -in that directory a "dirent" structure is created. The only -portable thing about a dirent is that dirent.d_name is the -nul-terminated file name. An array of pointers to these dirents is -created and a pointer to the array is returned in *list. The -number of entries is given as a return value. If there is an error +

    Include Files

    + + + +

    Prototype

    + + + +

    Description

    + +

    Sets a function that is called every time the user clicks a +file in the currently popped-up file chooser. This could be used +to preview the contents of the file. It has to be reasonably +fast, and cannot create FLTK windows. + + + +

    fl_filename_absolute

    + +
    + +

    Include Files

    + + + +

    Prototype

    + + + +

    Description

    + +

    Converts a relative pathname to an absolute pathname. If +from does not start with a slash, the current working +directory is prepended to from with any occurances of +. and x/.. deleted from the result. The +absolute pathname is copied to to; from and +to may point to the same buffer. +fl_filename_absolute returns non-zero if any changes +were made. + +

    The first form accepts a maximum length (tolen) for +the destination buffer, while the second form assumes that the +destination buffer is at least FL_PATH_MAX characters +in length. + + + +

    fl_filename_expand

    + +
    + +

    Include Files

    + + + +

    Prototype

    + + + +

    Description

    + +

    This function replaces environment variables and home +directories with the corresponding strings. Any occurrence of +$X is replaced by getenv("X"); if +$X is not defined in the environment, the occurrence is +not replaced. Any occurence of ~X is replaced by user +X's home directory; if user X does not exist, +the occurrence is not replaced. Any resulting double slashes +cause everything before the second slash to be deleted. + +

    The result is copied to to, and from and +to may point to the same buffer. +fl_filename_expand() returns non-zero if any changes +were made. + +

    The first form accepts a maximum length (tolen) for +the destination buffer, while the second form assumes that the +destination buffer is at least FL_PATH_MAX characters +in length. + + + +

    fl_filename_ext

    + +
    + +

    Include Files

    + + + +

    Prototype

    + + + +

    Description

    + +

    Returns a pointer to the last period in +fl_filename_name(f), or a pointer to the trailing +nul if none is found. + + + +

    fl_filename_isdir

    + +
    + +

    Include Files

    + + + +

    Prototype

    + + + +

    Description

    + +

    Returns non-zero if the file exists and is a directory. + + + +

    fl_filename_list

    + +
    + +

    Include Files

    + + + +

    Prototype

    + + + +

    Description

    + +

    This is a portable and const-correct wrapper for the +scandir() function. d is the name of a +directory; it does not matter if it has a trailing slash or not. +For each file in that directory a "dirent" structure +is created. The only portable thing about a dirent is that +dirent.d_name is the nul-terminated file name. +An array of pointers to these dirent's is created and a +pointer to the array is returned in *list. The number +of entries is given as a return value. If there is an error reading the directory a number less than zero is returned, and -errno has the reason (errno does not work under -WIN32). The files are sorted in "alphanumeric" order, where -an attempt is made to put unpadded numbers in consecutive order. +errno has the reason; errno does not work +under WIN32. The files are sorted in "alphanumeric" +order, where an attempt is made to put unpadded numbers in +consecutive order. -

    You can free the returned list of files with the following code: +

    You can free the returned list of files with the following +code: -

    + -Returns non-zero if the file exists and is a directory. -

    const char *fl_filename_name(const char *f)

    + +

    fl_filename_match

    -Returns a pointer to the character after the last slash, or to the -start of the filename if there is none. +
    -

    const char *fl_filename_ext(const char *f)

    +

    Include Files

    -Returns a pointer to the last period in fl_filename_name(f), or -a pointer to the trailing nul if none. + -

    char *fl_filename_setext(char *f, const char -*ext)

    +

    Prototype

    -Does strcpy(fl_filename_ext(f), ext ? ext : ""). Returns a -pointer to f. + -

    int fl_filename_expand(char *out, const char -*in)

    +

    Description

    -Splits in at each slash character. Replaces any occurrance -of $X with getenv("X") (leaving it as -$X if the environment variable does not exist). Replaces any -occurances of ~X with user X's home directory -(leaving it as ~X if the user does not exist). Any resulting -double slashes cause everything before the second slash to be deleted. -Copies the result to out (in and out may -be the same buffer). Returns non-zero if any changes were made. In -true retro programming style, it is up to you to provide a buffer big -enough for the result. 1024 characters should be enough. - -

    int fl_filename_absolute(char *out, const -char *in)

    - -If in does not start with a slash, this prepends the current -working directory to in and then deletes any occurances of -. and x/.. from the result, which it copies to out (in -and out may be the same buffer). Returns non-zero if any -changes were made. In true retro programming style, it is up to you -to provide a buffer big enough for the result. 1024 characters should -be enough. - -

    int fl_filename_match(const char *f, const char -*pattern)

    - -Returns true if f matches pattern. The following -syntax is used by pattern: +

    Returns non-zero if f matches pattern. The +following syntax is used by pattern:

    - - + + +

    fl_filename_name

    + +
    + +

    Include Files

    + + + +

    Prototype

    + + + +

    Description

    + +

    Returns a pointer to the character after the last slash, or +to the start of the filename if there is none. + + + +

    fl_filename_relative

    + +
    + +

    Include Files

    + + + +

    Prototype

    + + + +

    Description

    + +

    Converts an absolute pathname to an relative pathname. The +relative pathname is copied to to; from and +to may point to the same buffer. +fl_filename_relative returns non-zero if any changes +were made. + +

    The first form accepts a maximum length (tolen) for +the destination buffer, while the second form assumes that the +destination buffer is at least FL_PATH_MAX characters +in length. + + + +

    fl_filename_setext

    + +
    + +

    Include Files

    + + + +

    Prototype

    + + + +

    Description

    + +

    Replaces the extension in to with the extension in +ext. Returns a pointer to to. + +

    The first form accepts a maximum length (tolen) for +the destination buffer, while the second form assumes that the +destination buffer is at least FL_PATH_MAX characters +in length. + + + +

    fl_gray_ramp

    + +
    + +

    Include File

    + + + +

    Prototype

    + + + +

    Description

    + +

    Returns a gray color value from black (i == 0) to +white (i == FL_NUM_GRAY - 1). FL_NUM_GRAY is +defined to be 24 in the current FLTK release. To get the closest +FLTK gray value to an 8-bit grayscale color 'I' use: + +

    + + + +

    fl_input

    + +
    + +

    Include Files

    + + + +

    Prototype

    + + + +

    Description

    + +

    Pops up a window displaying a string, lets the user edit it, +and return the new value. The cancel button returns +NULL. The returned pointer is only valid until the +next time fl_input() is called. Due to +back-compatability, the arguments to any printf commands in the +label are after the default value. + +

    The fl_input window. + + + +

    fl_message

    + +
    + +

    Include Files

    + + + +

    Prototype

    + + + +

    Description

    + +

    Displays a printf-style message in a pop-up box with an +"OK" button, waits for the user to hit the button. +The message will wrap to fit the window, or may be many lines by +putting \n characters into it. The enter key is a +shortcut for the OK button. + +

    The fl_message window. + + + +

    fl_message_font

    + +
    + +

    Include Files

    + + + +

    Prototype

    + + + +

    Description

    + +

    Changes the font and font size used for the messages in all +the popups. + + + +

    fl_message_icon

    + +
    + +

    Include Files

    + + + +

    Prototype

    + + + +

    Description

    + +

    Returns a pointer to the box at the left edge of all the +popups. You can alter the font, color, label, or image before +calling the functions. + + + +

    fl_password

    + +
    + +

    Include Files

    + + + +

    Prototype

    + + + +

    Description

    + +

    Same as fl_input(), except an Fl_Secret_Input field is +used. + + + +

    fl_rgb_color

    + +
    + +

    Include File

    + + + +

    Prototype

    + + + +

    Description

    + +

    Returns the 24-bit RGB color value for the specified 8-bit +RGB or grayscale values. + + + +

    fl_show_colormap

    + +
    + +

    Include Files

    + + + +

    Prototype

    + + + +

    Description

    + +

    fl_show_colormap() pops up a panel of the 256 colors +you can access with fl_color() and lets +the user pick one of them. It returns the new color index, or +the old one if the user types ESC or clicks outside the window. + +

    The fl_show_colormap dialog + + + +