gre-ilya/fltk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doxygen documentation. Fixed somes typos and also H4 remanent misplaced tags and comments.

Browse Source 
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6258 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Fabien Costantini 2008-09-15 17:46:42 +00:00
parent c975ec6dca
commit d55dfeb5e9
32 changed files with 51 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
FL/Fl.H
View File

@ -485,7 +485,7 @@ public:
will be marked as <i>text</i>.
*/
static int dnd(); // platform dependent
// These are for back-compatability only:
// These are for back-compatibility only:
/** See Fl_Widget* selection_owner(Fl_Widget*) */
static Fl_Widget* selection_owner() {return selection_owner_;}
static void selection_owner(Fl_Widget*);
@ -593,7 +593,7 @@ public:
static int box_dh(Fl_Boxtype);
static int draw_box_active();
// back compatability:
// back compatibility:
/** for back compatibility. sets the (*fatal)() callback. */
static void set_abort(void (*f)(const char*,...)) {fatal = f;}
static void (*atclose)(Fl_Window*,void*);

2
FL/Fl_Browser.H
View File

@ -219,7 +219,7 @@ public:
else Fl_Browser_::display(find_line(n));
}
// for back compatability only:
// for back compatibility only:
void replace(int a, const char* b) {text(a, b);}
void display(int, int=1);
};

2
FL/Fl_Browser_.H
View File

@ -255,7 +255,7 @@ public:
/** Sets or gets the width of any scrollbars that are used. */
static int scrollbar_width() {return scrollbar_width_;}
// for back compatability:
// for back compatibility:
/** This method moves the vertical scrollbar to the righthand side of the list. */
void scrollbar_right() {scrollbar.align(FL_ALIGN_RIGHT);}
/** This method moves the vertical scrollbar to the lefthand side of the list. */

4
FL/Fl_Button.H
View File

@ -36,7 +36,7 @@
#define FL_NORMAL_BUTTON 0
#define FL_TOGGLE_BUTTON 1
#define FL_RADIO_BUTTON (FL_RESERVED_TYPE+2)
#define FL_HIDDEN_BUTTON 3 // for Forms compatability
#define FL_HIDDEN_BUTTON 3 // for Forms compatibility
extern FL_EXPORT int fl_old_shortcut(const char*);
@ -65,7 +65,7 @@ public:
Fl_Boxtype down_box() const {return (Fl_Boxtype)down_box_;}
void down_box(Fl_Boxtype b) {down_box_ = b;}
// back compatability:
// back compatibility:
void shortcut(const char *s) {shortcut(fl_old_shortcut(s));}
Fl_Color down_color() const {return selection_color();}
void down_color(unsigned c) {selection_color(c);}

2
FL/Fl_Free.H
View File

@ -72,7 +72,7 @@ public:
~Fl_Free();
};
// old event names for compatability:
// old event names for compatibility:
#define FL_MOUSE FL_DRAG
#define FL_DRAW 100 // NOT USED
#define FL_STEP 101

1
FL/Fl_Gl_Window.H
View File

@ -160,7 +160,6 @@ public:
Fl_Mode mode() const {return (Fl_Mode)mode_;}
int mode(int a) {return mode(a,0);}
int mode(const int *a) {return mode(0, a);}
void* context() const {return context_;}
void context(void*, int destroy_flag = 0);
void make_current();

2
FL/Fl_Group.H
View File

@ -159,7 +159,7 @@ public:
void add_resizable(Fl_Widget& o) {resizable_ = &o; add(o);}
void init_sizes();
// back compatability function:
// back compatibility function:
void focus(Fl_Widget* o) {o->take_focus();}
Fl_Widget* & _ddfdesign_kludge() {return resizable_;}
void forms_end();

2
FL/Fl_Menu.H
View File

@ -25,7 +25,7 @@
// http://www.fltk.org/str.php
//
// this include file is for back compatability only
// this include file is for back compatibility only
#include "Fl_Menu_Item.H"
//

32
FL/Fl_Menu_.H
View File

@ -124,41 +124,15 @@ public:
This box type is used to surround the currently-selected items in the
menus. If this is FL_NO_BOX then it acts like
FL_THIN_UP_BOX and selection_color() acts like
FL_WHITE, for back compatability.
<h4>const Fl_Menu_Item *Fl_Menu_::find_item(const char *name);</h4>
<p>Returns a pointer to the menu item with the given (full)
pathname. If no matching menu item can be found, a NULL pointer
is returned. This function does not search submenus that are linked
via FL_SUBMENU_POINTER.</p>
<h4>int Fl_Menu_::item_pathname(char *name, int namelen ) const;<br>
int Fl_Menu_::item_pathname(char *name, int namelen, const Fl_Menu_Item *finditem) const;</h4>
<p>Returns the 'menu pathname' (eg. "File/Quit") for the recently picked item in user supplied string 'name'. Useful in the callback function for a menu item, to determine the last picked item's 'menu pathname' string.
<p>If finditem is specified, name will contain the 'menu pathname' for that item.
<p>Returns:
<ul>
<li>0 - OK: 'name' has the pathname, guaranteed not longer than namelen
<li>-1 - Failed: 'finditem' was not found in the menu
<li>-2 - Failed: 'name' is not large enough to handle the menu names
</ul>
<p>In the case of errors (-1 or -2), 'name' will be an empty string.
FL_WHITE, for back compatibility.
*/
Fl_Boxtype down_box() const {return (Fl_Boxtype)down_box_;}
/** See Fl_Boxtype Fl_Menu_::down_box() const */
void down_box(Fl_Boxtype b) {down_box_ = b;}
/** For back compatability, same as selection_color() */
/** For back compatibility, same as selection_color() */
Fl_Color down_color() const {return selection_color();}
/** For back compatability, same as selection_color() */
/** For back compatibility, same as selection_color() */
void down_color(unsigned c) {selection_color(c);}
};

8
FL/Fl_Menu_Item.H
View File

@ -199,7 +199,7 @@ struct FL_EXPORT Fl_Menu_Item {
/**
Each item has space for a callback function and an argument for that
function. Due to back compatability, 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.
*/
@ -350,7 +350,7 @@ struct FL_EXPORT Fl_Menu_Item {
*/
void do_callback(Fl_Widget* o,long arg) const {callback_(o, (void*)arg);}
// back-compatability, do not use:
// back-compatibility, do not use:
/** back compatibility only \deprecated. */
int checked() const {return flags&FL_MENU_VALUE;}
/** back compatibility only \deprecated. */
@ -365,9 +365,9 @@ struct FL_EXPORT Fl_Menu_Item {
int size() const ;
};
typedef Fl_Menu_Item Fl_Menu; // back compatability
typedef Fl_Menu_Item Fl_Menu; // back compatibility
enum { // back-compatability enum:
enum { // back-compatibility enum:
FL_PUP_NONE = 0,
FL_PUP_GREY = FL_MENU_INACTIVE,
FL_PUP_GRAY = FL_MENU_INACTIVE,

2
FL/Fl_Object.H
View File

@ -25,7 +25,7 @@
// http://www.fltk.org/str.php
//
// This file is provided for back compatability only. Please use Fl_Widget
// This file is provided for back compatibility only. Please use Fl_Widget
#ifndef Fl_Object
#define Fl_Object Fl_Widget
#endif

2
FL/Fl_Toggle_Light_Button.H
View File

@ -25,7 +25,7 @@
// http://www.fltk.org/str.php
//
// provided for back-compatability only
// provided for back-compatibility only
#ifndef Fl_Toggle_Light_Button
#include "Fl_Light_Button.H"

2
FL/Fl_Toggle_Round_Button.H
View File

@ -25,7 +25,7 @@
// http://www.fltk.org/str.php
//
// provided for back-compatability only
// provided for back-compatibility only
#ifndef Fl_Toggle_Round_Button
#include "Fl_Round_Button.H"

2
FL/Fl_Window.H
View File

@ -362,7 +362,7 @@ public:
*/
void make_current();
// for back-compatability only:
// for back-compatibility only:
/**
Changes the cursor for this window. This always calls the system, if
you are changing the cursor a lot you may want to keep track of how

2
FL/fl_draw.H
View File

@ -38,7 +38,7 @@ FL_EXPORT extern char fl_draw_shortcut;
// Colors:
FL_EXPORT void fl_color(Fl_Color); // select indexed color
inline void fl_color(int c) {fl_color((Fl_Color)c);} // for back compatability
inline void fl_color(int c) {fl_color((Fl_Color)c);} // for back compatibility
FL_EXPORT void fl_color(uchar, uchar, uchar); // select actual color
extern FL_EXPORT Fl_Color fl_color_;
inline Fl_Color fl_color() {return fl_color_;}

2
fluid/Fl_Widget_Type.cxx
View File

@ -2482,7 +2482,7 @@ void Fl_Widget_Type::read_property(const char *c) {
((Fl_Button*)o)->value(atoi(value));
} else if (!strcmp(c,"color")) {
int n = sscanf(read_word(),"%d %d",&x,&y);
if (n == 2) { // back compatability...
if (n == 2) { // back compatibility...
if (x != 47) o->color(x);
o->selection_color(y);
} else {

2
fluid/file.cxx
View File

@ -393,7 +393,7 @@ static void read_children(Fl_Type *p, int paste) {
continue;
}
// back compatability with Vincent Penne's original class code:
// back compatibility with Vincent Penne's original class code:
if (!p && !strcmp(c,"define_in_struct")) {
Fl_Type *t = Fl_Type_make("class");
t->name(read_word());

2
src/Fl.cxx
View File

@ -1327,7 +1327,7 @@ int Fl_Window::handle(int ev)
}
////////////////////////////////////////////////////////////////
// Back compatability cut & paste functions for fltk 1.1 only:
// Back compatibility cut & paste functions for fltk 1.1 only:
/**
The single-argument selection_owner(x) call can be used to

2
src/Fl_Browser_.cxx
View File

@ -889,7 +889,7 @@ Fl_Browser_::Fl_Browser_(int X, int Y, int W, int H, const char* l)
selection_ = 0;
color(FL_BACKGROUND2_COLOR, FL_SELECTION_COLOR);
scrollbar.callback(scrollbar_callback);
//scrollbar.align(FL_ALIGN_LEFT|FL_ALIGN_BOTTOM); // back compatability?
//scrollbar.align(FL_ALIGN_LEFT|FL_ALIGN_BOTTOM); // back compatibility?
hscrollbar.callback(hscrollbar_callback);
hscrollbar.type(FL_HORIZONTAL);
textfont_ = FL_HELVETICA;

2
src/Fl_Check_Button.cxx
View File

@ -30,7 +30,7 @@
// A subclass of Fl_Button that always draws as a diamond box. This
// diamond is smaller than the widget size and can be surchecked by
// another box type, for compatability with Forms.
// another box type, for compatibility with Forms.
Fl_Check_Button::Fl_Check_Button(int X, int Y, int W, int H, const char *l)
: Fl_Light_Button(X, Y, W, H, l) {

23
src/Fl_Gl_Window.cxx
View File

@ -79,18 +79,6 @@ static char SWAP_TYPE = 0 ; // 0 = determine it from environment variable
Returns non-zero if the hardware supports the given or current OpenGL
mode.
<h4>void* Fl_Gl_Window::context() const;
<br>void Fl_Gl_Window::context(void*, int destroy_flag = false);</h4>
Return or set a pointer to the GLContext that this window is
using. This is a system-dependent structure, but it is portable to copy
the context from one window to another. You can also set it to NULL,
which will force FLTK to recreate the context the next time make_current() is called, this is
useful for getting around bugs in OpenGL implementations.
<p>If <i>destroy_flag</i> is true the context will be destroyed by
fltk when the window is destroyed, or when the mode() is changed, or the next time
context(x) is called.
*/
int Fl_Gl_Window::can_do(int a, const int *b) {
return Fl_Gl_Choice::find(a,b) != 0;
@ -444,6 +432,17 @@ void Fl_Gl_Window::resize(int X,int Y,int W,int H) {
Fl_Window::resize(X,Y,W,H);
}
/**
Returns or sets a pointer to the GLContext that this window is
using. This is a system-dependent structure, but it is portable to copy
the context from one window to another. You can also set it to NULL,
which will force FLTK to recreate the context the next time make_current() is called, this is
useful for getting around bugs in OpenGL implementations.
<p>If <i>destroy_flag</i> is true the context will be destroyed by
fltk when the window is destroyed, or when the mode() is changed, or the next time
context(x) is called.
*/
void Fl_Gl_Window::context(void* v, int destroy_flag) {
if (context_ && !(mode_&NON_LOCAL_CONTEXT)) fl_delete_gl_context(context_);
context_ = (GLContext)v;

2
src/Fl_Group.cxx
View File

@ -87,7 +87,7 @@ void Fl_Group::current(Fl_Group *g) {current_ = g;}
extern Fl_Widget* fl_oldfocus; // set by Fl::focus
// For back-compatability, we must adjust all events sent to child
// For back-compatibility, we must adjust all events sent to child
// windows so they are relative to that window.
static int send(Fl_Widget* o, int event) {

2
src/Fl_Menu.cxx
View File

@ -160,7 +160,7 @@ void Fl_Menu_Item::draw(int x, int y, int w, int h, const Fl_Menu_* m,
if (selected) {
Fl_Color r = m ? m->selection_color() : FL_SELECTION_COLOR;
Fl_Boxtype b = m && m->down_box() ? m->down_box() : FL_FLAT_BOX;
if (fl_contrast(r,color)!=r) { // back compatability boxtypes
if (fl_contrast(r,color)!=r) { // back compatibility boxtypes
if (selected == 2) { // menu title
r = color;
b = m ? m->box() : FL_UP_BOX;

2
src/Fl_Menu_Button.cxx
View File

@ -37,7 +37,7 @@ void Fl_Menu_Button::draw() {
draw_box(pressed_menu_button_ == this ? fl_down(box()) : box(), color());
draw_label();
if (Fl::focus() == this) draw_focus();
if (box() == FL_FLAT_BOX) return; // for XForms compatability
if (box() == FL_FLAT_BOX) return; // for XForms compatibility
int H = (labelsize()-3)&-2;
int X = x()+w()-H*2;
int Y = y()+(h()-H)/2;

2
src/Fl_Round_Button.cxx
View File

@ -27,7 +27,7 @@
// A subclass of Fl_Button that always draws as a round circle. This
// circle is smaller than the widget size and can be surrounded by
// another box type, for compatability with Forms.
// another box type, for compatibility with Forms.
#include <FL/Fl.H>
#include <FL/Fl_Round_Button.H>

6
src/Fl_Widget.cxx
View File

@ -35,9 +35,9 @@
////////////////////////////////////////////////////////////////
// for compatability with Forms, all widgets without callbacks are
// for compatibility with Forms, all widgets without callbacks are
// inserted into a "queue" when they are activated, and the forms
// compatability interaction functions (fl_do_events, etc) will
// compatibility interaction functions (fl_do_events, etc) will
// read one widget at a time from this queue and return it:
const int QUEUE_SIZE = 20;
@ -47,7 +47,7 @@ static int obj_head, obj_tail;
void Fl_Widget::default_callback(Fl_Widget *o, void * /*v*/) {
#if 0
// This is necessary for strict forms compatability but is confusing.
// This is necessary for strict forms compatibility but is confusing.
// Use the parent's callback if this widget does not have one.
for (Fl_Widget *p = o->parent(); p; p = p->parent())
if (p->callback() != default_callback) {

2
src/Fl_Window.cxx
View File

@ -156,7 +156,7 @@ void Fl_Window::iconlabel(const char *iname) {
set_flag(saveflags);
}
// the Fl::atclose pointer is provided for back compatability. You
// the Fl::atclose pointer is provided for back compatibility. You
// can now just change the callback for the window instead.
/** Default callback for window widgets. It hides the window and then calls the default widget callback. */

2
src/Fl_x.cxx
View File

@ -1166,7 +1166,7 @@ int fl_handle(const XEvent& thisevent)
Fl::e_length = len;
} else {
// Stupid X sends fake key-up events when a repeating key is held
// down, probably due to some back compatability problem. Fortunately
// down, probably due to some back compatibility problem. Fortunately
// we can detect this because the repeating KeyPress event is in
// the queue, get it and execute it instead:
XEvent temp;

2
src/fl_symbols.cxx
View File

@ -94,7 +94,7 @@ int fl_add_symbol(const char *name, void (*drawit)(Fl_Color), int scalable)
int fl_return_arrow(int x,int y,int w,int h);
// provided for back compatability:
// provided for back compatibility:
int fl_draw_symbol(const char *label,int x,int y,int w,int h,Fl_Color col) {
const char *p = label;
if (*p++ != '@') return 0;

2
src/fl_utf.c
View File

@ -612,7 +612,7 @@ unsigned fl_utf8froma(char* dst, unsigned dstlen,
to a string containing the letters "utf" or "UTF" in it, or by
deleting all $LC* and $LANG environment variables. In the future
it is likely that all non-Asian Unix systems will return true,
due to the compatability of UTF-8 with ISO-8859-1.
due to the compatibility of UTF-8 with ISO-8859-1.
*/
int fl_utf8locale(void) {
static int ret = 2;

4
src/forms_compatability.cxx
View File

@ -25,7 +25,7 @@
// http://www.fltk.org/str.php
//
// Forms library compatability functions.
// Forms library compatibility functions.
// Many more functions are defined as inlines in forms.h!
#include <FL/forms.H>
@ -140,7 +140,7 @@ void fl_set_graphics_mode(int /*r*/,int /*d*/) {}
void Fl_FormsText::draw() {
draw_box();
align(align()|FL_ALIGN_INSIDE); // questionable method of compatability
align(align()|FL_ALIGN_INSIDE); // questionable method of compatibility
draw_label();
}

2
src/forms_free.cxx
View File

@ -59,7 +59,7 @@ void Fl_Free::step(void *v) {
The event argument contains the event type:
<UL>
<PRE>
// old event names for compatability:
// old event names for compatibility:
#define FL_MOUSE FL_DRAG
#define FL_DRAW 0
#define FL_STEP 9