summaryrefslogtreecommitdiff
path: root/FL
diff options
context:
space:
mode:
authorMatthias Melcher <fltk@matthiasm.com>2009-04-19 12:47:36 +0000
committerMatthias Melcher <fltk@matthiasm.com>2009-04-19 12:47:36 +0000
commit03ec459eb03b18c4792c9edc5f8e585653c276e9 (patch)
treeff1f75585b32c98dfa21d94030f496ac3a5eaa29 /FL
parentb1ba38da6033889ecaff0c1f69b872fb6c76d961 (diff)
Removed extra \\c from the Doxygen documentation.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6771 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'FL')
-rw-r--r--FL/Fl.H32
-rw-r--r--FL/Fl_Input_.H62
2 files changed, 47 insertions, 47 deletions
diff --git a/FL/Fl.H b/FL/Fl.H
index 7edc561e7..a52149f6a 100644
--- a/FL/Fl.H
+++ b/FL/Fl.H
@@ -852,29 +852,29 @@ public:
These functions support deletion of widgets inside callbacks.
- \c Fl::delete_widget() should be called when deleting widgets
- or complete widget trees (\c Fl_Group, \c Fl_Window, ...) inside
+ Fl::delete_widget() should be called when deleting widgets
+ or complete widget trees (Fl_Group, Fl_Window, ...) inside
callbacks.
The other functions are intended for internal use. The preferred
- way to use them is by using the helper class \c Fl_Widget_Tracker.
+ way to use them is by using the helper class Fl_Widget_Tracker.
The following is to show how it works ...
There are three groups of related methods:
-# scheduled widget deletion
- - \c Fl::delete_widget() schedules widgets for deletion
- - \c Fl::do_widget_deletion() deletes all scheduled widgets
+ - Fl::delete_widget() schedules widgets for deletion
+ - Fl::do_widget_deletion() deletes all scheduled widgets
-# widget watch list ("smart pointers")
- - \c Fl::watch_widget_pointer() adds a widget pointer to the watch list
- - \c Fl::release_widget_pointer() removes a widget pointer from the watch list
- - \c Fl::clear_widget_pointer() clears a widget pointer \e in the watch list
+ - Fl::watch_widget_pointer() adds a widget pointer to the watch list
+ - Fl::release_widget_pointer() removes a widget pointer from the watch list
+ - Fl::clear_widget_pointer() clears a widget pointer \e in the watch list
-# the class Fl_Widget_Tracker:
- - the constructor calls \c Fl::watch_widget_pointer()
- - the destructor calls \c Fl::release_widget_pointer()
+ - the constructor calls Fl::watch_widget_pointer()
+ - the destructor calls Fl::release_widget_pointer()
- the access methods can be used to test, if a widget has been deleted
- \see \c Fl_Widget_Tracker.
+ \see Fl_Widget_Tracker.
@{ */
// Widget deletion:
@@ -937,11 +937,11 @@ public:
/**
This class should be used to control safe widget deletion.
- You can use an \c Fl_Widget_Tracker object to watch another widget, if you
+ You can use an Fl_Widget_Tracker object to watch another widget, if you
need to know, if this widget has been deleted during a callback.
This simplifies the use of the "safe widget deletion" methods
- \c Fl::watch_widget_pointer() and \c Fl::release_widget_pointer() and
+ Fl::watch_widget_pointer() and Fl::release_widget_pointer() and
makes their use more reliable, because the destructor autmatically
releases the widget pointer from the widget watch list.
@@ -950,7 +950,7 @@ public:
scope is left. This ensures that no stale widget pointers are
left in the widget watch list (see example below).
- You can also create \c Fl_Widget_Tracker objects with \c new, but then it
+ You can also create Fl_Widget_Tracker objects with \c new, but then it
is your responsibility to delete the object (and thus remove the
widget pointer from the watch list) when it is not needed any more.
@@ -997,7 +997,7 @@ public:
<tt> if (wp.widget() == 0) // ...</tt>
- where \p wp is an \c Fl_Widget_Tracker object.
+ where \p wp is an Fl_Widget_Tracker object.
*/
int deleted() {return wp_ == 0;}
@@ -1008,7 +1008,7 @@ public:
<tt> if (wp.widget() != 0) // ...</tt>
- where \p wp is an \c Fl_Widget_Tracker object.
+ where \p wp is an Fl_Widget_Tracker object.
*/
int exists() {return wp_ != 0;}
diff --git a/FL/Fl_Input_.H b/FL/Fl_Input_.H
index d63503f91..960f75afb 100644
--- a/FL/Fl_Input_.H
+++ b/FL/Fl_Input_.H
@@ -52,15 +52,15 @@
/**
This class provides a low-overhead text input field.
- This is a virtual base class below \c Fl_Input. It has all
- the same interfaces, but lacks the \c handle() and
- \c draw() method. You may want to subclass it if you are
+ This is a virtual base class below Fl_Input. It has all
+ the same interfaces, but lacks the handle() and
+ draw() method. You may want to subclass it if you are
one of those people who likes to change how the editing keys
work. It may also be useful for adding scrollbars
to the input field.
- This can act like any of the subclasses of \c Fl_Input, by
- setting \c type() to one of the following values:
+ This can act like any of the subclasses of Fl_Input, by
+ setting type() to one of the following values:
\code
#define FL_NORMAL_INPUT 0
@@ -77,7 +77,7 @@
#define FL_MULTILINE_OUTPUT_WRAP (FL_MULTILINE_INPUT | FL_INPUT_READONLY | FL_INPUT_WRAP)
\endcode
- \see \c Fl_Text_Display, \c Fl_Text_Editor for more powerful text handling widgets
+ \see Fl_Text_Display, Fl_Text_Editor for more powerful text handling widgets
*/
class FL_EXPORT Fl_Input_ : public Fl_Widget {
@@ -220,8 +220,8 @@ public:
to the internal buffer and is valid only until the next event is
handled.
- \return pointer to an internal buffer - do not \c free() this
- \see \c Fl_Input_::value(const char*)
+ \return pointer to an internal buffer - do not free() this
+ \see Fl_Input_::value(const char*)
*/
const char* value() const {return value_;}
@@ -238,7 +238,7 @@ public:
char index(int i) const {return value_[i];}
/**
- Returns the number of bytes in \c value().
+ Returns the number of bytes in value().
This may be greater than <tt>strlen(value())</tt> if there are
\c nul characters in the text.
@@ -249,7 +249,7 @@ public:
/** Sets the width and height of this widget.
\param [in] W, H new width and height
- \see \c Fl_Widget::size(int, int) */
+ \see Fl_Widget::size(int, int) */
void size(int W, int H) { Fl_Widget::size(W, H); }
/** Gets the maximum length of the input field.
@@ -262,7 +262,7 @@ public:
/** Gets the position of the text cursor.
\return the cursor position as an index
- \see \c position(int, int)
+ \see position(int, int)
*/
int position() const {return position_;}
@@ -274,18 +274,18 @@ public:
int position(int p, int m);
/** Set the cursor position and mark.
- \c position(n) is the same as <tt>position(n, n)</tt>.
+ position(n) is the same as <tt>position(n, n)</tt>.
\param p new index for cursor and mark
- \return \c 0 if no positions changed
- \see \c position(int, int), \c position(), \c mark(int)
+ \return 0 if no positions changed
+ \see position(int, int), position(), mark(int)
*/
int position(int p) {return position(p, p);}
/** Sets the current selection mark.
- \c mark(n) is the same as <tt>position(position(),n)</tt>.
+ mark(n) is the same as <tt>position(position(),n)</tt>.
\param m new index of the mark
- \return \c 0 if the mark did not change
- \see \c position(), \c position(int, int) */
+ \return 0 if the mark did not change
+ \see position(), position(int, int) */
int mark(int m) {return position(position(), m);}
/* Deletes text from b to e and inserts the new string text. */
@@ -296,10 +296,10 @@ public:
This function deletes the currently selected text
\e without storing it in the clipboard. To use the clipboard,
- you may call \c copy() first or \c copy_cuts() after
+ you may call copy() first or copy_cuts() after
this call.
- \return \c 0 if no data was copied
+ \return 0 if no data was copied
*/
int cut() {return replace(position(), mark(), 0);}
@@ -308,12 +308,12 @@ public:
This function deletes the currently selected text
\e without storing it in the clipboard. To use the clipboard,
- you may call \c copy() first or \c copy_cuts() after
+ you may call copy() first or copy_cuts() after
this call.
\param n number of bytes rounded to full characters and clamped to the buffer.
A negative number will cut characters to the left of the cursor.
- \return \c 0 if no data was copied
+ \return 0 if no data was copied
*/
int cut(int n) {return replace(position(), position()+n, 0);}
@@ -322,11 +322,11 @@ public:
This function deletes the currently selected text
\e without storing it in the clipboard. To use the clipboard,
- you may call \c copy() first or \c copy_cuts() after
+ you may call copy() first or copy_cuts() after
this call.
\param a, b range of bytes rounded to full characters and clamped to the buffer
- \return \c 0 if no data was copied
+ \return 0 if no data was copied
*/
int cut(int a, int b) {return replace(a, b, 0);}
@@ -334,12 +334,12 @@ public:
Inserts text at the cursor position.
This function inserts the string in \p t at the cursor
- \c position() and moves the new position and mark to
+ position() and moves the new position and mark to
the end of the inserted text.
\param [in] t text that will be inserted
- \param [in] l length of text, or \c 0 if the string is terminated by \c NUL.
- \return \c 0 if no text was inserted
+ \param [in] l length of text, or 0 if the string is terminated by \c nul.
+ \return 0 if no text was inserted
*/
int insert(const char* t, int l=0){return replace(position_, mark_, t, l);}
@@ -366,7 +366,7 @@ public:
void shortcut(int s) {shortcut_ = s;}
/** Gets the font of the text in the input field.
- \return the current \c Fl_Font index */
+ \return the current Fl_Font index */
Fl_Font textfont() const {return textfont_;}
/** Sets the font of the text in the input field.
@@ -385,13 +385,13 @@ public:
/** Gets the color of the text in the input field.
\return the text color
- \see \c textcolor(unsigned) */
+ \see textcolor(unsigned) */
Fl_Color textcolor() const {return (Fl_Color)textcolor_;}
/** Sets the color of the text in the input field.
The text color defaults to \c FL_FOREGROUND_COLOR.
\param [in] n new text color
- \see \c textcolor() */
+ \see textcolor() */
void textcolor(unsigned n) {textcolor_ = n;}
/** Gets the color of the cursor.
@@ -408,7 +408,7 @@ public:
int input_type() const {return type() & FL_INPUT_TYPE; }
/** Sets the input field type.
- A \c redraw() is required to reformat the input field.
+ A redraw() is required to reformat the input field.
\param [in] t new input type */
void input_type(int t) { type((uchar)(t | readonly())); }
@@ -417,7 +417,7 @@ public:
int readonly() const { return type() & FL_INPUT_READONLY; }
/** Sets the read-only state of the input field.
- \param [in] b if \p b is \c 0, the text in this widget can be edited by the user */
+ \param [in] b if \p b is 0, the text in this widget can be edited by the user */
void readonly(int b) { if (b) type((uchar)(type() | FL_INPUT_READONLY));
else type((uchar)(type() & ~FL_INPUT_READONLY)); }