From a721b4ad00eb6bfa5483d62ed2461f15ca94a407 Mon Sep 17 00:00:00 2001 From: Michael R Sweet Date: Tue, 15 Jan 2002 02:17:19 +0000 Subject: Doco and makefile updates from SGI. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@1934 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/Fl.html | 13 +++++++++++-- documentation/Fl_Button.html | 4 ++-- documentation/Fl_Clock.html | 2 +- documentation/Fl_File_Chooser.html | 2 +- documentation/Fl_Help_Dialog.html | 4 ++-- documentation/Fl_Help_View.html | 4 ++-- documentation/Fl_Menu_Item.html | 6 +++--- documentation/Fl_Timer.html | 2 +- documentation/Fl_Widget.html | 23 +++++++++++++++++++---- documentation/Fl_Window.html | 4 ++-- documentation/Fl_Wizard.html | 2 +- documentation/Makefile | 5 ++--- documentation/basics.html | 6 +++--- documentation/common.html | 8 ++++---- documentation/drawing.html | 9 +++++---- documentation/enumerations.html | 2 ++ documentation/forms.html | 2 +- documentation/glut.html | 2 +- documentation/index.html | 2 +- documentation/opengl.html | 2 +- documentation/osissues.html | 6 +++--- documentation/subclassing.html | 1 - 22 files changed, 68 insertions(+), 43 deletions(-) (limited to 'documentation') diff --git a/documentation/Fl.html b/documentation/Fl.html index 438acbf43..692181511 100644 --- a/documentation/Fl.html +++ b/documentation/Fl.html @@ -36,8 +36,8 @@ state information and global methods for the current application.

  • args
  • atclose
  • awake
    • -
  • background2
  • background
    • +
  • background2
  • belowmouse
  • box_dh
  • box_dw
    • @@ -50,6 +50,7 @@ state information and global methods for the current application.

  • default_atclose
  • display
  • error
    • +
  • event
  • event_alt
  • event_button1
  • event_button2
    • @@ -58,13 +59,15 @@ state information and global methods for the current application.

  • event_buttons
  • event_clicks
  • event_ctrl
    • -
  • event
    • +
  • event_dx
    • +
  • event_dx
  • event_inside
  • event_is_click
  • event_key
  • event_length
  • event_shift
  • event_state
    • +
  • event_text
  • event_x
  • event_x_root
  • event_y
    • @@ -1103,5 +1106,11 @@ the left side of the screen.

    Returns the origin of the current screen, where 0 indicates the top edge of the screen. +

    int event_dx();

    + +

    int event_dy();

    + +

    const char* event_text();

    + diff --git a/documentation/Fl_Button.html b/documentation/Fl_Button.html index 921c86391..e6ee1e733 100644 --- a/documentation/Fl_Button.html +++ b/documentation/Fl_Button.html @@ -90,10 +90,10 @@ overrides the use of '&' in the label(). The value is a bitwise OR of a key and a set of shift flags, for example FL_ALT | 'a' , FL_ALT | (FL_F + 10), or just 'a'. A value of 0 disables the shortcut.

    -

    The key can be any value returned by +

    The key can be any value returned by Fl::event_key(), but will usually be an ASCII letter. Use a lower-case letter unless you require the shift key to be held down.

    -

    The shift flags can be any set of values accepted by +

    The shift flags can be any set of values accepted by Fl::event_state(). 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" diff --git a/documentation/Fl_Clock.html b/documentation/Fl_Clock.html index 682b06414..fa5284faa 100644 --- a/documentation/Fl_Clock.html +++ b/documentation/Fl_Clock.html @@ -18,7 +18,7 @@

    Description

    This widget provides a round analog clock display and is provided for -Forms compatibility. It installs a 1-second timeout callback using +Forms compatibility. It installs a 1-second timeout callback using Fl::add_timeout().

    Fl_Clock widget. Fl_Clock widget.

    Methods

    diff --git a/documentation/Fl_File_Chooser.html b/documentation/Fl_File_Chooser.html index 10b4c92c3..c781513d8 100644 --- a/documentation/Fl_File_Chooser.html +++ b/documentation/Fl_File_Chooser.html @@ -2,7 +2,7 @@ -

    class Fl_File_Chooser

    +

    class Fl_File_Chooser

    diff --git a/documentation/Fl_Help_Dialog.html b/documentation/Fl_Help_Dialog.html index d344cc0fc..e414019ab 100644 --- a/documentation/Fl_Help_Dialog.html +++ b/documentation/Fl_Help_Dialog.html @@ -2,7 +2,7 @@ -

    class Fl_Help_Dialog

    +

    class Fl_Help_Dialog

    @@ -45,7 +45,7 @@ using the Fl_Help_View widget.

    The constructor creates the dialog pictured above. -

    ~Fl_Help_View()

    +

    ~Fl_Help_View()

    The destructor destroys the widget and frees all memory that has been allocated for the current file. diff --git a/documentation/Fl_Help_View.html b/documentation/Fl_Help_View.html index 47e5aca2e..3eee0eac3 100644 --- a/documentation/Fl_Help_View.html +++ b/documentation/Fl_Help_View.html @@ -1,6 +1,6 @@ -

    class Fl_Help_View

    +

    class Fl_Help_View

    @@ -84,7 +84,7 @@ the Fl_Help_View widget will remain unchanged.

    If the link callback cannot handle the URI scheme, it should return the uri value unchanged or set the value() of the widget +HREF="#Fl_Help_View.value">value() of the widget before returning NULL.

    int load(const char *f)

    diff --git a/documentation/Fl_Menu_Item.html b/documentation/Fl_Menu_Item.html index 582088f2e..87aa515fe 100644 --- a/documentation/Fl_Menu_Item.html +++ b/documentation/Fl_Menu_Item.html @@ -157,7 +157,7 @@ const
    void Fl_Menu_Item::labelfont(Fl_Font) Fonts are identified by small 8-bit indexes into a table. See the enumeration list for predefined fonts. The default value is a -Helvetica font. The function +Helvetica font. The function Fl::set_font() can define new fonts.

    uchar Fl_Menu_Item::labelsize() const
    void Fl_Menu_Item::labelsize(uchar)

    @@ -197,10 +197,10 @@ before calling this. value is a logical 'or' of a key and a set of shift flags, for instance FL_ALT+'a' or FL_ALT+FL_F+10 or just 'a'. A value of zero disables the shortcut. -

    The key can be any value returned by +

    The key can be any value returned by Fl::event_key(), but will usually be an ASCII letter. Use a lower-case letter unless you require the shift key to be held down.

    -

    The shift flags can be any set of values accepted by +

    The shift flags can be any set of values accepted by Fl::event_state(). 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" diff --git a/documentation/Fl_Timer.html b/documentation/Fl_Timer.html index 489f73d38..725036634 100644 --- a/documentation/Fl_Timer.html +++ b/documentation/Fl_Timer.html @@ -20,7 +20,7 @@ This is provided only to emulate the Forms Timer widget. It works by making a timeout callback every 1/5 second. This is wasteful and inaccurate if you just want something to happen a fixed time in the -future. You should directly call +future. You should directly call Fl::add_timeout() instead.

    Methods

      diff --git a/documentation/Fl_Widget.html b/documentation/Fl_Widget.html index 99c20db3c..b29e11f41 100644 --- a/documentation/Fl_Widget.html +++ b/documentation/Fl_Widget.html @@ -53,12 +53,15 @@ to call redraw() after these.

    • damage
    • deactivate
    • default_callback
      • +
    • deimage
    • do_callback
    • h
     -

    RGB colors can be set using the fl_rgb_color() +

    RGB colors can be set using the fl_rgb_color() function:

      @@ -328,8 +328,8 @@ 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.
      
 
-
      FLTK Symbols
      
-Figure 3-4: FLTK label symbols
      
+
      FLTK Symbols
      
+Figure 3-4: FLTK label symbols
      
 
 
      The @ sign may also be followed by the following optional
 "formatting"  characters, in this order:
      
diff --git a/documentation/drawing.html b/documentation/drawing.html
index dee747871..5b40b9d83 100644
--- a/documentation/drawing.html
+++ b/documentation/drawing.html
@@ -74,7 +74,8 @@ transformation matrix.
 
      In addition, the system may provide clipping when updating windows
 which may be more complex than a simple rectangle.
      
 
-
      void fl_push_clip(int x, int y, int w, int h)
      
+
      void fl_push_clip(int x, int y, int w, int h)
      
+void fl_clip(int x, int y, int w, int h)
      
 
 
      Intersect the current clip region with a rectangle and push this new
 region onto the stack.
@@ -141,10 +142,10 @@ values. These are mapped to the closest color supported by the
 screen, either from one of the 256 colors in the FLTK 1.0.x
 colormap or a direct RGB value on TrueColor screens. You can
 generate 24-bit RGB color values using the fl_rgb_color()
+HREF="enumerations.html#fl_rgb_color">fl_rgb_color()
 function.
 
-
      void fl_color(Fl_Color)
      
+
      void fl_color(Fl_Color)
      
 
 
      Sets the color for all subsequent drawing operations.
 
@@ -685,7 +686,7 @@ fl_draw_pixmap(foo, X, Y);
 
 
      Transparent colors are replaced by the optional
 Fl_Color argument. To draw with true transparency you must
-use the Fl_Pixmap class.
+use the Fl_Pixmap class.
 
 
      int fl_measure_pixmap(char **data, int &w, int &h)
      
 
diff --git a/documentation/enumerations.html b/documentation/enumerations.html
index e9e67e002..24b90f94e 100644
--- a/documentation/enumerations.html
+++ b/documentation/enumerations.html
@@ -207,6 +207,8 @@ To get the closest color to a 8-bit set of R,G,B values use
 fl_color_cube(R*FL_NUM_RED/256, G*FL_NUM_GREEN/256,
 B*FL_NUM_BLUE/256);
 
+
      Fl_Color fl_rgb_color(uchar r, uchar g, uchar b)
+
 
      Cursors
      
 
 
      The following constants define the mouse cursors that are available in
diff --git a/documentation/forms.html b/documentation/forms.html
index 9d0d7cb88..ae885b9dd 100644
--- a/documentation/forms.html
+++ b/documentation/forms.html
@@ -42,7 +42,7 @@ programs that change the handle() function on widgets, but you
 will still need to rewrite things. 
      
 
      Fl_Timer widgets are
 provided to emulate the XForms timer.  These work, but are quite
-inefficient and inaccurate compared to using 
+inefficient and inaccurate compared to using 
 Fl::add_timeout(). 
      
 
      All instance variables are hidden. If you directly refer to
 the x, y, w, h, label, or other fields of your Forms widgets you will
diff --git a/documentation/glut.html b/documentation/glut.html
index 93d7b30e8..1d5b4149d 100644
--- a/documentation/glut.html
+++ b/documentation/glut.html
@@ -68,7 +68,7 @@ small crosshair. 
      
 
      The fonts used by glutBitmapCharacter() and glutBitmapWidth()
  may be different. 
      
 
      glutInit(argc,argv) will consume different switches than
-GLUT does.  It accepts the switches recognized by 
+GLUT does.  It accepts the switches recognized by 
 Fl::args(), and will accept any abbreviation of these
 switches (such as "-di" for "-display"). 
      
 
      Mixing GLUT and FLTK Code
      
diff --git a/documentation/index.html b/documentation/index.html
index 57b0b13be..fd1e3a3a2 100644
--- a/documentation/index.html
+++ b/documentation/index.html
@@ -41,7 +41,7 @@
 	
    • Box Types
      • 
 	
    • Labels and Label Types
      • 
 	
    • Images
      • 
-	
    • class Fl_Pixmap
      • 
+	
    • class Fl_Pixmap
      •
    4 - Designing a Simple Text Editor
    diff --git a/documentation/opengl.html b/documentation/opengl.html index ee2a2e08f..0b0e8a9fe 100644 --- a/documentation/opengl.html +++ b/documentation/opengl.html @@ -241,7 +241,7 @@ adhere to for maximum portability:

    • You must choose a default visual with Fl::gl_visual().
      • + href="Fl.html#Fl.gl_visual">Fl::gl_visual().
    • You cannot pass FL_DOUBLE to Fl::gl_visual().
      • diff --git a/documentation/osissues.html b/documentation/osissues.html index e454bb5a3..99af09039 100644 --- a/documentation/osissues.html +++ b/documentation/osissues.html @@ -88,7 +88,7 @@ window does not belong to FLTK and the add_handler() functions all return 0, this function will return false.

      Besides feeding events your code should call Fl::flush() +href="Fl.html#Fl.flush">Fl::flush() periodically so that FLTK redraws its windows.

      This function will call the callback functions. It will not @@ -148,7 +148,7 @@ colormap. This greatly simplifies its internal structure and makes it much smaller and faster. You can change which it uses by setting global variables before the first Fl_Window::show() is called. You may also want to -call Fl::visual(), which is +call Fl::visual(), which is a portable interface to get a full color and/or double buffered visual. @@ -392,7 +392,7 @@ functions are called.

      This variable contains the most recent message read by GetMessage, which is called by Fl::wait(). This may not be the +href="Fl.html#Fl.wait">Fl::wait(). This may not be the most recent message sent to an FLTK window, because silly WIN32 calls the handle procedures directly for some events (sigh). diff --git a/documentation/subclassing.html b/documentation/subclassing.html index 9da68b134..069bb26b2 100644 --- a/documentation/subclassing.html +++ b/documentation/subclassing.html @@ -368,7 +368,6 @@ may be UTF-8) between applications:

      It may be possible to cut/paste non-text data by using -- cgit v1.2.3