From b0e56bb248b4690fc34505f58b8b795521628ff2 Mon Sep 17 00:00:00 2001 From: Michael R Sweet Date: Thu, 2 Aug 2001 18:31:29 +0000 Subject: Documentation... git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@1529 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/Fl_FileBrowser.html | 79 +++++++++++++ documentation/Fl_FileChooser.gif | Bin 0 -> 10760 bytes documentation/Fl_FileChooser.html | 172 ++++++++++++++++++++++++++++ documentation/Fl_FileIcon.html | 165 +++++++++++++++++++++++++++ documentation/Fl_HelpDialog.gif | Bin 0 -> 12984 bytes documentation/Fl_HelpDialog.html | 89 +++++++++++++++ documentation/Fl_HelpView.html | 130 +++++++++++++++++++++ documentation/Fl_Wizard.html | 75 ++++++++++++ documentation/fltk.book | 6 + documentation/widgets.html | 234 ++++++++++++++++++++------------------ 10 files changed, 837 insertions(+), 113 deletions(-) create mode 100644 documentation/Fl_FileBrowser.html create mode 100644 documentation/Fl_FileChooser.gif create mode 100644 documentation/Fl_FileChooser.html create mode 100644 documentation/Fl_FileIcon.html create mode 100644 documentation/Fl_HelpDialog.gif create mode 100644 documentation/Fl_HelpDialog.html create mode 100644 documentation/Fl_HelpView.html create mode 100644 documentation/Fl_Wizard.html 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 @@ + + + FileBrowser - ESP Widget Set for FLTK + + + Widget Set Home Page + Widget Set Documentation + Download Widget Set + ESP Home Page + FLTK Home Page + + + + + + +

class FileBrowser

+ +
+ +

Class Hierarchy

+ + + +

Include Files

+ + + +

Description

+ +

The FileBrowser widget displays a list of filenames, +optionally with file-specific icons. + +

Methods

+ + + +

FileBrowser(int xx, int yy, int ww, int hh, const char *l = 0)

+ +

The constructor creates the FileBrowser widget at the specified +position and size. + +

~FileBrowser()

+ +

The destructor destroys the widget and frees all memory that has been +allocated. + +

void iconsize(uchar s)
+uchar iconsize() const

+ +

Sets or gets the size of the icons. The default size is 20 pixels. + +

void filter(const char *pattern)
+const char *filter() const

+ +

Sets or gets the filename filter. The pattern matching uses the +filename_match() function in FLTK. + +

int load(const char *directory)

+ +

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 @@ + + + FileChooser - ESP Widget Set for FLTK + + + Widget Set Home Page + Widget Set Documentation + Download Widget Set + ESP Home Page + FLTK Home Page + + + + + + +

class FileChooser

+ +
+ +

Class Hierarchy

+ + + +

Include Files

+ + + +

Description

+ +

The FileChooser widget displays a standard file selection +dialog that supports various selection modes. + +

FileChooser widget
+ +

Methods

+ + + +

FileChooser(const char *pathname, const char *pattern, +int type, const char *title)

+ +

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: + +

+ +

The title argument is used to set the title bar text for the +FileChooser window. + +

~FileChooser()

+ +

Destroys the widget and frees all memory used by it. + +

void color(Fl_Color c)
+Fl_Color color()

+ +

Sets or gets the background color of the FileBrowser list. + +

int count()

+ +

Returns the number of selected files. + +

void directory(const char *pathname)
+const char *directory()

+ +

Sets or gets the current directory. + +

void filter(const char *pattern)
+const char *filter()

+ +

Sets or gets the current filename filter pattern. + +

void hide()

+ +

Hides the FileChooser window. + +

void iconsize(uchar s)
+uchar iconsize()

+ +

Sets or gets the size of the icons in the FileBrowser. By +default the icon size is set to 1.5 times the textsize(). + +

void label(const char *l)
+const char *label()

+ +

Sets or gets the title bar text for the FileChooser. + +

void rescan()

+ +

Reloads the current directory in the FileBrowser. + +

void show()

+ +

Shows the FileChooser window. + +

void textcolor(Fl_Color c)
+Fl_Color textcolor()

+ +

Sets or gets the current FileBrowser text color. + +

void textfont(uchar f)
+uchar textfont()

+ +

Sets or gets the current FileBrowser text font. + +

void textsize(uchar s)
+uchar textsize()

+ +

Sets or gets the current FileBrowser text size. + +

void type(int t)
+int type()

+ +

Sets or gets the current type of FileChooser. + +

const char *value(const char *pathname)
+const char *value(int file)
+const char *value()

+ +

Sets or gets the current value of the selected file. + +

int visible()

+ +

Returns 1 if the FileChooser window is visible. + +

+ + + + diff --git a/documentation/Fl_FileIcon.html b/documentation/Fl_FileIcon.html new file mode 100644 index 000000000..bd60fb93a --- /dev/null +++ b/documentation/Fl_FileIcon.html @@ -0,0 +1,165 @@ + + + FileIcon - ESP Widget Set for FLTK + + + Widget Set Home Page + Widget Set Documentation + Download Widget Set + ESP Home Page + FLTK Home Page + + + + + + +

class FileIcon

+ +
+ +

Class Hierarchy

+ + + +

Include Files

+ + + +

Description

+ +

The FileIcon class manages icon images that can be +used as labels in other widgets and as icons in the FileBrowser +widget. + +

Methods

+ + + +

FileIcon()

+ +

The constructor creates a new FileIcon with the specified +information. + +

~FileIcon()

+ +

The destructor destroys the icon and frees all memory that has been +allocated for it. + +

short *add(short d)

+ +

Adds a keyword value to the icon array, returning a pointer to it. + +

short *add_color(short c)

+ +

Adds a color value to the icon array, returning a pointer to it. + +

short *add_vertex(int x, int y)
+short *add_vertex(float x, float y)

+ +

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. + +

void clear()

+ +

Clears all icon data from the icon. + +

void draw(int x, int y, int w, int h, Fl_Color ic, int active = 1)

+ +

Draws the icon in the indicated area. + +

static FileIcon *find(const char *filename, int filetype = ANY);

+ +

Finds an icon that matches the given filename and file type. + +

static FileIcon *first()

+ +

Returns a pointer to the first icon in the list. + +

void label(Fl_Widget *w)

+ +

Applies the icon to the widget, registering the FileIcon +label type as needed. + +

static void labeltype(const Fl_Label *o, int x, int y, int w, int h, Fl_Align a)

+ +

The labeltype function for icons. + +

void load(const char *f)

+ +

Loads the specified icon image. The format is deduced from the filename. + +

void load_fti(const char *fti)

+ +

Loads an SGI icon file. + +

static void load_system_icons(void)

+ +

Loads all system-defined icons. This call is useful when using the +FileChooser widget and should be used when the application +starts: + +

+ +

void load_xpm(const char *xpm)

+ +

Loads an XPM icon file. + +

const char *pattern()

+ +

Returns the filename matching pattern for the icon. + +

int size()

+ +

Returns the number of words of data used by the icon. + +

int type()

+ +

Returns the filetype associated with the icon, which can be one of the +following: + +

+ +

short *value()

+ +

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 @@ + + + HelpDialog - ESP Widget Set for FLTK + + + Widget Set Home Page + Widget Set Documentation + Download Widget Set + ESP Home Page + FLTK Home Page + + + + + + +

class HelpDialog

+ +
+ +

Class Hierarchy

+ + + +

Include Files

+ + + +

Description

+ +

The HelpDialog widget displays a standard help dialog window +using the HelpView widget. + +

HelpDialog Window
+ +

Methods

+ + + +

HelpDialog()

+ +

The constructor creates the dialog pictured above. + +

~HelpView()

+ +

The destructor destroys the widget and frees all memory that has been +allocated for the current file. + +

void hide()

+ +

Hides the HelpDialog window. + +

void load(const char *f)

+ +

Loads the specified HTML file into the HelpView widget. +The filename can also contain a target name ("filename.html#target"). + +

void show()

+ +

Shows the HelpDialog window. + +

void topline(const char *n)
+void topline(int n)

+ +

Sets the top line in the HelpView widget to the named or +numbered line. + +

int visible()

+ +

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 @@ + + + HelpView - ESP Widget Set for FLTK + + + + + + +

class HelpView

+ +
+ +

Class Hierarchy

+ + + +

Include Files

+ + + +

Description

+ +

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. + +

Methods

+ + + +

HelpView(int xx, int yy, int ww, int hh, const char *l = 0)

+ +

The constructor creates the HelpView widget at the specified +position and size. + +

~HelpView()

+ +

The destructor destroys the widget and frees all memory that has been +allocated for the current file. + +

const char *directory() const

+ +

This method returns the current directory (base) path for the file +in the buffer. + +

const char *filename() const

+ +

This method returns the current filename for the text in the buffer. + +

void link(HelpFunc *fn)

+ +

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. + +

int load(const char *f)

+ +

This method loads the specified file or URL. + +

int size() const

+ +

This method returns the length of the buffer text in pixels. + +

void textcolor(Fl_Color c)
+Fl_Color textcolor() const

+ +

The first form sets the default text color. The second returns +the current default text color. + +

void textfont(uchar f)
+uchar textfont() const

+ +

The first form sets the default text font. The second returns +the current default text font. + +

void textsize(uchar s)
+uchar textsize() const

+ +

The first form sets the default text size. The second returns +the current default text size. + +

const char *title()

+ +

This method returns the current document title, or NULL if there +is no title. + +

void topline(const char *n)
+void topline(int)
+int topline() const

+ +

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. + +

void value(const char *v)
+const char *value() const

+ +

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_Wizard - ESP Widget Set for FLTK + + + + + + +

class Fl_Wizard

+ +
+ +

Class Hierarchy

+ + + +

Include Files

+ + + +

Description

+ +

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. + +

Methods

+ + + +

Fl_Wizard(int xx, int yy, int ww, int hh, const char *l = 0)

+ +

The constructor creates the Fl_Wizard widget at the specified +position and size. + +

~Fl_Wizard()

+ +

The destructor destroys the widget and its children. + +

void next()

+ +

This method shows the next child of the wizard. If the last child +is already visible, this function does nothing. + +

void prev()

+ +

This method shows the previous child of the wizard. If the first child +is already visible, this function does nothing. + +

void value(Fl_Widget *w)
+Fl_Widget *value()

+ +

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 @@

A - Widget Reference

This appendix describes all of the widget classes in FLTK. For a -description of the fl_ functions and Fl:: methods, +description of the fl_ functions and Fl:: methods, see Appendix B.

Alphabetical List of Classes

@@ -10,64 +10,66 @@ see Appendix B.
- -
-Fl_Adjuster
-Fl_Box
-Fl_Browser
-Fl_Browser_
-Fl_Button
-Fl_Chart
-Fl_Check_Button
-Fl_Choice
-Fl_Clock
-Fl_Color_Chooser
-Fl_Counter
-Fl_Dial
-Fl_Double_Window
-Fl_End
-Fl_Float_Input
-Fl_Free
-Fl_Gl_Window
-Fl_Group
-		 -Fl_Hold_Browser
-Fl_Input
-Fl_Input_
-Fl_Int_Input
-Fl_Light_Button
-Fl_Menu_
-Fl_Menu_Bar
-Fl_Menu_Button
-Fl_Menu_Item
-Fl_Menu_Window
-Fl_Multi_Browser
-Fl_Multiline_Input
-Fl_Multiline_Output
-Fl_Output
-Fl_Overlay_Window
-Fl_Pack
-Fl_Positioner
-Fl_Repeat_Button
-		 -Fl_Return_Button
-Fl_Roller
-Fl_Round_Button
-Fl_Scroll
-Fl_Scrollbar
-Fl_Secret_Input
-Fl_Select_Browser
-Fl_Single_Window
-Fl_Slider
-Fl_Tabs
-Fl_Tile
-Fl_Timer
-Fl_Valuator
-Fl_Value_Input
-Fl_Value_Output
-Fl_Value_Slider
-Fl_Widget
-Fl_Window
+Fl_Adjuster
+Fl_Box
+Fl_Browser
+Fl_Browser_
+Fl_Button
+Fl_Chart
+Fl_Check_Button
+Fl_Choice
+Fl_Clock
+Fl_Color_Chooser
+Fl_Counter
+Fl_Dial
+Fl_Double_Window
+Fl_End
+Fl_FileBrowser
+Fl_FileChooser
+Fl_FileIcon
+Fl_Float_Input
+Fl_Free
+Fl_Gl_Window
+Fl_Group
+Fl_HelpDialog
+Fl_HelpView
+Fl_Hold_Browser
+Fl_Input
+Fl_Input_
+Fl_Int_Input
+Fl_Light_Button
+Fl_Menu_
+Fl_Menu_Bar
+Fl_Menu_Button
+Fl_Menu_Item
+Fl_Menu_Window
+Fl_Multi_Browser
+Fl_Multiline_Input
+Fl_Multiline_Output
+Fl_Output
+Fl_Overlay_Window
+Fl_Pack
+Fl_Positioner
+Fl_Repeat_Button
+Fl_Return_Button
+Fl_Roller
+Fl_Round_Button
+Fl_Scroll
+Fl_Scrollbar
+Fl_Secret_Input
+Fl_Select_Browser
+Fl_Single_Window
+Fl_Slider
+Fl_Tabs
+Fl_Tile
+Fl_Timer
+Fl_Valuator
+Fl_Value_Input
+Fl_Value_Output
+Fl_Value_Slider
+Fl_Widget
+Fl_Window
+Fl_Wizard
@@ -75,82 +77,88 @@ see Appendix B.

Class Hierarchy

-- cgit v1.2.3