From c975ec6dca1f1f48404d82643f2f250faee6c1bd Mon Sep 17 00:00:00 2001 From: Albrecht Schlosser Date: Mon, 15 Sep 2008 16:42:50 +0000 Subject: fixed broken links by adding double quotes, where appropriate. This may be a doxygen bug, but I fixed it anyway. \todo fix other links without double quotes or fix doxygen, if this is a doxygen bug. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6256 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/subclassing.dox | 70 +++++++++++++++++++++---------------------- 1 file changed, 35 insertions(+), 35 deletions(-) (limited to 'documentation') diff --git a/documentation/subclassing.dox b/documentation/subclassing.dox index cb4763be2..64d2e10ce 100644 --- a/documentation/subclassing.dox +++ b/documentation/subclassing.dox @@ -60,17 +60,17 @@ deimage(0);

Protected Methods of Fl_Widget

The following methods are provided for subclasses to use: -

void Fl_Widget::damage(uchar mask) +

void Fl_Widget::damage(uchar mask)
void Fl_Widget::damage(uchar mask, int x, int y, int w, int h)
uchar Fl_Widget::damage()

The first form indicates that a partial update of the object is @@ -108,7 +108,7 @@ MyClass::draw() { if (damage() & (FL_DAMAGE_ALL | 4)) draw_part3(); } -

void Fl_Widget::draw_box() const +

void Fl_Widget::draw_box() const
void Fl_Widget::draw_box(Fl_Boxtype b, ulong c) const

The first form draws this widget's box(), using the dimensions of the widget. The second form uses b as the box @@ -120,7 +120,7 @@ type and c as the color for the box.

Draws a focus box inside the widgets bounding box. The second form allows you to specify a different bounding box. -

void Fl_Widget::draw_label() const +

void Fl_Widget::draw_label() const
void Fl_Widget::draw_label(int x, int y, int w, int h) const
void Fl_Widget::draw_label(int x, int y, int w, int h, Fl_Align align) const

@@ -135,15 +135,15 @@ feature, like a moving slider.

FL_ALIGN_INSIDE has been forced on so the label will appear inside the passed bounding box. This is designed for parent groups to draw labels with.

-

void Fl_Widget::set_flag(SHORTCUT_LABEL)

+

void Fl_Widget::set_flag(SHORTCUT_LABEL)

Modifies draw_label() so that '&' characters cause an underscore to be printed under the next letter. -

void Fl_Widget::set_visible() -
void Fl_Widget::clear_visible()

+

void Fl_Widget::set_visible() +
void Fl_Widget::clear_visible()

Fast inline versions of Fl_Widget::hide() and Fl_Widget::show(). These do not send the FL_HIDE and FL_SHOW events to the widget. -

int Fl_Widget::test_shortcut() const +

int Fl_Widget::test_shortcut() const
static int Fl_Widget::test_shortcut(const char *s)

The first version tests Fl_Widget::label() against the current event (which should be a FL_SHORTCUT event). If the @@ -153,7 +153,7 @@ flag is off, if the label is NULL or does not have a '&' character in it, or if the keypress does not match the character.

The second version lets you do this test against an arbitrary string.

-

uchar Fl_Widget::type() const +

uchar Fl_Widget::type() const
void Fl_Widget::type(uchar t)

The property Fl_Widget::type() can return an arbitrary 8-bit identifier, and can be set with the protected method type(uchar t) @@ -175,19 +175,19 @@ range 1 to 7).

to handle each event passed to the widget. It can: Events are identified by the integer argument. Other information about the most recent event is stored in static locations and aquired -by calling the Fl::event_*() +by calling the Fl::event_*() functions. This information remains valid until another event is handled.

Here is a sample handle() method for a widget that acts as @@ -249,12 +249,12 @@ the parts whose bits are set. FLTK will turn on the be redrawn, e.g. for an expose event.

Expose events (and the above damage(b,x,y,w,h)) will cause -draw() to be called with FLTK's +draw() to be called with FLTK's clipping turned on. You can greatly speed up redrawing in some cases by testing fl_not_clipped(x,y,w,h) or fl_clip_box(...) and skipping invisible parts.

Besides the protected methods described above, FLTK provides a large -number of basic drawing functions, which are described +number of basic drawing functions, which are described below.

Resizing the Widget

The resize(int x, int y, int w, int h) method is called when @@ -264,12 +264,12 @@ and h() still remain the old size. You must call resize() on your base class with the same arguments to get the widget size to actually change.

This should not call redraw(), at least if only the -x() and y() change. This is because composite widgets like +x() and y() change. This is because composite widgets like Fl_Scroll may have a more efficient way of drawing the new position.

Making a Composite Widget

A "composite" widget contains one or more "child" widgets. - To make a composite widget you should subclass Fl_Group + To make a composite widget you should subclass Fl_Group . It is possible to make a composite object that is not a subclass of Fl_Group, but you'll have to duplicate the code in Fl_Group anyways. @@ -284,7 +284,7 @@ class MyClass : public Fl_Group { The constructor has to initialize these instances. They are automatically add()ed to the group, since the Fl_Group constructor does begin(). Don't forget to call end() - or use the Fl_End pseudo-class: + or use the Fl_End pseudo-class: -It may be possible to cut/paste non-text data by using +It may be possible to cut/paste non-text data by using Fl::add_handler().

Drag And Drop Support

-- cgit v1.2.3