From 772f94ca1ac8aec25aa4ccc337454cf76c5ea700 Mon Sep 17 00:00:00 2001
From: Michael R Sweet
Date: Tue, 27 Nov 2001 02:09:45 +0000
Subject: More docos (many files just copied, so the content isn't right
yet...)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@1753 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
---
documentation/Fl.html | 51 +++++
documentation/Fl_Bitmap.html | 51 +++++
documentation/Fl_GIF_Image.html | 51 +++++
documentation/Fl_Image.html | 438 ++++++++++++++++++++++++++-----------
documentation/Fl_JPEG_Image.html | 51 +++++
documentation/Fl_PNG_Image.html | 51 +++++
documentation/Fl_PNM_Image.html | 51 +++++
documentation/Fl_Pixmap.html | 51 +++++
documentation/Fl_RGB_Image.html | 51 +++++
documentation/Fl_Shared_Image.html | 51 +++++
documentation/Fl_Text_Buffer.html | 336 ++++++++++++++++++++++++++++
documentation/Fl_Text_Display.html | 336 ++++++++++++++++++++++++++++
documentation/Fl_Text_Editor.html | 336 ++++++++++++++++++++++++++++
documentation/Fl_Tiled_Image.html | 51 +++++
documentation/Fl_XBM_Image.html | 51 +++++
documentation/Fl_XPM_Image.html | 51 +++++
documentation/Makefile | 173 ++++++++-------
documentation/fltk.book | 14 +-
18 files changed, 2046 insertions(+), 199 deletions(-)
create mode 100644 documentation/Fl.html
create mode 100644 documentation/Fl_Bitmap.html
create mode 100644 documentation/Fl_GIF_Image.html
create mode 100644 documentation/Fl_JPEG_Image.html
create mode 100644 documentation/Fl_PNG_Image.html
create mode 100644 documentation/Fl_PNM_Image.html
create mode 100644 documentation/Fl_Pixmap.html
create mode 100644 documentation/Fl_RGB_Image.html
create mode 100644 documentation/Fl_Shared_Image.html
create mode 100644 documentation/Fl_Text_Buffer.html
create mode 100644 documentation/Fl_Text_Display.html
create mode 100644 documentation/Fl_Text_Editor.html
create mode 100644 documentation/Fl_Tiled_Image.html
create mode 100644 documentation/Fl_XBM_Image.html
create mode 100644 documentation/Fl_XPM_Image.html
(limited to 'documentation')
diff --git a/documentation/Fl.html b/documentation/Fl.html
new file mode 100644
index 000000000..010fcc73a
--- /dev/null
+++ b/documentation/Fl.html
@@ -0,0 +1,51 @@
+
+
+
+
+
+
+
+
+Class Hierarchy
+
+
+Fl_Image
+ |
+ +----Fl_Bitmap
+ |
+ +----Fl_XBM_Image
+
+
+Include Files
+
+
+#include <FL/Fl_Bitmap.H>
+
+
+Description
+
+The Fl_Bitmap class supports caching and drawing of mono-color
+(bitmap) images. Images are drawn using the current color.
+
+Methods
+
+
+
+
+
+The constructors create a new bitmap from the specified bitmap data.
+
+
+
+The destructor free all memory and server resources that are used by
+the bitmap.
+
+
+
diff --git a/documentation/Fl_Bitmap.html b/documentation/Fl_Bitmap.html
new file mode 100644
index 000000000..010fcc73a
--- /dev/null
+++ b/documentation/Fl_Bitmap.html
@@ -0,0 +1,51 @@
+
+
+
+
+
+
+
+
+Class Hierarchy
+
+
+Fl_Image
+ |
+ +----Fl_Bitmap
+ |
+ +----Fl_XBM_Image
+
+
+Include Files
+
+
+#include <FL/Fl_Bitmap.H>
+
+
+Description
+
+The Fl_Bitmap class supports caching and drawing of mono-color
+(bitmap) images. Images are drawn using the current color.
+
+Methods
+
+
+
+
+
+The constructors create a new bitmap from the specified bitmap data.
+
+
+
+The destructor free all memory and server resources that are used by
+the bitmap.
+
+
+
diff --git a/documentation/Fl_GIF_Image.html b/documentation/Fl_GIF_Image.html
new file mode 100644
index 000000000..010fcc73a
--- /dev/null
+++ b/documentation/Fl_GIF_Image.html
@@ -0,0 +1,51 @@
+
+
+
+
+
+
+
+
+Class Hierarchy
+
+
+Fl_Image
+ |
+ +----Fl_Bitmap
+ |
+ +----Fl_XBM_Image
+
+
+Include Files
+
+
+#include <FL/Fl_Bitmap.H>
+
+
+Description
+
+The Fl_Bitmap class supports caching and drawing of mono-color
+(bitmap) images. Images are drawn using the current color.
+
+Methods
+
+
+
+
+
+The constructors create a new bitmap from the specified bitmap data.
+
+
+
+The destructor free all memory and server resources that are used by
+the bitmap.
+
+
+
diff --git a/documentation/Fl_Image.html b/documentation/Fl_Image.html
index 1287a6113..e0b27db16 100644
--- a/documentation/Fl_Image.html
+++ b/documentation/Fl_Image.html
@@ -1,142 +1,336 @@
-Fl_Image
-
-class Fl_Image
-
-This class holds an image, normally used to label a widget. The
-subclasses define how the data is interpreted, and usually store
-server-side cached versions of the image. All the current types
-define pixel arrays, but other types of images, such as vector
-graphics, can be defined.
+
+
+
+
+Class Hierarchy
+
+Fl_Input_
+ |
+ +----Fl_Input
+ |
+ +----Fl_Float_Input, Fl_Int_Input,
+ Fl_Multiline_Input, Fl_Secret_Input
+
+
+Include Files
+
+#include <FL/Fl_Input.H>
+
+
+Description
+This is the FLTK text input widget. It displays a single line of text
+and lets the user edit it. Normally it is drawn with an inset box and
+a white background. The text may contain any characters (even 0), and
+will correctly display anything, using ^X notation for unprintable
+control characters and \nnn notation for unprintable characters with
+the high bit set. It assumes the font can draw any characters in the
+ISO-8859-1 character set.
-
Methods
+
-ulong id, mask;
-void _draw(int X, int Y, int W, int H, int cx, int cy);
+| Mouse button 1 | Moves the cursor to
+ this point. Drag selects characters. Double click selects words.
+ Triple click selects all text. Shift+click extends the selection.
+ When you select text it is automatically copied to the clipboard.
+ |
-Subclasses may use these protected members of the base class to
-draw a cached pixel array. They must first set id and
-mask to the color and transparency offscreen windows, using
-system-specific code. Then they can call _draw() to draw
-them.
+| Mouse button 2 | Insert the clipboard at
+the point clicked. You can also select a region and replace it with the
+clipboard by selecting the region with mouse button 2.
+ |
-int w,h
+| Mouse button 3 | Currently acts like button 1. |
-These members hold the width and height of the image. They are not
-correct until measure() is called. These are public instance
-variables for back comptability, but you should never set them.
+| Backspace | Deletes one character to the left, or
+deletes the selected region. |
+| Enter | May cause the callback, see when(). |
+| ^A or Home | Go to start of line. |
+| ^B or Left | Move left |
+| ^C | Copy the selection to the clipboard |
+| ^D or Delete | Deletes one character to the right
+or deletes the selected region. |
+| ^E or End | Go to the end of line. |
+| ^F or Right | Move right |
+| ^K | Delete to the end of line (next \n character)
+or deletes a single \n character. These deletions are all concatenated
+into the clipboard. |
+| ^N or Down | Move down (for Fl_Multiline_Input
+only, otherwise it moves to the next input field). |
+| ^P or Up | Move up (for Fl_Multiline_Input only,
+otherwise it moves to the previous input field). |
+| ^U | Delete everything. |
+| ^V or ^Y | Paste the clipboard |
+| ^X or ^W | Copy the region to the clipboard and
+delete it. |
+| ^Z or ^_ | Undo. This is a single-level undo
+mechanism, but all adjacent deletions and insertions are concatenated
+into a single "undo". Often this will undo a lot more than you
+expected. |
+| Shift+move | Move the cursor but also extend the
+selection. |
-virtual void Fl_Image::measure(int W, int H);
+RightCtrl or
+ Compose | Start
+a compose-character
+sequence. The next one or two keys typed define the character to
+insert (see table that follows.)
-Measure how big the image will be if it is drawn inside a W,H
-rectangle and put the result into w,h. For most image types this does
-nothing and w,h are set by the constructor. This may be used to
-initialize the scaling for variable-sized images.
+ For instance, to type "á" type [compose][a]['] or [compose]['][a].
- virtual void Fl_Image::draw(int x,int y,int w,int h, int cx,int
-cy);
+The character "nbsp" (non-breaking space) is typed by using
+[compose][space].
-Draw the image so the point cx,cy of the image is at
-x,y. The image may be scaled or clipped to fit in the w,h
-rectangle, but this is not necessary (although obeying the current
-fl_clip value is!).
+ The single-character sequences may be followed by a space if
+necessary to remove ambiguity. For instance, if you really want to
+type "ª~" rather than "ã" you must type [compose][a][space][~].
- void Fl_Image::draw(int x,int y,int w,int h, Fl_Flags align);
+The same key may be used to "quote" control characters into the
+text. If you need a ^Q character you can get one by typing
+[compose][Control+Q].
-This non-virtual function uses measure() and the
-align flags to figure out cx,cy and call the normal draw
-function. This allows you to center or align any edge of the image
-with a bounding box.
+ X may have a key on the keyboard
+defined as XK_Multi_key. If so this key may be used as well
+as the right-hand control key. You can set this up with the program
+xmodmap.
- virtual Fl_Image::~Fl_Image();
+If your keyboard is set to support a foreign language you should
+also be able to type "dead key" prefix characters. On X you will
+actually be able to see what dead key you typed, and if you then move
+the cursor without completing the sequence the accent will remain
+inserted.
+ |
-The destructor throws away any server-cached information, but in most
-cases does not destroy the local data passed to a constructor.
+
+
+Character Composition Table
+
+ | Keys | Char |
+ Keys | Char |
+ Keys | Char |
+ Keys | Char |
+ Keys | Char |
+ Keys | Char |
-
- This object encapsulates the width, height, and bits of an X bitmap
-(XBM), and allows you to make an Fl_Widget use a bitmap as a
-label, or to just draw the bitmap directly.
+
+ | sp | nbsp |
+ * | ° |
+ ` A | À |
+ D - | Ð |
+ ` a | à |
+ d - | ð
+ |
+ | ! | ¡ |
+ + - | ± |
+ ' A | Á |
+ ~ N | Ñ |
+ ' a | á |
+ ~ n | ñ
+ |
+ | % | ¢ |
+ 2 | ² |
+ A ^ | Â |
+ ` O | Ò |
+ ^ a | â |
+ ` o | ò
+ |
+ | # | £ |
+ 3 | ³ |
+ ~ A | Ã |
+ ' O | Ó |
+ ~ a | ã |
+ ' o | ó
+ |
+ | $ | ¤ |
+ ' | ´ |
+ : A | Ä |
+ ^ O | Ô |
+ : a | ä |
+ ^ o | ô
+ |
+ | y = | ¥ |
+ u | µ |
+ * A | Å |
+ ~ O | Õ |
+ * a | å |
+ ~ o | õ
+ |
+ | | | ¦ |
+ p | ¶ |
+ A E | Æ |
+ : O | Ö |
+ a e | æ |
+ : o | ö
+ |
+ | & | § |
+ . | · |
+ , C | Ç |
+ x | × |
+ , c | ç |
+ - : | ÷
+ |
+ | : | ¨ |
+ , | ¸ |
+ E ` | È |
+ O / | Ø |
+ ` e | è |
+ o / | ø
+ |
+ | c | © |
+ 1 | ¹ |
+ ' E | É |
+ ` U | Ù |
+ ' e | é |
+ ` u | ù
+ |
+ | a | ª |
+ o | º |
+ ^ E | Ê |
+ ' U | Ú |
+ ^ e | ê |
+ ' u | ú
+ |
+ | < < | « |
+ > > | » |
+ : E | Ë |
+ ^ U | Û |
+ : e | ë |
+ ^ u | û
+ |
+ | ~ | ¬ |
+ 1 4 | ¼ |
+ ` I | Ì |
+ : U | Ü |
+ ` i | ì |
+ : u | ü
+ |
+ | - | |
+ 1 2 | ½ |
+ ' I | Í |
+ ' Y | Ý |
+ ' i | í |
+ ' y | ý
+ |
+ | r | ® |
+ 3 4 | ¾ |
+ ^ I | Î |
+ T H | Þ |
+ ^ i | î |
+ t h | þ
+ |
+ | _ | ¯ |
+ ? | ¿ |
+ : I | Ï |
+ s s | ß |
+ : i | ï |
+ : y | ÿ
+ |
-Fl_Bitmap(const char *bits, int W, int H)
-
Fl_Bitmap(const uchar *bits, int W, int H)
-Construct using an X bitmap. The bits pointer is simply copied to the
-object, so it must point at persistent storage. The two constructors
-are provided because various X implementations disagree about the type
-of bitmap data. To use an XBM file use:
+Methods
+
+
+
-#include "foo.xbm"
-...
-Fl_Bitmap bitmap = new Fl_Bitmap(foo_bits, foo_width, foo_height);
-
+Fl_Input
+~Fl_Input
+cursor_color
-~Fl_Bitmap()
- The destructor will destroy any X pixmap created. It does not do
-anything to the bits data.
-void draw(int x, int y, int w, int h, int ox = 0, int oy = 0)
-1 bits are drawn with the current color, 0 bits
-are unchanged.
-The image is clipped to the destination rectangle: the area
-ox,oy,w,h is copied to x,y,w,h.
-void draw(int x, int y)
-Draws the bitmap with the upper-left corner at x,y. This is
-the same as doing draw(x,y,this->w,this->h,0,0).
-
-
-
-This object encapsulates the data from an XPM image, and allows you to
-make an Fl_Widget use a pixmap as a label, or to just draw
-the pixmap directly.
-
-Fl_Pixmap(char *const* data)
- Construct using XPM data. The data pointer is simply copied to the
-object, so it must point at persistent storage. To use an XPM file do:
+ |
-#include <fltk/Fl_Pixmap.h>
-#include "foo.xpm"
-...
-Fl_Pixmap pixmap = new Fl_Pixmap(foo);
-
+index
+size
+
+ |
+
+ |
+
+ |
+
+ |
+
+
+
+ Creates a new Fl_Input widget using the given position, size,
+and label string. The default boxtype is FL_DOWN_BOX.
+
+ Destroys the widget and any value associated with it.
+
+ The first form returns the current value, which is a pointer to the
+internal buffer and is valid only until the next event is handled.
+The second two forms change the text and set the mark and the point
+to the end of it. The string is copied to the internal buffer. Passing
+NULL is the same as "". This returns non-zero if the new value is
+different than the current one. You can use the second version to
+directly set the length if you know it already or want to put nul's in
+the text.
+
+ Change the text and set the mark and the point to the end of it. The
+string is not copied. If the user edits the string it is copied
+to the internal buffer then. This can save a great deal of time and
+memory if your program is rapidly changing the values of text fields,
+but this will only work if the passed string remains unchanged until
+either the Fl_Input is destroyed or value() is called
+again.
+
+ Returns the number of characters in value(). This may be
+greater than strlen(value()) if there are nul characters in
+it.
+
+ Same as value()[n], but may be faster in plausible
+implementations. No bounds checking is done.
+
+ Controls when callbacks are done. The following values are useful,
+the default value is FL_WHEN_RELEASE:
+
+- 0: The callback is not done, but changed() is
+ turned on.
+- FL_WHEN_CHANGED: The callback is done each time the text
+is changed by the user.
+- FL_WHEN_RELEASE: The callback will be done when this
+widget loses the focus, including when the window is unmapped. This
+is a useful value for text fields in a panel where doing the callback
+on every change is wasteful. However the callback will also happen if
+the mouse is moved out of the window, which means it should not do
+anything visible (like pop up an error message). You might do better
+setting this to zero, and scanning all the items for changed()
+ when the OK button on a panel is pressed.
+- FL_WHEN_ENTER_KEY: If the user types the Enter key, the
+entire text is selected, and the callback is done if the text has
+changed. Normally the Enter key will navigate to the next field (or
+insert a newline for a Fl_Mulitline_Input), this changes the
+behavior.
+- FL_WHEN_ENTER_KEY|FL_WHEN_NOT_CHANGED: The Enter key will
+do the callback even if the text has not changed. Useful for command
+fields.
-~Fl_Pixmap()
- The destructor will destroy any X pixmap created. It does not do
-anything to the data.
-
-void draw(int x, int y, int w, int h, int ox = 0, int oy = 0)
-The image is clipped to the destination rectangle: the area
-ox,oy,w,h is copied to x,y,w,h. The current
-implementation converts the pixmap to 24-bit RGB data and uses fl_draw_image() to draw it. Thus you
-will get dithered colors on an 8 bit screen.
-
-void draw(int x, int y)
- Draws the image with the upper-left corner at x,y. This is
-the same as doing draw(x,y,this->w,this->h,0,0).
-
-
-
-This object encapsulates a full-color RGB image, and allows you to
-make an Fl_Widget use an image as a label, or to just draw the
-image directly.
-
-Fl_RGB_Image(const uchar *data, int W, int H, int D = 3, int LD = 0)
- Construct using a pointer to RGB data. W and H are
-the size of the image in pixels. D is the delta between pixels
-(it may be more than 3 to skip alpha or other data, or negative to flip
-the image left/right). LD is the delta between lines (it may
-be more than D * W to crop images, or negative to flip the
-image vertically). The data pointer is simply copied to the object, so
-it must point at persistent storage.
-~Fl_RGB_Image()
- The destructor will destroy any X pixmap created. It does not do
-anything to the data.
-void draw(int x, int y, int w, int h, int ox = 0, int oy = 0)
-The image is clipped to the destination rectangle: the area
-ox,oy,w,h is copied to x,y,w,h.
-void draw(int x, int y)
- Draws the image with the upper-left corner at x,y. This is
-the same as doing draw(x,y,this->w,this->h,0,0).
-
-
+
+ Gets or sets the color of the text in the input field.
+
+ Gets or sets the font of the text in the input field.
+
+ Gets or sets the size of the text in the input field.
+
+ Get or set the color of the cursor. This is black by default.
+