diff options
| author | engelsman <engelsman> | 2008-10-10 17:10:28 +0000 |
|---|---|---|
| committer | engelsman <engelsman> | 2008-10-10 17:10:28 +0000 |
| commit | 7f105bfa47e0f8a24f019f87c76bae387fbe0c1b (patch) | |
| tree | 85e64241638dfcf03f23f31a15f7464e511357e3 /documentation/common.dox | |
| parent | 56fdfed5427d2b85655fc5e84f81fbb2c76a8b9b (diff) | |
converted more html to plain old doxygen in basics.dox and common.dox
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6404 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation/common.dox')
| -rw-r--r-- | documentation/common.dox | 498 |
1 files changed, 232 insertions, 266 deletions
diff --git a/documentation/common.dox b/documentation/common.dox index 62dbebe73..eeceae4cf 100644 --- a/documentation/common.dox +++ b/documentation/common.dox @@ -2,37 +2,33 @@ \page common 3 - Common Widgets and Attributes -<P>This chapter describes many of the widgets that are provided +This chapter describes many of the widgets that are provided with FLTK and covers how to query and set the standard -attributes.</P> +attributes. -<H2>Buttons</H2> +\section common_buttons Buttons -<P>FLTK provides many types of buttons:</P> +FLTK provides many types of buttons: -<UL> - <LI>Fl_Button - A standard push button.</LI> +\li Fl_Button - A standard push button. - <LI>Fl_Check_Button - A button with a check box.</LI> +\li Fl_Check_Button - A button with a check box. - <LI>Fl_Light_Button - A push button with a light.</LI> +\li Fl_Light_Button - A push button with a light. - <LI>Fl_Repeat_Button - A push button that repeats - when held.</LI> +\li Fl_Repeat_Button - A push button that repeats when held. - <LI>Fl_Return_Button - A push button that is activated - by the <KBD>Enter</KBD> key.</LI> +\li Fl_Return_Button - A push button that is activated by the + <KBD>Enter</KBD> key. - <LI>Fl_Round_Button - A button with a radio circle.</LI> - -</UL> +\li Fl_Round_Button - A button with a radio circle. \image html buttons.gif "Figure 3-1: FLTK Button Widgets" -<P>All of these buttons just need the corresponding -<TT><FL/Fl_xyz_Button.H></TT> header file. The constructor +All of these buttons just need the corresponding +<tt><FL/Fl_xyz_Button.H></tt> header file. The constructor takes the bounding box of the button and optionally a label -string:</P> +string: \code Fl_Button *button = new Fl_Button(x, y, width, height, "label"); @@ -40,8 +36,8 @@ Fl_Light_Button *lbutton = new Fl_Light_Button(x, y, width, height); Fl_Round_Button *rbutton = new Fl_Round_Button(x, y, width, height, "label"); \endcode -<P>Each button has an associated <TT>type()</TT> which allows -it to behave as a push button, toggle button, or radio button:</P> +Each button has an associated <tt>type()</tt> which allows +it to behave as a push button, toggle button, or radio button: \code button->type(FL_NORMAL_BUTTON); @@ -49,126 +45,115 @@ lbutton->type(FL_TOGGLE_BUTTON); rbutton->type(FL_RADIO_BUTTON); \endcode -<P>For toggle and radio buttons, the value() method returns +For toggle and radio buttons, the value() method returns the current button state (0 = off, 1 = on). The set() and clear() methods can be used on toggle buttons to turn a toggle button on or off, respectively. Radio buttons can be turned on with the setonly() method; this will also turn off other radio buttons in the same -group.</P> +group. -<H2>Text</H2> +\section common_text Text -<P>FLTK provides several text widgets for displaying and receiving text:</P> +FLTK provides several text widgets for displaying and receiving text: -<UL> - <LI>Fl_Input - A one-line text input field.</LI> +\li Fl_Input - A one-line text input field. - <LI>Fl_Output - A one-line text output field.</LI> +\li Fl_Output - A one-line text output field. - <LI>Fl_Multiline_Input - A multi-line text input field.</LI> +\li Fl_Multiline_Input - A multi-line text input field. - <LI>Fl_Multiline_Output - A multi-line text output field.</LI> +\li Fl_Multiline_Output - A multi-line text output field. - <LI>Fl_Text_Display - A multi-line text display widget.</LI> +\li Fl_Text_Display - A multi-line text display widget. - <LI>Fl_Text_Editor - A multi-line text editing widget.</LI> +\li Fl_Text_Editor - A multi-line text editing widget. - <LI>Fl_Help_View - A HTML text display widget.</LI> -</UL> +\li Fl_Help_View - A HTML text display widget. -<P>The <TT>Fl_Output</TT> and <TT>Fl_Multiline_Output</TT> +The <tt>Fl_Output</tt> and <tt>Fl_Multiline_Output</tt> widgets allow the user to copy text from the output field but -not change it.</P> +not change it. -<P>The <TT>value()</TT> method is used to get or set the -string that is displayed:</P> +The <tt>value()</tt> method is used to get or set the +string that is displayed: \code Fl_Input *input = new Fl_Input(x, y, width, height, "label"); input->value("Now is the time for all good men..."); \endcode -<P>The string is copied to the widget's own storage when you set -the <tt>value()</tt> of the widget.</P> +The string is copied to the widget's own storage when you set +the <tt>value()</tt> of the widget. -<P>The <TT>Fl_Text_Display</TT> and <TT>Fl_Text_Editor</TT> -widgets use an associated <TT>Fl_Text_Buffer</TT> class for the -value, instead of a simple string.</P> +The <tt>Fl_Text_Display</tt> and <tt>Fl_Text_Editor</tt> +widgets use an associated <tt>Fl_Text_Buffer</tt> class for the +value, instead of a simple string. <!-- NEED 4in --> -<H2>Valuators</H2> - -<P>Unlike text widgets, valuators keep track of numbers instead of -strings. FLTK provides the following valuators:</P> - -<UL> +\section common_valuators Valuators - <LI>Fl_Counter - A widget with arrow buttons that shows the - current value.</LI> +Unlike text widgets, valuators keep track of numbers instead of +strings. FLTK provides the following valuators: - <LI>Fl_Dial - A round knob.</LI> +\li Fl_Counter - A widget with arrow buttons that shows the current value. - <LI>Fl_Roller - An SGI-like dolly widget.</LI> +\li Fl_Dial - A round knob. - <LI>Fl_Scrollbar - A standard scrollbar widget.</LI> +\li Fl_Roller - An SGI-like dolly widget. - <LI>Fl_Slider - A scrollbar with a knob.</LI> +\li Fl_Scrollbar - A standard scrollbar widget. - <LI>Fl_Value_Slider - A slider that shows the current value.</LI> +\li Fl_Slider - A scrollbar with a knob. -</UL> +\li Fl_Value_Slider - A slider that shows the current value. \image html valuators.gif "Figure 3-2: FLTK valuator widgets" -<P>The <TT>value()</TT> method gets and sets the current value -of the widget. The <TT>minimum()</TT> and <TT>maximum()</TT> +The <tt>value()</tt> method gets and sets the current value +of the widget. The <tt>minimum()</tt> and <tt>maximum()</tt> methods set the range of values that are reported by the -widget.</P> +widget. <!-- NEED 5in --> -<H2>Groups</H2> +\section common_groups Groups -<P>The <TT>Fl_Group</TT> widget class is used as a general +The <tt>Fl_Group</tt> widget class is used as a general purpose "container" widget. Besides grouping radio buttons, the groups are used to encapsulate windows, tabs, and scrolled windows. The following group classes are available -with FLTK:</P> +with FLTK: -<UL> +\li Fl_Double_Window - A double-buffered window on the screen. - <LI>Fl_Double_Window - A double-buffered window on the screen.</LI> +\li Fl_Gl_Window - An OpenGL window on the screen. - <LI>Fl_Gl_Window - An OpenGL window on the screen.</LI> +\li Fl_Group - The base container class; can be used to group + any widgets together. - <LI>Fl_Group - The base container class; can be used to group - any widgets together.</LI> +\li Fl_Pack - A collection of widgets that are packed into the group area. - <LI>Fl_Pack - A collection of widgets that are packed into the group area.</LI> +\li Fl_Scroll - A scrolled window area. - <LI>Fl_Scroll - A scrolled window area.</LI> +\li Fl_Tabs - Displays child widgets as tabs. - <LI>Fl_Tabs - Displays child widgets as tabs.</LI> +\li Fl_Tile - A tiled window area. - <LI>Fl_Tile - A tiled window area.</LI> +\li Fl_Window - A window on the screen. - <LI>Fl_Window - A window on the screen.</LI> +\li Fl_Wizard - Displays one group of widgets at a time. - <LI>Fl_Wizard - Displays one group of widgets at a time.</LI> +\section common_sizeposition Setting the Size and Position of Widgets -</UL> - -<H2>Setting the Size and Position of Widgets</H2> - -<P>The size and position of widgets is usually set when you +The size and position of widgets is usually set when you create them. You can access them with the <tt>x()</tt>, -<tt>y()</tt>, <tt>w()</tt>, and <tt>h()</tt> methods.</P> +<tt>y()</tt>, <tt>w()</tt>, and <tt>h()</tt> methods. -<P>You can change the size and position by using the -<TT>position()</TT>, <TT> resize()</TT>, and <TT>size()</TT> -methods:</P> +You can change the size and position by using the +<tt>position()</tt>, <tt> resize()</tt>, and <tt>size()</tt> +methods: \code button->position(x, y); @@ -176,69 +161,65 @@ group->resize(x, y, width, height); window->size(width, height); \endcode -<P>If you change a widget's size or position after it is +If you change a widget's size or position after it is displayed you will have to call <tt>redraw()</tt> on the -widget's parent.</P> +widget's parent. -<H2><A NAME="colors">Colors</A></H2> +<A NAME="colors"></A> <!-- For old HTML links only ! --> +\section common_colors Colors -<P>FLTK stores the colors of widgets as an 32-bit unsigned +FLTK stores the colors of widgets as an 32-bit unsigned number that is either an index into a color palette of 256 colors or a 24-bit RGB color. The color palette is <i>not</i> the X or WIN32 colormap, but instead is an internal table with -fixed contents.</P> +fixed contents. -<P>There are symbols for naming some of the more common colors:</P> +There are symbols for naming some of the more common colors: -<UL> - <LI><TT>FL_BLACK</TT></LI> +\li <tt>FL_BLACK</tt> - <LI><TT>FL_RED</TT></LI> +\li <tt>FL_RED</tt> - <LI><TT>FL_GREEN</TT></LI> +\li <tt>FL_GREEN</tt> - <LI><TT>FL_YELLOW</TT></LI> +\li <tt>FL_YELLOW</tt> - <LI><TT>FL_BLUE</TT></LI> +\li <tt>FL_BLUE</tt> - <LI><TT>FL_MAGENTA</TT></LI> +\li <tt>FL_MAGENTA</tt> - <LI><TT>FL_CYAN</TT></LI> +\li <tt>FL_CYAN</tt> - <LI><TT>FL_WHITE</TT></LI> +\li <tt>FL_WHITE</tt> - <LI>FL_WHITE</LI> -</UL> +\li FL_WHITE -<P>These symbols are the default colors for all FLTK widgets. They are +These symbols are the default colors for all FLTK widgets. They are explained in more detail in the chapter -<A HREF="enumerations.html#colors">Enumerations</A></P> +<A HREF="enumerations.html#colors">Enumerations</A> -<UL> - <LI><TT>FL_FOREGROUND_COLOR</TT> </LI> +\li <tt>FL_FOREGROUND_COLOR</tt> - <LI><TT>FL_BACKGROUND_COLOR</TT> </LI> +\li <tt>FL_BACKGROUND_COLOR</tt> - <LI><TT>FL_INACTIVE_COLOR</TT> </LI> +\li <tt>FL_INACTIVE_COLOR</tt> - <LI><TT>FL_SELECTION_COLOR</TT> </LI> -</UL> +\li <tt>FL_SELECTION_COLOR</tt> -<P>RGB colors can be set using the <TT>fl_rgb_color()</TT> -function:</P> +RGB colors can be set using the <tt>fl_rgb_color()</tt> function: \code Fl_Color c = fl_rgb_color(85, 170, 255); \endcode -<P>The widget color is set using the <TT>color()</TT> method:</P> +The widget color is set using the <tt>color()</tt> method: \code button->color(FL_RED); \endcode -<P>Similarly, the label color is set using the <TT>labelcolor()</TT> -method:</P> +Similarly, the label color is set using the <tt>labelcolor()</tt> +method: \code button->labelcolor(FL_WHITE); @@ -247,35 +228,35 @@ button->labelcolor(FL_WHITE); <A NAME="boxtypes"></A> <!-- For old HTML links only ! --> \section common_boxtypes Box Types -<P>The type <TT>Fl_Boxtype</TT> stored and returned in Fl_Widget::box() +The type <tt>Fl_Boxtype</tt> stored and returned in Fl_Widget::box() is an enumeration defined in Enumerations.H. -Figure 3-3 shows the standard box types included with FLTK.</P> +Figure 3-3 shows the standard box types included with FLTK. \image html boxtypes.gif "Figure 3-3: FLTK box types" -<P><TT>FL_NO_BOX</TT> means nothing is drawn at all, so whatever is -already on the screen remains. The <TT>FL_..._FRAME</TT> types only +<tt>FL_NO_BOX</tt> means nothing is drawn at all, so whatever is +already on the screen remains. The <tt>FL_..._FRAME</tt> types only draw their edges, leaving the interior unchanged. The blue color in -Figure 3-3 is the area that is not drawn by the frame types.</P> +Figure 3-3 is the area that is not drawn by the frame types. -<H3>Making Your Own Boxtypes</H3> +\subsection common_boxtypes Making Your Own Boxtypes -<P>You can define your own boxtypes by making a small function that draws -the box and adding it to the table of boxtypes.</P> +You can define your own boxtypes by making a small function that draws +the box and adding it to the table of boxtypes. <CENTER><TABLE WIDTH="80%" BORDER="1" CELLPADDING="5" CELLSPACING="0" BGCOLOR="#cccccc"> <TR> <TD><B>Note:</B> - <P>This interface has changed in FLTK 2.0!</P> + <P>This interface has changed in FLTK 2.0! </TD> </TR> </TABLE></CENTER> -<H4>The Drawing Function</H4> +\par The Drawing Function -<P>The drawing function is passed the bounding box and background color -for the widget:</P> +The drawing function is passed the bounding box and background color +for the widget: \code void xyz_draw(int x, int y, int w, int h, Fl_Color c) { @@ -285,8 +266,8 @@ void xyz_draw(int x, int y, int w, int h, Fl_Color c) { <!-- NEED 3in --> -<P>A simple drawing function might fill a rectangle with the -given color and then draw a black outline:</P> +A simple drawing function might fill a rectangle with the +given color and then draw a black outline: \code void xyz_draw(int x, int y, int w, int h, Fl_Color c) { @@ -297,183 +278,167 @@ void xyz_draw(int x, int y, int w, int h, Fl_Color c) { } \endcode -<H4><A name="fl_down">Fl_Boxtype fl_down(Fl_Boxtype)</A></H4> +<A name="fl_down"></A> <!-- For old HTML links only ! --> +\par Fl_Boxtype fl_down(Fl_Boxtype) -<P><tt>fl_down</tt> returns the "pressed" or "down" version of a box. +<tt>fl_down</tt> returns the "pressed" or "down" version of a box. If no "down" version of a given box exists, the behavior of this function is undefined and some random box or frame is returned. See also: <A HREF="drawing.html#fl_frame">fl_frame drawing</A>. -<H4><A name="fl_frame">Fl_Boxtype fl_frame(Fl_Boxtype)</A></H4> +<A name="fl_frame"></A> <!-- For old HTML links only ! --> +\par Fl_Boxtype fl_frame(Fl_Boxtype) -<P><tt>fl_frame</tt> returns the unfilled, frame-only version of a box. +<tt>fl_frame</tt> returns the unfilled, frame-only version of a box. If no frame version of a given box exists, the behavior of this function is undefined and some random box or frame is returned. See also: <A HREF="drawing.html#fl_frame">fl_frame drawing</A>. -<H4><A name="fl_box">Fl_Boxtype fl_box(Fl_Boxtype)</A></H4> +<A name="fl_box"></A> <!-- For old HTML links only ! --> +\par Fl_Boxtype fl_box(Fl_Boxtype) -<P><tt>fl_box</tt> returns the filled version of a frame. +<tt>fl_box</tt> returns the filled version of a frame. If no filled version of a given frame exists, the behavior of this function is undefined and some random box or frame is returned. -See also: <TT><A HREF="#fl_frame">fl_frame</A></TT>. +See also: <tt><A HREF="#fl_frame">fl_frame</A></tt>. -<H4>Adding Your Box Type</H4> +\par Adding Your Box Type -<P>The <TT>Fl::set_boxtype()</TT> method adds or replaces the -specified box type:</P> +The <tt>Fl::set_boxtype()</tt> method adds or replaces the specified box type: \code #define XYZ_BOX FL_FREE_BOXTYPE Fl::set_boxtype(XYZ_BOX, xyz_draw, 1, 1, 2, 2); \endcode - -<P>The last 4 arguments to <TT>Fl::set_boxtype()</TT> are the +The last 4 arguments to <tt>Fl::set_boxtype()</tt> are the offsets for the x, y, width, and height values that should be -subtracted when drawing the label inside the box.</P> +subtracted when drawing the label inside the box. -<P>A complete box design contains four box types in this order: -a filled, neutral box (<TT>UP_BOX</TT>), a filled, depressed box -(<TT>DOWN_BOX</TT>), and the same as outlines only (<TT>UP_FRAME</TT> -and <TT>DOWN_FRAME</TT>). The function -<TT><A HREF="#fl_down">fl_down(Fl_Boxtype)</A></TT> +A complete box design contains four box types in this order: +a filled, neutral box (<tt>UP_BOX</tt>), a filled, depressed box +(<tt>DOWN_BOX</tt>), and the same as outlines only (<tt>UP_FRAME</tt> +and <tt>DOWN_FRAME</tt>). The function +<tt><A HREF="#fl_down">fl_down(Fl_Boxtype)</A></tt> expects the neutral design on a boxtype with a numerical value evenly divideable by two. -<TT><A HREF="#fl_frame">fl_frame(Fl_Boxtype)</A></TT> -expects the <TT>UP_BOX</TT> design at a value divideable by four.</P> +<tt><A HREF="#fl_frame">fl_frame(Fl_Boxtype)</A></tt> +expects the <tt>UP_BOX</tt> design at a value divideable by four. <A NAME="labels"></A> <!-- For old HTML links only ! --> \section common_labels Labels and Label Types -<P>The <TT>label()</TT>, <TT>align()</TT>, <TT>labelfont()</TT>, -<TT>labelsize()</TT>, <TT>labeltype()</TT>, <TT>image()</TT>, and -<TT>deimage()</TT> methods control the labeling of widgets.</P> +The <tt>label()</tt>, <tt>align()</tt>, <tt>labelfont()</tt>, +<tt>labelsize()</tt>, <tt>labeltype()</tt>, <tt>image()</tt>, and +<tt>deimage()</tt> methods control the labeling of widgets. -<H3>label()</H3> +\par label() -<P>The <TT>label()</TT> method sets the string that is displayed +The <tt>label()</tt> method sets the string that is displayed for the label. Symbols can be included with the label string by escaping them using the "@" symbol - "@@" displays a single at -sign. Figure 3-4 shows the available symbols.</P> +sign. Figure 3-4 shows the available symbols. \image html symbols.gif "Figure 3-4: FLTK label symbols" <!-- NEED 2in --> -<P>The @ sign may also be followed by the following optional -"formatting" characters, in this order:</P> +The @ sign may also be followed by the following optional +"formatting" characters, in this order: -<UL> +\li '#' forces square scaling, rather than distortion to the widget's shape. - <LI>'#' forces square scaling, rather than distortion to - the widget's shape.</LI> +\li +[1-9] or -[1-9] tweaks the scaling a little bigger or smaller. - <LI>+[1-9] or -[1-9] tweaks the scaling a little bigger - or smaller.</LI> +\li '$' flips the symbol horizontaly, '%' flips it verticaly. - <LI>'$' flips the symbol horizontaly, '%' flips it verticaly.</LI> +\li [0-9] - rotates by a multiple of 45 degrees. '5' and '6' do no rotation + while the others point in the direction of that key on a numeric keypad. + '0', followed by four more digits rotates the symbol by that amount in + degrees. - <LI>[0-9] - rotates by a multiple of 45 degrees. '5' and - '6' do no rotation while the others point in the - direction of that key on a numeric keypad. '0', followed by four - more digits rotates the symbol by that amount in degrees.</LI> - -</UL> - -<P>Thus, to show a very large arrow pointing downward you would use the +Thus, to show a very large arrow pointing downward you would use the label string "@+92->". -<H3>align()</H3> - -<P>The <TT>align()</TT> method positions the label. The following -constants are defined and may be OR'd together as needed:</P> - -<UL> - - <LI><TT>FL_ALIGN_CENTER</TT> - center the label in the widget.</LI> - - <LI><TT>FL_ALIGN_TOP</TT> - align the label at the top of the widget.</LI> +\par align() - <LI><TT>FL_ALIGN_BOTTOM</TT> - align the label at the bottom of the - widget.</LI> +The <tt>align()</tt> method positions the label. The following +constants are defined and may be OR'd together as needed: - <LI><TT>FL_ALIGN_LEFT</TT> - align the label to the left of the widget.</LI> +\li <tt>FL_ALIGN_CENTER</tt> - center the label in the widget. - <LI><TT>FL_ALIGN_RIGHT</TT> - align the label to the right of the - widget.</LI> +\li <tt>FL_ALIGN_TOP</tt> - align the label at the top of the widget. - <LI><TT>FL_ALIGN_INSIDE</TT> - align the label inside the widget.</LI> +\li <tt>FL_ALIGN_BOTTOM</tt> - align the label at the bottom of the + widget. - <LI><TT>FL_ALIGN_CLIP</TT> - clip the label to the widget's bounding - box.</LI> +\li <tt>FL_ALIGN_LEFT</tt> - align the label to the left of the widget. - <LI><TT>FL_ALIGN_WRAP</TT> - wrap the label text as needed.</LI> +\li <tt>FL_ALIGN_RIGHT</tt> - align the label to the right of the + widget. - <LI><TT>FL_TEXT_OVER_IMAGE</TT> - show the label text over the image.</LI> +\li <tt>FL_ALIGN_INSIDE</tt> - align the label inside the widget. - <LI><TT>FL_IMAGE_OVER_TEXT</TT> - show the label image over the text (default).</LI> +\li <tt>FL_ALIGN_CLIP</tt> - clip the label to the widget's bounding + box. -</UL> +\li <tt>FL_ALIGN_WRAP</tt> - wrap the label text as needed. -<H3><A NAME="labeltypes">labeltype()</A></H3> +\li <tt>FL_TEXT_OVER_IMAGE</tt> - show the label text over the image. -<P>The <TT>labeltype()</TT> method sets the type of the label. The -following standard label types are included:</P> +\li <tt>FL_IMAGE_OVER_TEXT</tt> - show the label image over the text (default). -<UL> +<A NAME="labeltypes"></A> <!-- For old HTML links only ! --> +\par labeltype() - <LI><TT>FL_NORMAL_LABEL</TT> - draws the text.</LI> +The <tt>labeltype()</tt> method sets the type of the label. The +following standard label types are included: - <LI><TT>FL_NO_LABEL</TT> - does nothing.</LI> +\li <tt>FL_NORMAL_LABEL</tt> - draws the text. - <LI><TT>FL_SHADOW_LABEL</TT> - draws a drop shadow under - the text.</LI> +\li <tt>FL_NO_LABEL</tt> - does nothing. - <LI><TT>FL_ENGRAVED_LABEL</TT> - draws edges as though - the text is engraved.</LI> +\li <tt>FL_SHADOW_LABEL</tt> - draws a drop shadow under the text. - <LI><TT>FL_EMBOSSED_LABEL</TT> - draws edges as thought - the text is raised.</LI> +\li <tt>FL_ENGRAVED_LABEL</tt> - draws edges as though the text is engraved. - <LI><TT>FL_ICON_LABEL</TT> - draws the icon associated - with the text.</LI> +\li <tt>FL_EMBOSSED_LABEL</tt> - draws edges as thought the text is raised. -</UL> +\li <tt>FL_ICON_LABEL</tt> - draws the icon associated with the text. -<H3>image() and deimage()</H3> +\par image() and deimage() -<P>The <TT>image()</TT> and <TT>deimage()</TT> methods set an image that -will be displayed with the widget. The <TT>deimage()</TT> method sets the -image that is shown when the widget is inactive, while the <TT>image()</TT> -method sets the image that is shown when the widget is active.</P> +The <tt>image()</tt> and <tt>deimage()</tt> methods set an image that +will be displayed with the widget. The <tt>deimage()</tt> method sets the +image that is shown when the widget is inactive, while the <tt>image()</tt> +method sets the image that is shown when the widget is active. -<P>To make an image you use a subclass of -<A HREF="drawing.html#Fl_Image"><TT>Fl_Image</TT></A>.</P> +To make an image you use a subclass of +<A HREF="drawing.html#Fl_Image"><tt>Fl_Image</tt></A>. -<H4>Making Your Own Label Types</H4> +\par Making Your Own Label Types -<P>Label types are actually indexes into a table of functions +Label types are actually indexes into a table of functions that draw them. The primary purpose of this is to use this to draw the labels in ways inaccessible through the -<TT>fl_font</TT> mechanisim (e.g. <TT>FL_ENGRAVED_LABEL</TT>) or -with program-generated letters or symbology.</P> +<tt>fl_font</tt> mechanisim (e.g. <tt>FL_ENGRAVED_LABEL</tt>) or +with program-generated letters or symbology. <CENTER><TABLE WIDTH="80%" BORDER="1" CELLPADDING="5" CELLSPACING="0" BGCOLOR="#cccccc"> <TR> <TD><B>Note:</B> - <P>This interface has changed in FLTK 2.0!</P> + <P>This interface has changed in FLTK 2.0! </TD> </TR> </TABLE></CENTER> -<H5>Label Type Functions</H5> +\par Label Type Functions -<P>To setup your own label type you will need to write two +To setup your own label type you will need to write two functions: one to draw and one to measure the label. The draw -function is called with a pointer to a <TT>Fl_Label</TT> +function is called with a pointer to a <tt>Fl_Label</tt> structure containing the label information, the bounding box for -the label, and the label alignment:</P> +the label, and the label alignment: \code void xyz_draw(const Fl_Label *label, int x, int y, int w, int h, Fl_Align align) { @@ -481,13 +446,13 @@ void xyz_draw(const Fl_Label *label, int x, int y, int w, int h, Fl_Align align) } \endcode -<P>The label should be drawn <I>inside</I> this bounding box, -even if <TT>FL_ALIGN_INSIDE</TT> is not enabled. The function -is not called if the label value is <TT>NULL</TT>.</P> +The label should be drawn <I>inside</I> this bounding box, +even if <tt>FL_ALIGN_INSIDE</tt> is not enabled. The function +is not called if the label value is <tt>NULL</tt>. -<P>The measure function is called with a pointer to a -<TT>Fl_Label</TT> structure and references to the width and -height:</P> +The measure function is called with a pointer to a +<tt>Fl_Label</tt> structure and references to the width and +height: \code void xyz_measure(const Fl_Label *label, int &w, int &h) { @@ -495,13 +460,13 @@ void xyz_measure(const Fl_Label *label, int &w, int &h) { } \endcode -<P>The function should measure the size of the label and set -<TT>w</TT> and <TT>h</TT> to the size it will occupy.</P> +The function should measure the size of the label and set +<tt>w</tt> and <tt>h</tt> to the size it will occupy. -<H5>Adding Your Label Type</H5> +\par Adding Your Label Type -<P>The <TT>Fl::set_labeltype</TT> method creates a label type -using your draw and measure functions:</P> +The <tt>Fl::set_labeltype</tt> method creates a label type +using your draw and measure functions: \code #define XYZ_LABEL FL_FREE_LABELTYPE @@ -509,47 +474,48 @@ using your draw and measure functions:</P> Fl::set_labeltype(XYZ_LABEL, xyz_draw, xyz_measure); \endcode -<P>The label type number <TT>n</TT> can be any integer value -starting at the constant <TT>FL_FREE_LABELTYPE</TT>. Once you -have added the label type you can use the <TT>labeltype()</TT> -method to select your label type.</P> +The label type number <tt>n</tt> can be any integer value +starting at the constant <tt>FL_FREE_LABELTYPE</tt>. Once you +have added the label type you can use the <tt>labeltype()</tt> +method to select your label type. -<P>The <TT>Fl::set_labeltype</TT> method can also be used to overload -an existing label type such as <TT>FL_NORMAL_LABEL</TT>.</P> +The <tt>Fl::set_labeltype</tt> method can also be used to overload +an existing label type such as <tt>FL_NORMAL_LABEL</tt>. -<H4><A NAME="add_symbol">Making your own symbols</A></H4> +<A NAME="add_symbol"></A> <!-- For old HTML links only ! --> +\par Making your own symbols -<P>It is also possible to define your own drawings and add +It is also possible to define your own drawings and add them to the symbol list, so they can be rendered as part of -any label.</P> +any label. -<P>To create a new symbol, you implement a drawing function +To create a new symbol, you implement a drawing function <tt>void drawit(Fl_Color c)</tt> which typically uses the <a href="drawing.html#complex">complex drawing functions</a> to generate a vector shape inside a two-by-two units sized box around the origin. This function is then linked into the symbols -table using <tt>fl_add_symbol</tt>:</P> +table using <tt>fl_add_symbol</tt>: \code int fl_add_symbol(const char *name, void (*drawit)(Fl_Color), int scalable) \endcode -<P><i>name</i> is the name of the symbol without the "@"; <i>scalable</I> +<i>name</i> is the name of the symbol without the "@"; <i>scalable</I> must be set to 1 if the symbol is generated using scalable vector drawing -functions.</P> +functions. \code int fl_draw_symbol(const char *name,int x,int y,int w,int h,Fl_Color col) \endcode -<P>This function draws a named symbol fitting the given rectangle. +This function draws a named symbol fitting the given rectangle. -<H2>Callbacks</H2> +\section common_callbacks Callbacks -<P>Callbacks are functions that are called when the value of a -widget changes. A callback function is sent a <TT>Fl_Widget</TT> +Callbacks are functions that are called when the value of a +widget changes. A callback function is sent a <tt>Fl_Widget</tt> pointer of the widget that changed and a pointer to data that -you provide:</P> +you provide: \code void xyz_callback(Fl_Widget *w, void *data) { @@ -557,9 +523,9 @@ void xyz_callback(Fl_Widget *w, void *data) { } \endcode -<P>The <TT>callback()</TT> method sets the callback function for a +The <tt>callback()</tt> method sets the callback function for a widget. You can optionally pass a pointer to some data needed for the -callback:</P> +callback: \code int xyz_data; @@ -567,9 +533,9 @@ int xyz_data; button->callback(xyz_callback, &xyz_data); \endcode -<P>Normally callbacks are performed only when the value of the +Normally callbacks are performed only when the value of the widget changes. You can change this using the Fl_Widget::when() -method:</P> +method: \code button->when(FL_WHEN_NEVER); @@ -589,22 +555,22 @@ button->when(FL_WHEN_CHANGED | FL_WHEN_NOT_CHANGED); widget may still be accessed by FLTK after your callback is completed. Instead, use the Fl::delete_widget() method to mark your widget for deletion when it is safe - to do so.</p> + to do so. <p><B>Hint:</B> <P>Many programmers new to FLTK or C++ try to use a non-static class method instead of a static class method or function for their callback. Since callbacks are done - outside a C++ class, the <TT>this</TT> pointer is not - initialized for class methods.</P> + outside a C++ class, the <tt>this</tt> pointer is not + initialized for class methods. <P>To work around this problem, define a static method in your class that accepts a pointer to the class, and then have the static method call the class method(s) as needed. The data pointer you provide to the - <TT>callback()</TT> method of the widget can be a - pointer to the instance of your class.</P> + <tt>callback()</tt> method of the widget can be a + pointer to the instance of your class. \code class Foo { @@ -621,11 +587,11 @@ w->callback(my_static_callback, (void *)this); </TR> </TABLE></CENTER> -<H2>Shortcuts</H2> +\section common_shortcuts Shortcuts -<P>Shortcuts are key sequences that activate widgets such as -buttons or menu items. The <TT>shortcut()</TT> method sets the -shortcut for a widget:</P> +Shortcuts are key sequences that activate widgets such as +buttons or menu items. The <tt>shortcut()</tt> method sets the +shortcut for a widget: \code button->shortcut(FL_Enter); @@ -636,11 +602,11 @@ button->shortcut(FL_CTRL + FL_ALT + 'b'); button->shortcut(0); // no shortcut \endcode -<P>The shortcut value is the key event value - the ASCII value +The shortcut value is the key event value - the ASCII value or one of the special keys like -<a href="enumerations.html#key_values"><TT>FL_Enter</TT></a> - +<a href="enumerations.html#key_values"><tt>FL_Enter</tt></a> - combined with any modifiers like <KBD>Shift</KBD>, -<KBD>Alt</KBD>, and <KBD>Control</KBD>.</P> +<KBD>Alt</KBD>, and <KBD>Control</KBD>. <hr> <a class="el" href="index.html">[Index]</a> |
