summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGreg Ercolano <erco@seriss.com>2010-10-26 09:41:47 +0000
committerGreg Ercolano <erco@seriss.com>2010-10-26 09:41:47 +0000
commit25ca2dbfbccdd4a40b1c7b88b4e710114dca89e4 (patch)
tree388d0ced590a579c7f57d0d6083b5490a05b82a1
parent0ad1f569851f924ed56670f440cae85520e233cb (diff)
Doxygen improvements for Fl_Table.H;
o Added docs for the TableContext enum members (including CONTEXT_TABLE) o Fix another example indent issue. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7745 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
-rw-r--r--FL/Fl_Table.H26
1 files changed, 14 insertions, 12 deletions
diff --git a/FL/Fl_Table.H b/FL/Fl_Table.H
index 2f833a73d..62ce275cc 100644
--- a/FL/Fl_Table.H
+++ b/FL/Fl_Table.H
@@ -172,15 +172,18 @@
*/
class Fl_Table : public Fl_Group {
public:
+ /**
+ The context bit flags for Fl_Table related callbacks (eg. draw_cell(), callback(), etc)
+ */
enum TableContext {
- CONTEXT_NONE = 0,
- CONTEXT_STARTPAGE = 0x01, // before a page is redrawn
- CONTEXT_ENDPAGE = 0x02, // after a page is redrawn
- CONTEXT_ROW_HEADER = 0x04, // in the row header
- CONTEXT_COL_HEADER = 0x08, // in the col header
- CONTEXT_CELL = 0x10, // in one of the cells
- CONTEXT_TABLE = 0x20, // in the table
- CONTEXT_RC_RESIZE = 0x40 // column or row being resized
+ CONTEXT_NONE = 0, ///< no known context
+ CONTEXT_STARTPAGE = 0x01, ///< before a page is redrawn
+ CONTEXT_ENDPAGE = 0x02, ///< after a page is redrawn
+ CONTEXT_ROW_HEADER = 0x04, ///< in the row header
+ CONTEXT_COL_HEADER = 0x08, ///< in the col header
+ CONTEXT_CELL = 0x10, ///< in one of the cells
+ CONTEXT_TABLE = 0x20, ///< in a dead zone of table
+ CONTEXT_RC_RESIZE = 0x40 ///< column or row being resized
};
private:
@@ -881,10 +884,9 @@ public:
Typically used in loops, eg:
\code
- for ( int i=0; i<children(); i++ )
- {
- Fl_Widget *w = child(i);
- [..]
+ for ( int i=0; i<children(); i++ ) {
+ Fl_Widget *w = child(i);
+ [..]
}
\endcode
*/