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_Image.html | 438 ++++++++++++++++++++++++++++++++------------ 1 file changed, 316 insertions(+), 122 deletions(-) (limited to 'documentation/Fl_Image.html') 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 Fl_Input

+
+

Class Hierarchy

+ +

Include Files

+ +

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);

+ -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. + -

int w,h

+ -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. + + + + + + + + + + + + + + + + -

virtual void Fl_Image::measure(int W, int H);

+
Mouse button 1Moves 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. +
Mouse button 2Insert 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. +
Mouse button 3Currently acts like button 1.
BackspaceDeletes one character to the left, or +deletes the selected region.
EnterMay cause the callback, see when().
^A or HomeGo to start of line.
^B or LeftMove left
^CCopy the selection to the clipboard
^D or DeleteDeletes one character to the right +or deletes the selected region.
^E or EndGo to the end of line.
^F or RightMove right
^KDelete to the end of line (next \n character) +or deletes a single \n character. These deletions are all concatenated +into the clipboard.
^N or DownMove down (for Fl_Multiline_Input +only, otherwise it moves to the next input field).
^P or UpMove up (for Fl_Multiline_Input only, +otherwise it moves to the previous input field).
^UDelete everything.
^V or ^YPaste the clipboard
^X or ^WCopy 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+moveMove the cursor but also extend the +selection.
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. + +
+ + + + + + + + -

class Fl_Bitmap : public Fl_Image

- 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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Character Composition Table
KeysCharKeysCharKeysCharKeysCharKeysCharKeysChar
spnbsp*°` 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õ +
|¦pA 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

+
+ + +
-

~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). - -

class Fl_Pixmap : public Fl_Image

- -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
    • +
+		 + + + + + +
+
+

Fl_Input::Fl_Input(int x, int y, int w, +int h, const char *label = 0)

+ Creates a new Fl_Input widget using the given position, size, +and label string. The default boxtype is FL_DOWN_BOX. +

virtual Fl_Input::~Fl_Input()

+ Destroys the widget and any value associated with it. +

const char *Fl_Input::value() const +
int Fl_Input::value(const char*) +
int Fl_Input::value(const char*, int)

+ 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.

+

int Fl_Input::static_value(const +char*) +
int Fl_Input::static_value(const char*, int)

+ 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. +

int Fl_Input::size() const

+ Returns the number of characters in value(). This may be +greater than strlen(value()) if there are nul characters in +it. +

char Fl_Input::index(int) const

+ Same as value()[n], but may be faster in plausible +implementations. No bounds checking is done. +

Fl_When Fl_Widget::when() const +
void Fl_Widget::when(Fl_When)

+ Controls when callbacks are done. The following values are useful, +the default value is FL_WHEN_RELEASE: + -

~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). - -

class Fl_RGB_Image

- -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). - - +

Fl_Color Fl_Input::textcolor() const +
void Fl_Input::textcolor(Fl_Color)

+ Gets or sets the color of the text in the input field. +

Fl_Font Fl_Input::textfont() const +
void Fl_Input::textfont(Fl_Font)

+ Gets or sets the font of the text in the input field. +

uchar Fl_Input::textsize() const +
void Fl_Input::textsize(uchar)

+ Gets or sets the size of the text in the input field. +

Fl_Color Fl_Input::cursor_color() +const +
void Fl_Input::cursor_color(Fl_Color)

+ Get or set the color of the cursor. This is black by default. + -- cgit v1.2.3