summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGreg Ercolano <erco@seriss.com>2010-02-26 17:49:19 +0000
committerGreg Ercolano <erco@seriss.com>2010-02-26 17:49:19 +0000
commit6168f6fd4bb274af63f1fb91df18f448846e1646 (patch)
tree34f5d2574a69e3b900e5f5a26596f614a1fbafa4
parent0f87d7719b6510e2596703453da0bfb19d335be8 (diff)
doc mods to support fl_eventnames[].
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7157 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
-rw-r--r--FL/names.h9
-rw-r--r--documentation/src/events.dox3
-rw-r--r--documentation/src/subclassing.dox10
3 files changed, 17 insertions, 5 deletions
diff --git a/FL/names.h b/FL/names.h
index 1c3cca4b0..a58e0c1c5 100644
--- a/FL/names.h
+++ b/FL/names.h
@@ -42,10 +42,9 @@
\b Example:
\code
#include <FL/names.h> // array will be defined here
- // MyWidget's event handler
- int MyWidget::handle(int e) {
+ int MyClass::handle(int e) {
printf("Event was %s (%d)\n", fl_eventnames[e], e);
- /* ..resulting output might be e.g. "Event was FL_PUSH (1)".. */
+ // ..resulting output might be e.g. "Event was FL_PUSH (1)"..
[..]
}
\endcode
@@ -86,11 +85,11 @@ const char * const fl_eventnames[] =
\b Example:
\code
#include <FL/names.h> // array will be defined here
- int MyWidget::my_callback(Fl_Widget *w, void*) {
+ int MyClass::my_callback(Fl_Widget *w, void*) {
int fnum = w->labelfont();
// Resulting output might be e.g. "Label's font is FL_HELVETICA (0)"
printf("Label's font is %s (%d)\n", fl_fontnames[fnum], fnum);
- /* ..resulting output might be e.g. "Label's font is FL_HELVETICA (0)".. */
+ // ..resulting output might be e.g. "Label's font is FL_HELVETICA (0)"..
[..]
}
\endcode
diff --git a/documentation/src/events.dox b/documentation/src/events.dox
index 21eb3f0b6..9ea3df10c 100644
--- a/documentation/src/events.dox
+++ b/documentation/src/events.dox
@@ -25,6 +25,9 @@ of the
\p handle()
method.
+Event numbers can be converted to their actual names using the \ref fl_eventnames[] array
+defined in \#include &lt;FL/names.h&gt;; see next chapter for details.
+
In the next chapter, the
\ref subclassing_events "MyClass::handle()"
example shows how to override the
diff --git a/documentation/src/subclassing.dox b/documentation/src/subclassing.dox
index 57c004165..4d452ccc1 100644
--- a/documentation/src/subclassing.dox
+++ b/documentation/src/subclassing.dox
@@ -302,6 +302,16 @@ You must return non-zero if your \p handle() method
uses the event. If you return zero, the parent widget will try
sending the event to another widget.
+For debugging purposes, event numbers can be printed as their actual event names
+using the fl_eventnames[] array, e.g.:
+\code
+ #include <FL/names.h> // defines fl_eventnames[]
+ [..]
+ int MyClass::handle(int e) {
+ printf("Event was %s (%d)\n", fl_eventnames[e], e); // e.g. "Event was FL_PUSH (1)"
+ [..]
+\endcode
+
\section subclassing_drawing Drawing the Widget
The \p draw() virtual method is called when FLTK wants