diff --git a/documentation/Fl_FileBrowser.html b/documentation/Fl_FileBrowser.html new file mode 100644 index 000000000..4a0203298 --- /dev/null +++ b/documentation/Fl_FileBrowser.html @@ -0,0 +1,79 @@ + +
++Fl_Browser + | + +----FileBrowser ++ +
+#include "FileBrowser.h" ++ +
The FileBrowser widget displays a list of filenames,
+optionally with file-specific icons.
+
+
The constructor creates the FileBrowser widget at the specified
+position and size.
+
+
The destructor destroys the widget and frees all memory that has been +allocated. + +
Sets or gets the size of the icons. The default size is 20 pixels. + +
Sets or gets the filename filter. The pattern matching uses the
+filename_match() function in FLTK.
+
+
Loads the specified directory into the browser. If icons have been +loaded then the correct icon is associated with each file in the list. + + + diff --git a/documentation/Fl_FileChooser.gif b/documentation/Fl_FileChooser.gif new file mode 100644 index 000000000..5a72f625a Binary files /dev/null and b/documentation/Fl_FileChooser.gif differ diff --git a/documentation/Fl_FileChooser.html b/documentation/Fl_FileChooser.html new file mode 100644 index 000000000..6a3010702 --- /dev/null +++ b/documentation/Fl_FileChooser.html @@ -0,0 +1,172 @@ + +
++Fl_Group + | + +----FileChooser ++ +
+#include "FileChooser.h" ++ +
The FileChooser widget displays a standard file selection
+dialog that supports various selection modes.
+
+

The constructor creates the FileChooser dialog pictured
+above. The pathname argument can be a directory name or a
+complete file name (in which case the corresponding file is highlighted
+in the list and in the filename input field.)
+
+
The pattern argument can be a NULL string or
+"*" to list all files. See the FLTK documentation on
+filename_match() for other kinds of patterns.
+
+
The type argument can be one of the following:
+
+
SINGLE - allows the user to select a
+ single, existing file.
+ MULTI - allows the user to select one
+ or more existing files.
+ CREATE - allows the user to select a
+ single, existing file or specify a new filename.
+The title argument is used to set the title bar text for the
+FileChooser window.
+
+
Destroys the widget and frees all memory used by it. + +
Sets or gets the background color of the FileBrowser list.
+
+
Returns the number of selected files. + +
Sets or gets the current directory. + +
Sets or gets the current filename filter pattern. + +
Hides the FileChooser window.
+
+
Sets or gets the size of the icons in the FileBrowser. By
+default the icon size is set to 1.5 times the textsize().
+
+
Sets or gets the title bar text for the FileChooser.
+
+
Reloads the current directory in the FileBrowser.
+
+
Shows the FileChooser window.
+
+
Sets or gets the current FileBrowser text color.
+
+
Sets or gets the current FileBrowser text font.
+
+
Sets or gets the current FileBrowser text size.
+
+
Sets or gets the current type of FileChooser.
+
+
Sets or gets the current value of the selected file. + +
Returns 1 if the FileChooser window is visible.
+
+
+FileIcon ++ +
+#include "FileIcon.h" ++ +
The FileIcon class manages icon images that can be
+used as labels in other widgets and as icons in the FileBrowser
+widget.
+
+
The constructor creates a new FileIcon with the specified
+information.
+
+
The destructor destroys the icon and frees all memory that has been +allocated for it. + +
Adds a keyword value to the icon array, returning a pointer to it. + +
Adds a color value to the icon array, returning a pointer to it. + +
Adds a vertex value to the icon array, returning a pointer to it. +The integer version accepts coordinates from 0 to 10000, while the +floating point version goes from 0.0 to 1.0. The origin (0.0) is in +the lower-lefthand corner of the icon. + +
Clears all icon data from the icon. + +
Draws the icon in the indicated area. + +
Finds an icon that matches the given filename and file type. + +
Returns a pointer to the first icon in the list. + +
Applies the icon to the widget, registering the FileIcon
+label type as needed.
+
+
The labeltype function for icons. + +
Loads the specified icon image. The format is deduced from the filename. + +
Loads an SGI icon file. + +
Loads all system-defined icons. This call is useful when using the
+FileChooser widget and should be used when the application
+starts:
+
+
+FileIcon::load_system_icons(); ++ +
Loads an XPM icon file. + +
Returns the filename matching pattern for the icon. + +
Returns the number of words of data used by the icon. + +
Returns the filetype associated with the icon, which can be one of the +following: + +
FileIcon::ANY, any kind of file.
+ FileIcon::PLAIN, plain files.
+ FileIcon::FIFO, named pipes.
+ FileIcon::DEVICE, character and block devices.
+ FileIcon::LINK, symbolic links.
+ FileIcon::DIRECTORY, directories.
+Returns the data array for the icon. + + + diff --git a/documentation/Fl_HelpDialog.gif b/documentation/Fl_HelpDialog.gif new file mode 100644 index 000000000..e0f3cbfa8 Binary files /dev/null and b/documentation/Fl_HelpDialog.gif differ diff --git a/documentation/Fl_HelpDialog.html b/documentation/Fl_HelpDialog.html new file mode 100644 index 000000000..5fd28c7e6 --- /dev/null +++ b/documentation/Fl_HelpDialog.html @@ -0,0 +1,89 @@ + +
++Fl_Group + | + +----HelpDialog ++ +
+#include "HelpDialog.h" ++ +
The HelpDialog widget displays a standard help dialog window
+using the HelpView widget.
+
+

The constructor creates the dialog pictured above. + +
The destructor destroys the widget and frees all memory that has been +allocated for the current file. + +
Hides the HelpDialog window.
+
+
Loads the specified HTML file into the HelpView widget.
+The filename can also contain a target name ("filename.html#target").
+
+
Shows the HelpDialog window.
+
+
Sets the top line in the HelpView widget to the named or
+numbered line.
+
+
Returns 1 if the HelpDialog window is visible.
+
+
+
diff --git a/documentation/Fl_HelpView.html b/documentation/Fl_HelpView.html
new file mode 100644
index 000000000..e9e5b8a85
--- /dev/null
+++ b/documentation/Fl_HelpView.html
@@ -0,0 +1,130 @@
+
+
+Fl_Group + | + +----HelpView ++ +
+#include "HelpView.h" ++ +
The HelpView widget displays HTML text. Most HTML 2.0
+elements are supported, as well as a primitive implementation of tables.
+GIF, JPEG, and PNG images are displayed inline.
+
+
The constructor creates the HelpView widget at the specified
+position and size.
+
+
The destructor destroys the widget and frees all memory that has been +allocated for the current file. + +
This method returns the current directory (base) path for the file +in the buffer. + +
This method returns the current filename for the text in the buffer. + +
This method assigns a callback function to use when a link is
+followed or a file is loaded (via HelpView::load()) that
+requires a different file or path. The callback function receives the
+full pathname for the file in question and must return a pathname that
+can be opened as a local file. This is used by the
+HelpApp widget to support WWW
+addresses.
+
+
This method loads the specified file or URL. + +
This method returns the length of the buffer text in pixels. + +
The first form sets the default text color. The second returns +the current default text color. + +
The first form sets the default text font. The second returns +the current default text font. + +
The first form sets the default text size. The second returns +the current default text size. + +
This method returns the current document title, or NULL if there +is no title. + +
The first two forms scroll the text to the indicated position, either +with a named destination or by pixel line. + +
The second form returns the current top line in pixels. + +
The first form sets the current buffer to the string provided and +reformats the text. The second form returns the current buffer contents. + + + diff --git a/documentation/Fl_Wizard.html b/documentation/Fl_Wizard.html new file mode 100644 index 000000000..45b7a42dd --- /dev/null +++ b/documentation/Fl_Wizard.html @@ -0,0 +1,75 @@ + +
++Fl_Group + | + +----Fl_Wizard ++ +
+#include "Fl_Wizard.h" ++ +
The Fl_Wizard widget is based off the Fl_Tabs
+widget, but instead of displaying tabs it only changes "tabs" under
+program control. Its primary purpose is to support "wizards" that
+step a user through configuration or troubleshooting tasks.
+
+
As with Fl_Tabs, wizard panes are composed of child (usually
+Fl_Group) widgets. Navigation buttons must be added separately.
+
+
The constructor creates the Fl_Wizard widget at the specified
+position and size.
+
+
The destructor destroys the widget and its children. + +
This method shows the next child of the wizard. If the last child +is already visible, this function does nothing. + +
This method shows the previous child of the wizard. If the first child +is already visible, this function does nothing. + +
Sets or gets the child widget that is visible. + + + diff --git a/documentation/fltk.book b/documentation/fltk.book index e213778c2..394663b64 100644 --- a/documentation/fltk.book +++ b/documentation/fltk.book @@ -25,10 +25,15 @@ Fl_Counter.html Fl_Dial.html Fl_Double_Window.html Fl_End.html +Fl_FileBrowser.html +Fl_FileChooser.html +Fl_FileIcon.html Fl_Float_Input.html Fl_Free.html Fl_Gl_Window.html Fl_Group.html +Fl_HelpDialog.html +Fl_HelpView.html Fl_Hold_Browser.html Fl_Input.html Fl_Input_.html @@ -65,6 +70,7 @@ Fl_Value_Output.html Fl_Value_Slider.html Fl_Widget.html Fl_Window.html +Fl_Wizard.html functions.html enumerations.html glut.html diff --git a/documentation/widgets.html b/documentation/widgets.html index bc8f76164..076e579a0 100644 --- a/documentation/widgets.html +++ b/documentation/widgets.html @@ -2,7 +2,7 @@