Fl_Wizard Class Reference
This widget is based off the Fl_Tabs widget, but instead of displaying tabs it only changes "tabs" under program control. More...
#include <Fl_Wizard.H>
Inheritance diagram for Fl_Wizard:
Public Member Functions | |
| Fl_Wizard (int, int, int, int, const char *=0) | |
| The constructor creates the Fl_Wizard widget at the specified position and size. More... | |
| void | next () |
| This method shows the next child of the wizard. More... | |
| void | prev () |
| Shows the previous child. More... | |
| Fl_Widget * | value () |
| Gets the current visible child widget. More... | |
| void | value (Fl_Widget *) |
| Sets the child widget that is visible. More... | |
 Public Member Functions inherited from Fl_Group | |
| Fl_Widget *& | _ddfdesign_kludge () |
| This is for forms compatibility only. | |
| void | add (Fl_Widget &) |
| The widget is removed from its current group (if any) and then added to the end of this group. | |
| void | add (Fl_Widget *o) |
| See void Fl_Group::add(Fl_Widget &w) | |
| void | add_resizable (Fl_Widget &o) |
| Adds a widget to the group and makes it the resizable widget. | |
| Fl_Widget *const * | array () const |
| Returns a pointer to the array of children. More... | |
| virtual Fl_Group * | as_group () |
| Returns an Fl_Group pointer if this widget is an Fl_Group. More... | |
| void | begin () |
| Sets the current group so you can build the widget tree by just constructing the widgets. More... | |
| Fl_Widget * | child (int n) const |
| Returns array()[n]. More... | |
| int | children () const |
| Returns how many child widgets the group has. | |
| void | clear () |
| Deletes all child widgets from memory recursively. More... | |
| void | clip_children (int c) |
| Controls whether the group widget clips the drawing of child widgets to its bounding box. More... | |
| unsigned int | clip_children () |
| Returns the current clipping mode. More... | |
| void | end () |
| Exactly the same as current(this->parent()). More... | |
| int | find (const Fl_Widget *) const |
| Searches the child array for the widget and returns the index. More... | |
| int | find (const Fl_Widget &o) const |
| See int Fl_Group::find(const Fl_Widget *w) const. | |
| Fl_Group (int, int, int, int, const char *=0) | |
| Creates a new Fl_Group widget using the given position, size, and label string. More... | |
| void | focus (Fl_Widget *W) |
| void | forms_end () |
| This is for forms compatibility only. | |
| int | handle (int) |
| Handles the specified event. More... | |
| void | init_sizes () |
| Resets the internal array of widget sizes and positions. More... | |
| void | insert (Fl_Widget &, int i) |
| The widget is removed from its current group (if any) and then inserted into this group. More... | |
| void | insert (Fl_Widget &o, Fl_Widget *before) |
| This does insert(w, find(before)). More... | |
| void | remove (int index) |
Removes the widget at index from the group but does not delete it. More... | |
| void | remove (Fl_Widget &) |
| Removes a widget from the group but does not delete it. More... | |
| void | remove (Fl_Widget *o) |
Removes the widget o from the group. More... | |
| void | resizable (Fl_Widget &o) |
| See void Fl_Group::resizable(Fl_Widget *box) | |
| void | resizable (Fl_Widget *o) |
| The resizable widget defines the resizing box for the group. More... | |
| Fl_Widget * | resizable () const |
| See void Fl_Group::resizable(Fl_Widget *box) | |
| void | resize (int, int, int, int) |
| Resizes the Fl_Group widget and all of its children. More... | |
| virtual | ~Fl_Group () |
| The destructor also deletes all the children. More... | |
| Public Member Functions inherited from Fl_Widget | |
| void | _clear_fullscreen () |
| void | _set_fullscreen () |
| void | activate () |
| Activates the widget. More... | |
| unsigned int | active () const |
| Returns whether the widget is active. More... | |
| int | active_r () const |
| Returns whether the widget and all of its parents are active. More... | |
| Fl_Align | align () const |
| Gets the label alignment. More... | |
| void | align (Fl_Align alignment) |
| Sets the label alignment. More... | |
| long | argument () const |
| Gets the current user data (long) argument that is passed to the callback function. | |
| void | argument (long v) |
| Sets the current user data (long) argument that is passed to the callback function. More... | |
| virtual class Fl_Gl_Window * | as_gl_window () |
| Returns an Fl_Gl_Window pointer if this widget is an Fl_Gl_Window. More... | |
| virtual Fl_Window * | as_window () |
| Returns an Fl_Window pointer if this widget is an Fl_Window. More... | |
| Fl_Boxtype | box () const |
| Gets the box type of the widget. More... | |
| void | box (Fl_Boxtype new_box) |
| Sets the box type for the widget. More... | |
| Fl_Callback_p | callback () const |
| Gets the current callback function for the widget. More... | |
| void | callback (Fl_Callback *cb, void *p) |
| Sets the current callback function for the widget. More... | |
| void | callback (Fl_Callback *cb) |
| Sets the current callback function for the widget. More... | |
| void | callback (Fl_Callback0 *cb) |
| Sets the current callback function for the widget. More... | |
| void | callback (Fl_Callback1 *cb, long p=0) |
| Sets the current callback function for the widget. More... | |
| unsigned int | changed () const |
| Checks if the widget value changed since the last callback. More... | |
| void | clear_active () |
| Marks the widget as inactive without sending events or changing focus. More... | |
| void | clear_changed () |
| Marks the value of the widget as unchanged. More... | |
| void | clear_damage (uchar c=0) |
| Clears or sets the damage flags. More... | |
| void | clear_output () |
| Sets a widget to accept input. More... | |
| void | clear_visible () |
| Hides the widget. More... | |
| void | clear_visible_focus () |
| Disables keyboard focus navigation with this widget. More... | |
| Fl_Color | color () const |
| Gets the background color of the widget. More... | |
| void | color (Fl_Color bg) |
| Sets the background color of the widget. More... | |
| void | color (Fl_Color bg, Fl_Color sel) |
| Sets the background and selection color of the widget. More... | |
| Fl_Color | color2 () const |
| For back compatibility only. More... | |
| void | color2 (unsigned a) |
| For back compatibility only. More... | |
| int | contains (const Fl_Widget *w) const |
| Checks if w is a child of this widget. More... | |
| void | copy_label (const char *new_label) |
| Sets the current label. More... | |
| void | copy_tooltip (const char *text) |
| Sets the current tooltip text. More... | |
| uchar | damage () const |
| Returns non-zero if draw() needs to be called. More... | |
| void | damage (uchar c) |
| Sets the damage bits for the widget. More... | |
| void | damage (uchar c, int x, int y, int w, int h) |
| Sets the damage bits for an area inside the widget. More... | |
| int | damage_resize (int, int, int, int) |
| Internal use only. More... | |
| void | deactivate () |
| Deactivates the widget. More... | |
| Fl_Image * | deimage () |
| Gets the image that is used as part of the widget label. More... | |
| const Fl_Image * | deimage () const |
| void | deimage (Fl_Image *img) |
| Sets the image to use as part of the widget label. More... | |
| void | deimage (Fl_Image &img) |
| Sets the image to use as part of the widget label. More... | |
| void | do_callback () |
| Calls the widget callback. More... | |
| void | do_callback (Fl_Widget *o, long arg) |
| Calls the widget callback. More... | |
| void | do_callback (Fl_Widget *o, void *arg=0) |
| Calls the widget callback. More... | |
| void | draw_label (int, int, int, int, Fl_Align) const |
| Draws the label in an arbitrary bounding box with an arbitrary alignment. More... | |
| int | h () const |
| Gets the widget height. More... | |
| virtual void | hide () |
| Makes a widget invisible. More... | |
| Fl_Image * | image () |
| Gets the image that is used as part of the widget label. More... | |
| const Fl_Image * | image () const |
| void | image (Fl_Image *img) |
| Sets the image to use as part of the widget label. More... | |
| void | image (Fl_Image &img) |
| Sets the image to use as part of the widget label. More... | |
| int | inside (const Fl_Widget *wgt) const |
Checks if this widget is a child of wgt. More... | |
| const char * | label () const |
| Gets the current label text. More... | |
| void | label (const char *text) |
| Sets the current label pointer. More... | |
| void | label (Fl_Labeltype a, const char *b) |
| Shortcut to set the label text and type in one call. More... | |
| Fl_Color | labelcolor () const |
| Gets the label color. More... | |
| void | labelcolor (Fl_Color c) |
| Sets the label color. More... | |
| Fl_Font | labelfont () const |
| Gets the font to use. More... | |
| void | labelfont (Fl_Font f) |
| Sets the font to use. More... | |
| Fl_Fontsize | labelsize () const |
| Gets the font size in pixels. More... | |
| void | labelsize (Fl_Fontsize pix) |
| Sets the font size in pixels. More... | |
| Fl_Labeltype | labeltype () const |
| Gets the label type. More... | |
| void | labeltype (Fl_Labeltype a) |
| Sets the label type. More... | |
| void | measure_label (int &ww, int &hh) const |
| Sets width ww and height hh accordingly with the label size. More... | |
| unsigned int | output () const |
| Returns if a widget is used for output only. More... | |
| Fl_Group * | parent () const |
| Returns a pointer to the parent widget. More... | |
| void | parent (Fl_Group *p) |
| Internal use only - "for hacks only". More... | |
| void | position (int X, int Y) |
| Repositions the window or widget. More... | |
| void | redraw () |
| Schedules the drawing of the widget. More... | |
| void | redraw_label () |
| Schedules the drawing of the label. More... | |
| Fl_Color | selection_color () const |
| Gets the selection color. More... | |
| void | selection_color (Fl_Color a) |
| Sets the selection color. More... | |
| void | set_active () |
| Marks the widget as active without sending events or changing focus. More... | |
| void | set_changed () |
| Marks the value of the widget as changed. More... | |
| void | set_output () |
| Sets a widget to output only. More... | |
| void | set_visible () |
| Makes the widget visible. More... | |
| void | set_visible_focus () |
| Enables keyboard focus navigation with this widget. More... | |
| virtual void | show () |
| Makes a widget visible. More... | |
| void | size (int W, int H) |
| Changes the size of the widget. More... | |
| int | take_focus () |
| Gives the widget the keyboard focus. More... | |
| unsigned int | takesevents () const |
| Returns if the widget is able to take events. More... | |
| int | test_shortcut () |
| Returns true if the widget's label contains the entered '&x' shortcut. More... | |
| const char * | tooltip () const |
| Gets the current tooltip text. More... | |
| void | tooltip (const char *text) |
| Sets the current tooltip text. More... | |
| Fl_Window * | top_window () const |
| Returns a pointer to the top-level window for the widget. More... | |
| Fl_Window * | top_window_offset (int &xoff, int &yoff) const |
| Finds the x/y offset of the current widget relative to the top-level window. More... | |
| uchar | type () const |
| Gets the widget type. More... | |
| void | type (uchar t) |
| Sets the widget type. More... | |
| int | use_accents_menu () |
| Returns non zero if MAC_USE_ACCENTS_MENU flag is set, 0 otherwise. | |
| void * | user_data () const |
| Gets the user data for this widget. More... | |
| void | user_data (void *v) |
| Sets the user data for this widget. More... | |
| unsigned int | visible () const |
| Returns whether a widget is visible. More... | |
| void | visible_focus (int v) |
| Modifies keyboard focus navigation. More... | |
| unsigned int | visible_focus () |
| Checks whether this widget has a visible focus. More... | |
| int | visible_r () const |
| Returns whether a widget and all its parents are visible. More... | |
| int | w () const |
| Gets the widget width. More... | |
| Fl_When | when () const |
| Returns the conditions under which the callback is called. More... | |
| void | when (uchar i) |
| Sets the flags used to decide when a callback is called. More... | |
| Fl_Window * | window () const |
| Returns a pointer to the nearest parent window up the widget hierarchy. More... | |
| int | x () const |
| Gets the widget position in its window. More... | |
| int | y () const |
| Gets the widget position in its window. More... | |
| virtual | ~Fl_Widget () |
| Destroys the widget. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Fl_Group | |
| static Fl_Group * | current () |
| Returns the currently active group. More... | |
| static void | current (Fl_Group *g) |
| Sets the current group. More... | |
| Static Public Member Functions inherited from Fl_Widget | |
| static void | default_callback (Fl_Widget *cb, void *d) |
| Sets the default callback for all widgets. More... | |
| static unsigned int | label_shortcut (const char *t) |
| Returns the Unicode value of the '&x' shortcut in a given text. More... | |
| static int | test_shortcut (const char *, const bool require_alt=false) |
Returns true if the given text t contains the entered '&x' shortcut. More... | |
| Protected Types inherited from Fl_Widget | |
| enum | { INACTIVE = 1<<0, INVISIBLE = 1<<1, OUTPUT = 1<<2, NOBORDER = 1<<3, FORCE_POSITION = 1<<4, NON_MODAL = 1<<5, SHORTCUT_LABEL = 1<<6, CHANGED = 1<<7, OVERRIDE = 1<<8, VISIBLE_FOCUS = 1<<9, COPIED_LABEL = 1<<10, CLIP_CHILDREN = 1<<11, MENU_WINDOW = 1<<12, TOOLTIP_WINDOW = 1<<13, MODAL = 1<<14, NO_OVERLAY = 1<<15, GROUP_RELATIVE = 1<<16, COPIED_TOOLTIP = 1<<17, FULLSCREEN = 1<<18, MAC_USE_ACCENTS_MENU = 1<<19, USERFLAG3 = 1<<29, USERFLAG2 = 1<<30, USERFLAG1 = 1<<31 } |
| flags possible values enumeration. More... | |
| Protected Member Functions inherited from Fl_Group | |
| void | draw_child (Fl_Widget &widget) const |
| Forces a child to redraw. More... | |
| void | draw_children () |
| Draws all children of the group. More... | |
| void | draw_outside_label (const Fl_Widget &widget) const |
| Parents normally call this to draw outside labels of child widgets. More... | |
| int * | sizes () |
| Returns the internal array of widget sizes and positions. More... | |
| void | update_child (Fl_Widget &widget) const |
| Draws a child only if it needs it. More... | |
| Protected Member Functions inherited from Fl_Widget | |
| void | clear_flag (unsigned int c) |
| Clears a flag in the flags mask. | |
| void | draw_backdrop () const |
| If FL_ALIGN_IMAGE_BACKDROP is set, the image or deimage will be drawn. | |
| void | draw_box () const |
| Draws the widget box according its box style. | |
| void | draw_box (Fl_Boxtype t, Fl_Color c) const |
| Draws a box of type t, of color c at the widget's position and size. More... | |
| void | draw_box (Fl_Boxtype t, int x, int y, int w, int h, Fl_Color c) const |
| Draws a box of type t, of color c at the position X,Y and size W,H. More... | |
| void | draw_focus () |
| draws a focus rectangle around the widget | |
| void | draw_focus (Fl_Boxtype t, int x, int y, int w, int h) const |
| Draws a focus box for the widget at the given position and size. | |
| void | draw_label () const |
| Draws the widget's label at the defined label position. More... | |
| void | draw_label (int, int, int, int) const |
| Draws the label in an arbitrary bounding box. More... | |
| Fl_Widget (int x, int y, int w, int h, const char *label=0L) | |
| Creates a widget at the given position and size. More... | |
| unsigned int | flags () const |
| Gets the widget flags mask. | |
| void | h (int v) |
| Internal use only. More... | |
| void | set_flag (unsigned int c) |
| Sets a flag in the flags mask. | |
| void | w (int v) |
| Internal use only. More... | |
| void | x (int v) |
| Internal use only. More... | |
| void | y (int v) |
| Internal use only. More... | |
Detailed Description
This 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.
Constructor & Destructor Documentation
| Fl_Wizard::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.
The inherited destructor destroys the widget and its children.
Member Function Documentation
| void Fl_Wizard::next | ( | ) |
This method shows the next child of the wizard.
If the last child is already visible, this function does nothing.
| void Fl_Wizard::prev | ( | ) |
Shows the previous child.
| Fl_Widget * Fl_Wizard::value | ( | ) |
Gets the current visible child widget.
| void Fl_Wizard::value | ( | Fl_Widget * | kid | ) |
Sets the child widget that is visible.
The documentation for this class was generated from the following files:
- Fl_Wizard.H
- Fl_Wizard.cxx
