Add missing documentation.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@2681 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Michael R Sweet 2002-10-21 18:05:28 +00:00
parent 82eeab48e6
commit 2ba819c6e7

View File

@ -46,6 +46,7 @@ state information and global methods for the current application.</P>
<LI><A HREF="#Fl.check">check</A></LI> <LI><A HREF="#Fl.check">check</A></LI>
<LI><A HREF="#Fl.compose">compose</A></LI> <LI><A HREF="#Fl.compose">compose</A></LI>
<LI><A HREF="#Fl.compose_reset">compose_reset</A></LI> <LI><A HREF="#Fl.compose_reset">compose_reset</A></LI>
<LI><A HREF="#Fl.copy">copy</A></LI>
<LI><A HREF="#Fl.damage">damage</A></LI> <LI><A HREF="#Fl.damage">damage</A></LI>
<LI><A HREF="#Fl.default_atclose">default_atclose</A></LI> <LI><A HREF="#Fl.default_atclose">default_atclose</A></LI>
<LI><A HREF="#Fl.display">display</A></LI> <LI><A HREF="#Fl.display">display</A></LI>
@ -452,6 +453,14 @@ The next call to Fl::compose() will start out in an initial state. In
particular it will not set "del" to non-zero. This call is very fast particular it will not set "del" to non-zero. This call is very fast
so it is ok to call it many times and in many places. so it is ok to call it many times and in many places.
<H4><A NAME="Fl.copy">void copy(const char *stuff, int len, int clipboard);</A></H4>
<P>Copies the data pointed to by <TT>stuff</TT> to the selection
(0) or primary (1) clipboard. The selection clipboard is used
for middle-mouse pastes and for drag-and-drop selections. The
primary clipboard is used for traditional copy/cut/paste
operations.
<H4><A NAME="Fl.damage">int damage();<BR> <H4><A NAME="Fl.damage">int damage();<BR>
void damage(int x);</A></H4> void damage(int x);</A></H4>
@ -493,12 +502,20 @@ prints the error message to <TT>stderr</TT> and returns.
<H4><A NAME="Fl.event_alt">int event_alt();</A></H4> <H4><A NAME="Fl.event_alt">int event_alt();</A></H4>
<P>Returns non-zero if the Alt key is pressed.
<H4><A NAME="Fl.event_button1">int event_button1();</A></H4> <H4><A NAME="Fl.event_button1">int event_button1();</A></H4>
<P>Returns non-zero if button 1 is pressed.
<H4><A NAME="Fl.event_button2">int event_button2();</A></H4> <H4><A NAME="Fl.event_button2">int event_button2();</A></H4>
<P>Returns non-zero if button 2 is pressed.
<H4><A NAME="Fl.event_button3">int event_button3();</A></H4> <H4><A NAME="Fl.event_button3">int event_button3();</A></H4>
<P>Returns non-zero if button 3 is pressed.
<H4><A NAME="Fl.event_button">int event_button();</A></H4> <H4><A NAME="Fl.event_button">int event_button();</A></H4>
<P>Returns which mouse button was pressed. This returns garbage if the <P>Returns which mouse button was pressed. This returns garbage if the
@ -507,6 +524,9 @@ event.
<H4><A NAME="Fl.event_buttons">int event_buttons();</A></H4> <H4><A NAME="Fl.event_buttons">int event_buttons();</A></H4>
<P>Returns the button state bits; if non-zero, then at least one
button is pressed.
<H4><A NAME="Fl.event_clicks">int event_clicks();</A></H4> <H4><A NAME="Fl.event_clicks">int event_clicks();</A></H4>
<P>The first form returns non-zero if the most recent <tt>FL_PUSH</tt> or <P>The first form returns non-zero if the most recent <tt>FL_PUSH</tt> or
@ -520,8 +540,14 @@ later code does not think an item was double-clicked.
<H4><A NAME="Fl.event_ctrl">int event_ctrl();</A></H4> <H4><A NAME="Fl.event_ctrl">int event_ctrl();</A></H4>
<P>Returns non-zero if the Control key is pressed.
<H4><A NAME="Fl.event">int event();</A></H4> <H4><A NAME="Fl.event">int event();</A></H4>
<P>Returns the last event that was processed. This can be used
to determine if a callback is being done in response to a
keypress, mouse click, etc.
<H4><A NAME="Fl.event_inside">int event_inside(int,int,int,int);<BR> <H4><A NAME="Fl.event_inside">int event_inside(int,int,int,int);<BR>
int event_inside(const Fl_Widget*);</A></H4> int event_inside(const Fl_Widget*);</A></H4>
@ -598,6 +624,8 @@ you paste a nul character.
<H4><A NAME="Fl.event_shift">int event_shift();</A></H4> <H4><A NAME="Fl.event_shift">int event_shift();</A></H4>
<P>Returns non-zero if the Shift key is pressed.
<H4><A NAME="Fl.event_state">int event_state();<BR> <H4><A NAME="Fl.event_state">int event_state();<BR>
int event_state(int i);</A></H4> int event_state(int i);</A></H4>
@ -999,7 +1027,7 @@ or the <TT>scheme</TT> resource under X11.
copied to an internal buffer by FLTK (be careful if doing this in copied to an internal buffer by FLTK (be careful if doing this in
response to an <tt>FL_PASTE</tt> as this <I>may</I> be the same buffer response to an <tt>FL_PASTE</tt> as this <I>may</I> be the same buffer
returned by <tt>event_text()</tt>). The <tt>selection_owner()</tt> returned by <tt>event_text()</tt>). The <tt>selection_owner()</tt>
widget is set to the passed owner (possibly sending <tt> widget is set to the passed owner.
<H4><A NAME="Fl.selection_owner">Fl_Widget* selection_owner();<BR> <H4><A NAME="Fl.selection_owner">Fl_Widget* selection_owner();<BR>
void selection_owner(Fl_Widget*);</A></H4> void selection_owner(Fl_Widget*);</A></H4>