diff options
| author | Michael R Sweet <michael.r.sweet@gmail.com> | 2001-11-29 19:24:00 +0000 |
|---|---|---|
| committer | Michael R Sweet <michael.r.sweet@gmail.com> | 2001-11-29 19:24:00 +0000 |
| commit | 09daf20b81cdae78772f07c0af22a571d7cc73eb (patch) | |
| tree | 1641f788cafe20b505355b0479ba0d528297eb30 /documentation/Fl_Button.html | |
| parent | b105ab8b7fb6281635076559aae96f2b3b12fc51 (diff) | |
Documentation updates galore (up to chapter 7, still need to do chapter
8 and 9, tweek the appendices, and recapture the screenshots...)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@1786 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation/Fl_Button.html')
| -rw-r--r-- | documentation/Fl_Button.html | 68 |
1 files changed, 34 insertions, 34 deletions
diff --git a/documentation/Fl_Button.html b/documentation/Fl_Button.html index 26202efcb..921c86391 100644 --- a/documentation/Fl_Button.html +++ b/documentation/Fl_Button.html @@ -20,14 +20,14 @@ </PRE> </UL> <H3>Description</H3> -<P>Buttons generate callbacks when they are clicked by the user. You +<P>Buttons generate callbacks when they are clicked by the user. You control exactly when and how by changing the values for <TT>type()</TT> and <TT>when()</TT>. </P> <P>Buttons can also generate callbacks in response to <TT>FL_SHORTCUT</TT> events. The button can either have an explicit <A href=#Fl_Button.shortcut> -<TT>shortcut()</TT></A> value or a letter shortcut can be indicated in -the <TT>label()</TT> with an '&' character before it. For the label -shortcut it does not matter if <I>Alt</I> is held down, but if you have +<TT>shortcut()</TT></A> value or a letter shortcut can be indicated in +the <TT>label()</TT> with an '&' character before it. For the label +shortcut it does not matter if <I>Alt</I> is held down, but if you have an input field in the same window, the user will have to hold down the <I> Alt</I> key so that the input field does not eat the event first as an <TT> FL_KEYBOARD</TT> event. </P> @@ -62,69 +62,69 @@ FL_KEYBOARD</TT> event. </P> </TD></TR> </TABLE> </CENTER> -<H4><A name=Fl_Button.Fl_Button>Fl_Button::Fl_Button(int x, int y, int +<H4><A name=Fl_Button.Fl_Button>Fl_Button::Fl_Button(int x, int y, int w, int h, const char *label = 0)</A></H4> - The constructor creates the button using the position, size, and -label. + The constructor creates the button using the position, size, and +label. <H4><A name=Fl_Button.~Fl_Button>Fl_Button::~Fl_Button(void)</A></H4> - The destructor removed the button. + The destructor removed the button. <H4><A name=Fl_Button.clear>int Fl_Button::clear()</A></H4> - Same as <TT>value(0)</TT>. + Same as <TT>value(0)</TT>. <H4><A name=Fl_Button.down_box>Fl_Boxtype Fl_Button::down_box() const <BR> void Fl_Button::down_box(Fl_Boxtype bt)</A></H4> The first form returns the current down box type, which is drawn when <TT> -value()</TT> is non-zero. -<P>The second form sets the down box type. The default value of 0 +value()</TT> is non-zero. +<P>The second form sets the down box type. The default value of 0 causes FLTK to figure out the correct matching down version of <TT>box()</TT> . </P> <H4><A name=Fl_Button.set>int Fl_Button::set()</A></H4> - Same as <TT>value(1)</TT>. + Same as <TT>value(1)</TT>. <H4><A name=Fl_Button.setonly>void Fl_Button::setonly()</A></H4> - Turns on this button and turns off all other radio buttons in the -group (calling <TT>value(1)</TT> or <TT>set()</TT> does not do this). + Turns on this button and turns off all other radio buttons in the +group (calling <TT>value(1)</TT> or <TT>set()</TT> does not do this). <H4><A name=Fl_Button.shortcut>ulong Fl_Button::shortcut() const <BR> void Fl_Button::shortcut(ulong key)</A></H4> - The first form returns the current shortcut key for the button. -<P>The second form sets the shortcut key to <TT>key</TT>. Setting this -overrides the use of '&' in the <TT>label()</TT>. The value is a bitwise + The first form returns the current shortcut key for the button. +<P>The second form sets the shortcut key to <TT>key</TT>. Setting this +overrides the use of '&' in the <TT>label()</TT>. The value is a bitwise OR of a key and a set of shift flags, for example <CODE>FL_ALT | 'a'</CODE> -, <CODE>FL_ALT | (FL_F + 10)</CODE>, or just <CODE>'a'</CODE>. A value +, <CODE>FL_ALT | (FL_F + 10)</CODE>, or just <CODE>'a'</CODE>. A value of 0 disables the shortcut. </P> <P>The key can be any value returned by <A href=functions.html#event_key> -<TT>Fl::event_key()</TT></A>, but will usually be an ASCII letter. Use +<TT>Fl::event_key()</TT></A>, but will usually be an ASCII letter. Use a lower-case letter unless you require the shift key to be held down. </P> <P>The shift flags can be any set of values accepted by <A href=events.html#event_state> -<TT>Fl::event_state()</TT></A>. If the bit is on that shift key must -be pushed. Meta, Alt, Ctrl, and Shift must be off if they are not in -the shift flags (zero for the other bits indicates a "don't care" +<TT>Fl::event_state()</TT></A>. If the bit is on that shift key must +be pushed. Meta, Alt, Ctrl, and Shift must be off if they are not in +the shift flags (zero for the other bits indicates a "don't care" setting). </P> <H4><A name=Fl_Button.type>uchar Fl_Button::type() const <BR> void Fl_Button::type(uchar t)</A></H4> - The first form of <TT>type()</TT> returns the current button type, -which can be one of: + The first form of <TT>type()</TT> returns the current button type, +which can be one of: <UL> <LI><CODE>0</CODE>: The value is unchanged. </LI> <LI><CODE>FL_TOGGLE_BUTTON</CODE>: The value is inverted. </LI> -<LI><CODE>FL_RADIO_BUTTON</CODE>: The value is set to 1, and all other +<LI><CODE>FL_RADIO_BUTTON</CODE>: The value is set to 1, and all other buttons in the current group with <CODE>type() == FL_RADIO_BUTTON</CODE> are set to zero. </LI> </UL> - The second form sets the button type to <TT>t</TT>. + The second form sets the button type to <TT>t</TT>. <H4><A name=Fl_Button.value>char Fl_Button::value() const <BR> int Fl_Button::value(int)</A></H4> - The first form returns the current value (0 or 1). The second form -sets the current value. + The first form returns the current value (0 or 1). The second form +sets the current value. <H4><A name=Fl_Button.when>Fl_When Fl_Widget::when() const <BR> void Fl_Widget::when(Fl_When w)</A></H4> - Controls when callbacks are done. The following values are useful, -the default value is <CODE>FL_WHEN_RELEASE</CODE>: + Controls when callbacks are done. The following values are useful, +the default value is <CODE>FL_WHEN_RELEASE</CODE>: <UL> -<LI><CODE>0</CODE>: The callback is not done, instead changed() is +<LI><CODE>0</CODE>: The callback is not done, instead changed() is turned on. </LI> -<LI><CODE>FL_WHEN_RELEASE</CODE>: The callback is done after the user +<LI><CODE>FL_WHEN_RELEASE</CODE>: The callback is done after the user successfully clicks the button, or when a shortcut is typed. </LI> -<LI><CODE>FL_WHEN_CHANGED </CODE>: The callback is done each time the - value() changes (when the user pushes and releases the button, and as +<LI><CODE>FL_WHEN_CHANGED </CODE>: The callback is done each time the + value() changes (when the user pushes and releases the button, and as the mouse is dragged around in and out of the button). </LI> </UL> </BODY></HTML> |
