Fixed typos and doxygen documentation.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6582 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Albrecht Schlosser 2008-12-13 18:31:54 +00:00
parent d9801ae479
commit 6ed54124bb
22 changed files with 599 additions and 530 deletions

View File

@ -101,57 +101,64 @@ class Fl_Menu_;
{0}};
\endcode
produces:
<P ALIGN=CENTER>\image html menu.gif </P>
\image html menu.gif
\image latex menu.eps "menu" width=10cm
A submenu title is identified by the bit FL_SUBMENU in the
flags field, and ends with a label() that is NULL.
You can nest menus to any depth. A pointer to the first item in the
submenu can be treated as an Fl_Menu array itself. It is also
possible to make seperate submenu arrays with FL_SUBMENU_POINTER
flags.
<P>You should use the method functions to access structure members and
possible to make separate submenu arrays with FL_SUBMENU_POINTER flags.
You should use the method functions to access structure members and
not access them directly to avoid compatibility problems with future
releases of FLTK.
*/
struct FL_EXPORT Fl_Menu_Item {
const char *text; ///< menu item text, returned by label()
int shortcut_; ///< menu item shortcut
Fl_Callback *callback_; ///< menu item callback
void *user_data_; ///< menu item user_data for 3rd party apps
int flags; ///< menu item flags like FL_MENU_TOGGLE,FL_MENU_RADIO
uchar labeltype_; ///< how the menu item text looks like
Fl_Font labelfont_; ///< which font for this menu item text
Fl_Fontsize labelsize_; ///< size of menu item text
unsigned labelcolor_; ///< menu item text color
int shortcut_; ///< menu item shortcut
Fl_Callback *callback_; ///< menu item callback
void *user_data_; ///< menu item user_data for 3rd party apps
int flags; ///< menu item flags like FL_MENU_TOGGLE, FL_MENU_RADIO
uchar labeltype_; ///< how the menu item text looks like
Fl_Font labelfont_; ///< which font for this menu item text
Fl_Fontsize labelsize_; ///< size of menu item text
unsigned labelcolor_; ///< menu item text color
// advance N items, skipping submenus:
const Fl_Menu_Item *next(int=1) const;
/**
Advance a pointer by n items through a menu array, skipping
the contents of submenus and invisible items. There are two calls so
Advances a pointer by n items through a menu array, skipping
the contents of submenus and invisible items. There are two calls so
that you can advance through const and non-const data.
*/
Fl_Menu_Item *next(int i=1) {
return (Fl_Menu_Item*)(((const Fl_Menu_Item*)this)->next(i));}
/** Returns the first menu item, same as next(0). */
const Fl_Menu_Item *first() const { return next(0); }
/** Returns the first menu item, same as next(0). */
Fl_Menu_Item *first() { return next(0); }
// methods on menu items:
/**
This is the title of the item. A NULL here indicates the end
of the menu (or of a submenu). A '&' in the item will print an
underscore under the next letter, and if the menu is popped up that
letter will be a "shortcut" to pick that item. To get a
real '&' put two
in a row.
Returns the title of the item.
A NULL here indicates the end of the menu (or of a submenu).
A '&' in the item will print an underscore under the next letter,
and if the menu is popped up that letter will be a "shortcut" to pick
that item. To get a real '&' put two in a row.
*/
const char* label() const {return text;}
/** See const char* Fl_Menu_Item::label() const */
void label(const char* a) {text=a;}
/** See const char* Fl_Menu_Item::label() const */
void label(Fl_Labeltype a,const char* b) {labeltype_ = a; text = b;}
/**
A labeltype identifies a routine that draws the label of the
widget. This can be used for special effects such as emboss, or to use
@ -159,6 +166,7 @@ struct FL_EXPORT Fl_Menu_Item {
The value FL_NORMAL_LABEL prints the label as text.
*/
Fl_Labeltype labeltype() const {return (Fl_Labeltype)labeltype_;}
/**
A labeltype identifies a routine that draws the label of the
widget. This can be used for special effects such as emboss, or to use
@ -166,6 +174,7 @@ struct FL_EXPORT Fl_Menu_Item {
The value FL_NORMAL_LABEL prints the label as text.
*/
void labeltype(Fl_Labeltype a) {labeltype_ = a;}
/**
This color is passed to the labeltype routine, and is typically the
color of the label text. This defaults to FL_BLACK. If this
@ -173,43 +182,49 @@ struct FL_EXPORT Fl_Menu_Item {
the menu - this is so that images put in the menu draw correctly.
*/
Fl_Color labelcolor() const {return (Fl_Color)labelcolor_;}
/** See Fl_Color Fl_Menu_Item::labelcolor() const */
void labelcolor(unsigned a) {labelcolor_ = a;}
/**
Fonts are identified by small 8-bit indexes into a table. See the
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
Fl::set_font() can define new fonts.
Helvetica font. The function Fl::set_font() can define new fonts.
*/
Fl_Font labelfont() const {return labelfont_;}
/**
Fonts are identified by small 8-bit indexes into a table. See the
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
Fl::set_font() can define new fonts.
Helvetica font. The function Fl::set_font() can define new fonts.
*/
void labelfont(Fl_Font a) {labelfont_ = a;}
/** Gets or sets the label font pixel size/height. */
/** Gets the label font pixel size/height.*/
Fl_Fontsize labelsize() const {return labelsize_;}
/** Sets the label font pixel size/height.*/
void labelsize(Fl_Fontsize a) {labelsize_ = a;}
/**
Each item has space for a callback function and an argument for that
function. Due to back compatibility, the Fl_Menu_Item itself
function. Due to back compatibility, the Fl_Menu_Item itself
is not passed to the callback, instead you have to get it by calling
((Fl_Menu_*)w)-&gt;mvalue() where w is the widget argument.
((Fl_Menu_*)w)->mvalue() where w is the widget argument.
*/
Fl_Callback_p callback() const {return callback_;}
/** See Fl_Callback_p Fl_MenuItem::callback() const */
void callback(Fl_Callback* c, void* p) {callback_=c; user_data_=p;}
/** See Fl_Callback_p Fl_MenuItem::callback() const */
void callback(Fl_Callback* c) {callback_=c;}
/** See Fl_Callback_p Fl_MenuItem::callback() const */
void callback(Fl_Callback0*c) {callback_=(Fl_Callback*)c;}
/** See Fl_Callback_p Fl_MenuItem::callback() const */
void callback(Fl_Callback1*c, long p=0) {callback_=(Fl_Callback*)c; user_data_=(void*)p;}
/**
Get or set the user_data argument that is sent to the
callback function.
@ -234,21 +249,24 @@ struct FL_EXPORT Fl_Menu_Item {
portable to some machines.
*/
void argument(long v) {user_data_ = (void*)v;}
/** Gets what key combination shortcut will trigger the menu item. */
int shortcut() const {return shortcut_;}
/**
Sets exactly what key combination will trigger the menu item. The
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.
<P>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. </P>
<P>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"
setting).
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 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" setting).
*/
void shortcut(int s) {shortcut_ = s;}
/**
@ -261,8 +279,7 @@ struct FL_EXPORT Fl_Menu_Item {
int submenu() const {return flags&(FL_SUBMENU|FL_SUBMENU_POINTER);}
/**
Returns true if a checkbox will be drawn next to this item. This is
true if FL_MENU_TOGGLE or FL_MENU_RADIO is set in the
flags.
true if FL_MENU_TOGGLE or FL_MENU_RADIO is set in the flags.
*/
int checkbox() const {return flags&FL_MENU_TOGGLE;}
/**
@ -272,26 +289,32 @@ struct FL_EXPORT Fl_Menu_Item {
item with FL_MENU_DIVIDER turned on.
*/
int radio() const {return flags&FL_MENU_RADIO;}
/** Returns the current value of the check or radio item. */
/** Returns the current value of the check or radio item. */
int value() const {return flags&FL_MENU_VALUE;}
/**
Turns the check or radio item "on" for the menu item. Note that this
does not turn off any adjacent radio items like set_only()
does.
does not turn off any adjacent radio items like set_only() does.
*/
void set() {flags |= FL_MENU_VALUE;}
/** Turns the check or radio item "off" for the menu item. */
/** Turns the check or radio item "off" for the menu item. */
void clear() {flags &= ~FL_MENU_VALUE;}
void setonly();
/** Gets the visibility of an item. */
/** Gets the visibility of an item. */
int visible() const {return !(flags&FL_MENU_INVISIBLE);}
/** Makes an item visible in the menu. */
/** Makes an item visible in the menu. */
void show() {flags &= ~FL_MENU_INVISIBLE;}
/** Hides an item in the menu. */
/** Hides an item in the menu. */
void hide() {flags |= FL_MENU_INVISIBLE;}
/** Get whether or not the item can be picked. */
/** Gets whether or not the item can be picked. */
int active() const {return !(flags&FL_MENU_INACTIVE);}
/** Allows a menu item to be picked. */
/** Allows a menu item to be picked. */
void activate() {flags &= ~FL_MENU_INACTIVE;}
/**
Prevents a menu item from being picked. Note that this will also cause
@ -302,8 +325,10 @@ struct FL_EXPORT Fl_Menu_Item {
int activevisible() const {return !(flags & (FL_MENU_INACTIVE|FL_MENU_INVISIBLE));}
// compatibility for FLUID so it can set the image of a menu item...
/** compatibility api for FLUID, same as a->label(this) */
void image(Fl_Image* a) {a->label(this);}
/** compatibility api for FLUID, same as a.label(this) */
void image(Fl_Image& a) {a.label(this);}
@ -327,39 +352,47 @@ struct FL_EXPORT Fl_Menu_Item {
const Fl_Menu_Item* find_shortcut(int *ip=0) const;
/**
Call the Fl_Menu_Item item's callback, and provide the
Fl_Widget argument (and optionally override the user_data()
argument). You must first check that callback() is non-zero
Calls the Fl_Menu_Item item's callback, and provides the
Fl_Widget argument (and optionally overrides the user_data()
argument). You must first check that callback() is non-zero
before calling this.
*/
void do_callback(Fl_Widget* o) const {callback_(o, user_data_);}
/**
Call the Fl_Menu_Item item's callback, and provide the
Fl_Widget argument (and optionally override the user_data()
argument). You must first check that callback() is non-zero
Calls the Fl_Menu_Item item's callback, and provides the
Fl_Widget argument (and optionally overrides the user_data()
argument). You must first check that callback() is non-zero
before calling this.
*/
void do_callback(Fl_Widget* o,void* arg) const {callback_(o, arg);}
/**
Call the Fl_Menu_Item item's callback, and provide the
Fl_Widget argument (and optionally override the user_data()
Calls the Fl_Menu_Item item's callback, and provides the
Fl_Widget argument (and optionally overrides the user_data()
argument). You must first check that callback() is non-zero
before calling this.
*/
void do_callback(Fl_Widget* o,long arg) const {callback_(o, (void*)arg);}
// back-compatibility, do not use:
/** back compatibility only \deprecated. */
int checked() const {return flags&FL_MENU_VALUE;}
/** back compatibility only \deprecated. */
void check() {flags |= FL_MENU_VALUE;}
/** back compatibility only \deprecated. */
void uncheck() {flags &= ~FL_MENU_VALUE;}
int add(const char*, int shortcut, Fl_Callback*, void* =0, int = 0);
/** See int add(const char*, int shortcut, Fl_Callback*, void*, int) */
int add(const char*a, const char* b, Fl_Callback* c,
void* d = 0, int e = 0) {
return add(a,fl_old_shortcut(b),c,d,e);}
int size() const ;
};

View File

@ -38,24 +38,23 @@
interface that allows you to put lots and lots of buttons and
switches in a panel, as popularized by many toolkits.
<P ALIGN=CENTER>\image html tabs.gif </P>
\image latex tabs.eps "Fl_Tabs" width=8cm
\image html tabs.gif
\image latex tabs.eps "Fl_Tabs" width=8cm
<P>Clicking the tab makes a child visible() by calling
Clicking the tab makes a child visible() by calling
show() on it, and all other children are made invisible
by calling hide() on them. Usually the children are Fl_Group widgets
containing several widgets themselves.
<P>Each child makes a card, and it's label() is printed
Each child makes a card, and its label() is printed
on the card tab, including the label font and style. The
selection color of that child is used to color the tab, while
the color of the child determines the background color of the
pane.
the color of the child determines the background color of the pane.
<P>The size of the tabs is controlled by the bounding box of the
The size of the tabs is controlled by the bounding box of the
children (there should be some space between the children and
the edge of the Fl_Tabs), and the tabs may be placed
"inverted" on the bottom, this is determined by which
"inverted" on the bottom - this is determined by which
gap is larger. It is easiest to lay this out in fluid, using the
fluid browser to select each child group and resize them until
the tabs look the way you want them to.

File diff suppressed because it is too large Load Diff

View File

@ -34,12 +34,11 @@
// I modified this from the original Forms data to use a linked list
// so that the number of items in the browser and size of those items
// is unlimited. The only problem is that the old browser used an
// is unlimited. The only problem is that the old browser used an
// index number to identify a line, and it is slow to convert from/to
// a pointer. I use a cache of the last match to try to speed this
// up.
// a pointer. I use a cache of the last match to try to speed this up.
// Also added the ability to "hide" a line. This set's it's height to
// Also added the ability to "hide" a line. This sets its height to
// zero, so the Fl_Browser_ cannot pick it.
#define SELECTED 1
@ -69,7 +68,7 @@ void Fl_Browser::item_select(void* l, int v) {
}
/**
Return entry for line number \p line.
Return entry for line number \a line.
*/
FL_BLINE* Fl_Browser::find_line(int line) const {
int n; FL_BLINE* l;
@ -89,7 +88,7 @@ FL_BLINE* Fl_Browser::find_line(int line) const {
}
/**
Returns line number corresponding to data \p v,
Returns line number corresponding to data \a v,
zero if not found.
*/
int Fl_Browser::lineno(void* v) const {
@ -141,7 +140,7 @@ FL_BLINE* Fl_Browser::_remove(int line) {
}
/**
Remove line n and make the browser one line shorter.
Remove line \a line and make the browser one line shorter.
*/
void Fl_Browser::remove(int line) {
if (line < 1 || line > lines) return;
@ -149,8 +148,8 @@ void Fl_Browser::remove(int line) {
}
/**
Insert a new line \p t \e before line \p n. If \p n &gt;
size() then the line is added to the end.
Insert a new line \a t \e before line \a n.
If \a n > size() then the line is added to the end.
*/
void Fl_Browser::insert(int line, FL_BLINE* t) {
if (!first) {
@ -184,7 +183,7 @@ void Fl_Browser::insert(int line, FL_BLINE* t) {
/**
Insert a new entry \e before given line.
\param[in] line if \p line > size(), the entry will be added at the end.
\param[in] line if \a line > size(), the entry will be added at the end.
\param[in] newtext text entry for the new line.
\param[in] d pointer to data associated with the new line.
*/
@ -199,7 +198,7 @@ void Fl_Browser::insert(int line, const char* newtext, void* d) {
}
/**
Line from is removed and reinserted at to; to
Line \a from is removed and reinserted at \a to; \a to
is calculated after the line is removed.
*/
void Fl_Browser::move(int to, int from) {
@ -208,8 +207,8 @@ void Fl_Browser::move(int to, int from) {
}
/**
Sets the text for line \p line to text \p newtext.
Does nothing if \p line is out of range.
Sets the text for line \a line to text \a newtext.
Does nothing if \a line is out of range.
*/
void Fl_Browser::text(int line, const char* newtext) {
if (line < 1 || line > lines) return;
@ -234,8 +233,8 @@ void Fl_Browser::text(int line, const char* newtext) {
}
/**
Sets the data for line \p n to \p d.
Does nothing if \n is out of range.
Sets the data for line \a line to \a d.
Does nothing if \a line is out of range.
*/
void Fl_Browser::data(int line, void* d) {
if (line < 1 || line > lines) return;
@ -300,7 +299,7 @@ int Fl_Browser::item_width(void* v) const {
const int* i = column_widths();
int ww = 0;
while (*i) { // add up all tab-seperated fields
while (*i) { // add up all tab-separated fields
char* e;
e = strchr(str, column_char());
if (!e) break; // last one occupied by text
@ -357,7 +356,7 @@ void Fl_Browser::item_draw(void* v, int X, int Y, int W, int H) const {
char* str = ((FL_BLINE*)v)->txt;
const int* i = column_widths();
while (W > 6) { // do each tab-seperated field
while (W > 6) { // do each tab-separated field
int w1 = W; // width for this field
char* e = 0; // pointer to end of field or null if none
if (*i) { // find end of field and temporarily replace with 0
@ -423,7 +422,7 @@ void Fl_Browser::item_draw(void* v, int X, int Y, int W, int H) const {
fl_color(lcol);
fl_draw(str, X+3, Y, w1-6, H, e ? Fl_Align(talign|FL_ALIGN_CLIP) : talign, 0, 0);
if (!e) break; // no more fields...
*e = column_char(); // put the seperator back
*e = column_char(); // put the separator back
X += w1;
W -= w1;
str = e+1;
@ -437,7 +436,7 @@ static const int no_columns[1] = {0};
\param[in] X,Y,W,H position and size.
\param[in] L label string, may be NULL.
*/
Fl_Browser::Fl_Browser(int X, int Y, int W, int H, const char*L)
Fl_Browser::Fl_Browser(int X, int Y, int W, int H, const char *L)
: Fl_Browser_(X, Y, W, H, L) {
column_widths_ = no_columns;
lines = 0;
@ -449,7 +448,7 @@ Fl_Browser::Fl_Browser(int X, int Y, int W, int H, const char*L)
}
/**
Update browser so that line is shown at given position.
Updates the browser so that \a line is shown at position \pos.
\param[in] line line number.
\param[in] pos position.
*/
@ -486,7 +485,7 @@ int Fl_Browser::topline() const {
}
/**
Remove all the lines in the browser.
Removes all the lines in the browser.
*/
void Fl_Browser::clear() {
for (FL_BLINE* l = first; l;) {
@ -501,9 +500,9 @@ void Fl_Browser::clear() {
}
/**
Add a new line to the end of the browser. The text is copied using
Adds a new line to the end of the browser. The text is copied using
the strdup() function. It may also be NULL to make a
blank line. The void * argument is returned as the data()
blank line. The void * argument \a d is returned as the data()
of the new item.
*/
void Fl_Browser::add(const char* newtext, void* d) {
@ -520,7 +519,7 @@ const char* Fl_Browser::text(int line) const {
}
/**
Returns the data for line \p n, or NULL is \p n is out of range.
Returns the data for line \p line, or NULL if \p line is out of range.
*/
void* Fl_Browser::data(int line) const {
if (line < 1 || line > lines) return 0;
@ -528,7 +527,7 @@ void* Fl_Browser::data(int line) const {
}
/**
Sets the selection state of entry.
Sets the selection state of entry \a line.
\param[in] line line number.
\param[in] v new selection state.
\returns 1 if the state changed, 0 if not.
@ -538,13 +537,13 @@ int Fl_Browser::select(int line, int v) {
return Fl_Browser_::select(find_line(line), v);
}
/** Return 1 if line n is selected, 0 if it not selected.*/
/** Returns 1 if line \a line is selected, 0 if it is not selected.*/
int Fl_Browser::selected(int line) const {
if (line < 1 || line > lines) return 0;
return find_line(line)->flags & SELECTED;
}
/** Makes line n visible for selection.*/
/** Makes line \a line visible for selection. */
void Fl_Browser::show(int line) {
FL_BLINE* t = find_line(line);
if (t->flags & NOTDISPLAYED) {
@ -555,7 +554,7 @@ void Fl_Browser::show(int line) {
}
/**
Makes line n invisible, preventing selection by the user.
Makes line \a line invisible, preventing selection by the user.
The line can still be selected under program control.
*/
void Fl_Browser::hide(int line) {
@ -569,6 +568,9 @@ void Fl_Browser::hide(int line) {
/**
For back compatibility.
This calls show(line) if \a v is true, and hide(line) otherwise.
\see show(int line), hide(int line)
*/
void Fl_Browser::display(int line, int v) {
if (line < 1 || line > lines) return;
@ -576,7 +578,7 @@ void Fl_Browser::display(int line, int v) {
}
/**
Returns a non-zero value if line is visible.
Returns a non-zero value if line \a line is visible.
*/
int Fl_Browser::visible(int line) const {
if (line < 1 || line > lines) return 0;
@ -584,7 +586,7 @@ int Fl_Browser::visible(int line) const {
}
/**
Gets browser value.
Gets the browser's value.
\returns line number of current selection, or 0 if no selection.
*/
int Fl_Browser::value() const {

View File

@ -43,7 +43,7 @@ void Fl_Gl_Window::make_overlay() {overlay = this;}
#else
// Methods on Fl_Gl_Window that create an overlay window. Because
// many programs don't need the overlay, this is seperated into this
// many programs don't need the overlay, this is separated into this
// source file so it is not linked in if not used.
// Under X this is done by creating another window, of class _Fl_Gl_Overlay

View File

@ -336,7 +336,7 @@ void Fl_Gl_Window::flush() {
if (overlay == this) {
// don't draw if only the overlay is damaged:
if (damage1_ || damage() != FL_DAMAGE_OVERLAY || !save_valid) draw();
// we use a seperate context for the copy because rasterpos must be 0
// we use a separate context for the copy because rasterpos must be 0
// and depth test needs to be off:
static GLContext ortho_context = 0;
static Fl_Gl_Window* ortho_window = 0;

View File

@ -273,7 +273,7 @@ int Fl_Menu_::add(const char *t, int s, Fl_Callback *c,void *v,int f) {
/**
This is a Forms (and SGI GL library) compatible add function, it
adds many menu items, with '|' seperating the menu items, and tab
adds many menu items, with '|' separating the menu items, and tab
separating the menu item names from an optional shortcut string.
The passed string is split at any '|' characters and then

View File

@ -107,7 +107,7 @@ Fl_Preferences::Fl_Preferences( const char *path, const char *vendor, const char
Use the \a group argument to name the group that you would like to access.
\a Group can also contain a path to a group further down the hierarchy by
seperating group names with a forward slash '/'.
separating group names with a forward slash '/'.
\param[in] parent reference object for the new group
\param[in] group name of the group to access (may contain '/'s)

View File

@ -29,7 +29,7 @@
// This is the "file card tabs" interface to allow you to put lots and lots
// of buttons and switches in a panel, as popularized by many toolkits.
// Each child widget is a card, and it's label() is printed on the card tab.
// Each child widget is a card, and its label() is printed on the card tab.
// Clicking the tab makes that card visible.
#include <stdio.h>
@ -43,7 +43,7 @@
// return the left edges of each tab (plus a fake left edge for a tab
// past the right-hand one). These position are actually of the left
// edge of the slope. They are either seperated by the correct distance
// edge of the slope. They are either separated by the correct distance
// or by EXTRASPACE or by zero.
// Return value is the index of the selected item.
@ -411,7 +411,7 @@ void Fl_Tabs::draw_tab(int x1, int x2, int W, int H, Fl_Widget* o, int what) {
<P>The destructor <I>also deletes all the children</I>. This
allows a whole tree to be deleted at once, without having to
keep a pointer to all the children in the user code. A kludge
has been done so the Fl_Tabs and all of it's children
has been done so the Fl_Tabs and all of its children
can be automatic (local) variables, but you must declare the
Fl_Tabs widget <I>first</I> so that it is destroyed last.
*/

View File

@ -64,8 +64,8 @@ void Fl_Widget::default_callback(Fl_Widget *o, void * /*v*/) {
}
/**
All Fl_Widgets that don't have a callback defined use a
default callback that puts a pointer to the widget in this queue, and
this method reads the oldest widget out of this queue.
default callback that puts a pointer to the widget in this queue,
and this method reads the oldest widget out of this queue.
*/
Fl_Widget *Fl::readqueue() {
if (obj_tail==obj_head) return 0;
@ -80,7 +80,7 @@ int Fl_Widget::handle(int) {
return 0;
}
/** default font size for widgets */
/** Default font size for widgets */
Fl_Fontsize FL_NORMAL_SIZE = 14;
Fl_Widget::Fl_Widget(int X, int Y, int W, int H, const char* L) {
@ -147,7 +147,7 @@ Fl_Widget::~Fl_Widget() {
fl_throw_focus(this);
}
/** Draws a focus box for the widget at position X,Y and SIZE W,H . */
/** Draws a focus box for the widget at position X,Y with size W,H. */
void
Fl_Widget::draw_focus(Fl_Boxtype B, int X, int Y, int W, int H) const {
if (!Fl::visible_focus()) return;

View File

@ -1833,7 +1833,7 @@ static OSErr fillCurrentDragData(DragReference dragRef)
GetFlavorDataSize( dragRef, itemRef, 'TEXT', &itemSize );
GetFlavorData( dragRef, itemRef, 'TEXT', dst, &itemSize, 0L );
dst += itemSize;
*dst++ = '\n'; // add our element seperator
*dst++ = '\n'; // add our element separator
}
ret = GetFlavorFlags( dragRef, itemRef, 'hfs ', &flags );
if ( ret == noErr )
@ -1844,7 +1844,7 @@ static OSErr fillCurrentDragData(DragReference dragRef)
dst += itemSize;
if ( itemSize>1 && ( hfs.fileType=='fold' || hfs.fileType=='disk' ) )
*dst++ = '/';
*dst++ = '\n'; // add our element seperator
*dst++ = '\n'; // add our element separator
}
}

View File

@ -31,7 +31,7 @@
*/
// Box drawing code for the common box types and the table of
// boxtypes. Other box types are in seperate files so they are not
// boxtypes. Other box types are in separate files so they are not
// linked in if not used.
#include <FL/Fl.H>

View File

@ -26,7 +26,7 @@
//
// Box drawing code for an obscure box type.
// These box types are in seperate files so they are not linked
// These box types are in separate files so they are not linked
// in if not used.
// The diamond box draws best if the area is square!

View File

@ -233,7 +233,7 @@ private:
fmt.dwAspect = DVASPECT_CONTENT;
fmt.lindex = -1;
fmt.cfFormat = CF_HDROP;
// if it is a pathname list, send an FL_PASTE with a \n seperated list of filepaths
// if it is a pathname list, send an FL_PASTE with a \n separated list of filepaths
if ( data->GetData( &fmt, &medium )==S_OK )
{
HDROP hdrop = (HDROP)medium.hGlobal;

View File

@ -39,7 +39,7 @@
// Micro$oft picked a bottom-up and BGR storage format for their
// DIB images. I'm pretty certain there is a way around this, but
// I can't find any other than the brute-force method of drawing
// each line as a seperate image. This may also need to be done
// each line as a separate image. This may also need to be done
// if the delta is any amount other than 1, 3, or 4.
////////////////////////////////////////////////////////////////

View File

@ -36,7 +36,7 @@
// available to use this code. You will just get normal Xlib fonts
// (Xft calls them "core" fonts) The Xft algorithms for choosing
// these is about as good as the FLTK ones (I hope to fix it so it is
// exactly as good...), plus it can cache it's results and share them
// exactly as good...), plus it can cache its results and share them
// between programs, so using this should be a win in all cases. Also
// it should be obvious by comparing this file and fl_font_x.cxx that
// it is a lot easier to program with Xft than with Xlib.
@ -172,7 +172,7 @@ static XftFont* fontopen(const char* name, bool core) {
char *curr = local_name; // points to first name in string
char *nxt; // next name in string
do {
nxt = strchr(curr, ','); // find comma seperator
nxt = strchr(curr, ','); // find comma separator
if (nxt) {
*nxt = 0; // terminate first name
nxt++; // first char of next name

View File

@ -29,7 +29,7 @@
//
// Box drawing code for an obscure box type.
// These box types are in seperate files so they are not linked
// These box types are in separate files so they are not linked
// in if not used.
#include <FL/Fl.H>

View File

@ -102,7 +102,9 @@ void Fl_Label::measure(int& W, int& H) const {
f(this, W, H);
}
/** The normal call for a draw() method */
/** Draws the widget's label at the defined label position.
This is the normal call for a widget's draw() method.
*/
void Fl_Widget::draw_label() const {
int X = x_+Fl::box_dx(box());
int W = w_-Fl::box_dw(box());
@ -110,14 +112,18 @@ void Fl_Widget::draw_label() const {
draw_label(X, y_+Fl::box_dy(box()), W, h_-Fl::box_dh(box()));
}
/** draw() can use this instead to change the bounding box */
/** Draws the label in an arbitrary bounding box.
draw() can use this instead of draw_label(void) to change the bounding box
*/
void Fl_Widget::draw_label(int X, int Y, int W, int H) const {
// quit if we are not drawing a label inside the widget:
if ((align()&15) && !(align() & FL_ALIGN_INSIDE)) return;
draw_label(X,Y,W,H,align());
}
/** Anybody can call this to force the label to draw anywhere */
/** Draws the label in an arbitrary bounding box with an arbitrary alignment.
Anybody can call this to force the label to draw anywhere.
*/
void Fl_Widget::draw_label(int X, int Y, int W, int H, Fl_Align a) const {
if (flags()&SHORTCUT_LABEL) fl_draw_shortcut = 1;
Fl_Label l1 = label_;

View File

@ -26,7 +26,7 @@
//
// Less-used box types are in seperate files so they are not linked
// Less-used box types are in separate files so they are not linked
// in if not used.
#include <FL/Fl.H>

View File

@ -29,7 +29,7 @@
//
// Box drawing code for an obscure box type.
// These box types are in seperate files so they are not linked
// These box types are in separate files so they are not linked
// in if not used.
#include <FL/Fl.H>

View File

@ -26,7 +26,7 @@
//
// Box drawing code for an obscure box type.
// These box types are in seperate files so they are not linked
// These box types are in separate files so they are not linked
// in if not used.
#include <FL/Fl.H>

View File

@ -112,7 +112,7 @@ const char* Fl::get_font_name(Fl_Font fnum, int* ap) {
}
*o = 0;
} else { // standard dash-seperated font:
} else { // standard dash-separated font:
// get the family:
const char *x = fl_font_word(p,2); if (*x) x++; if (*x=='*') x++;