summaryrefslogtreecommitdiff
path: root/FL/Fl_Text_Editor.H
diff options
context:
space:
mode:
authorFabien Costantini <fabien@onepost.net>2008-09-18 19:09:34 +0000
committerFabien Costantini <fabien@onepost.net>2008-09-18 19:09:34 +0000
commite8478458bf96bb62158a61b39416e515767d94a7 (patch)
tree0ba17d2b9ae36dc475c63e1d0499204208a632f7 /FL/Fl_Text_Editor.H
parentd75b9717c7c1d607a83d0b9625296a0a3bce25c3 (diff)
Doxygen documentation: Fixed most important warnings for the Fl_Widget, Fl_Window, Fl_Valuator classes that should be now a 100% documented. For the rest I drastically reduced the undocumented APIs, but many others (less important) remains.
It looks and feels pretty good now :-) git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6299 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'FL/Fl_Text_Editor.H')
-rw-r--r--FL/Fl_Text_Editor.H12
1 files changed, 8 insertions, 4 deletions
diff --git a/FL/Fl_Text_Editor.H b/FL/Fl_Text_Editor.H
index 75f72a35b..1c7ba221c 100644
--- a/FL/Fl_Text_Editor.H
+++ b/FL/Fl_Text_Editor.H
@@ -48,13 +48,15 @@
*/
class FL_EXPORT Fl_Text_Editor : public Fl_Text_Display {
public:
+ /** Key function binding callback type */
typedef int (*Key_Func)(int key, Fl_Text_Editor* editor);
+ /** Simple linked list associating a key/state to a function */
struct Key_Binding {
- int key;
- int state;
- Key_Func function;
- Key_Binding* next;
+ int key; ///< the key pressed
+ int state; ///< the state of key modifiers
+ Key_Func function; ///< associated function
+ Key_Binding* next; ///< next key binding in the list
};
Fl_Text_Editor(int X, int Y, int W, int H, const char* l = 0);
@@ -121,10 +123,12 @@ class FL_EXPORT Fl_Text_Editor : public Fl_Text_Display {
int handle_key();
void maybe_do_callback();
+#ifndef FL_DOXYGEN
int insert_mode_;
Key_Binding* key_bindings;
static Key_Binding* global_key_bindings;
Key_Func default_key_function_;
+#endif
};
#endif