Skip to content

Commit

Permalink
Fix and improve Fl_Table docs, fix some other typos.
Browse files Browse the repository at this point in the history 
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10799 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
  • Loading branch information
Albrecht Schlosser committed Jul 18, 2015
1 parent 1cf24ff commit 98ef8d5
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 33 deletions.
2 changes: 1 addition & 1 deletion FL/Fl_Browser_.H
View file
Expand Up @@ -319,7 +319,7 @@ public:
If this value is zero (default), this widget will use the
Fl::scrollbar_size() value as the scrollbar's width.
\returns Scrollbar size in pixels, or 0 if the global Fl::scrollsize() is being used.
\returns Scrollbar size in pixels, or 0 if the global Fl::scrollbar_size() is being used.
\see Fl::scrollbar_size(int)
*/
int scrollbar_size() const {
Expand Down
2 changes: 1 addition & 1 deletion FL/Fl_Scroll.H
View file
Expand Up @@ -171,7 +171,7 @@ public:
If this value is zero (default), this widget will use the
Fl::scrollbar_size() value as the scrollbar's width.
\returns Scrollbar size in pixels, or 0 if the global Fl::scrollsize() is being used.
\returns Scrollbar size in pixels, or 0 if the global Fl::scrollbar_size() is being used.
\see Fl::scrollbar_size(int)
*/
int scrollbar_size() const {
Expand Down
58 changes: 30 additions & 28 deletions FL/Fl_Table.H
View file
Expand Up @@ -96,7 +96,7 @@
<td>The table's inner dimension. The inner edge of the border around the cells,
but inside the row/col headings and scrollbars. AKA the table's clip region.
eg. if the table_box() is FL_NO_BOX, these values are the same as
tox/toyy/tow/toh. (Blue in the diagram above)
tox/toy/tow/toh. (Blue in the diagram above)
</td></tr></table>
CORE DEVELOPERS
Expand Down Expand Up @@ -170,7 +170,9 @@
class FL_EXPORT Fl_Table : public Fl_Group {
public:
/**
The context bit flags for Fl_Table related callbacks (eg. draw_cell(), callback(), etc)
The context bit flags for Fl_Table related callbacks.
Used in draw_cell(), callback(), etc.
*/
enum TableContext {
CONTEXT_NONE = 0, ///< no known context
Expand Down Expand Up @@ -395,11 +397,11 @@ protected:
static char s[40];
sprintf(s, "%d/%d", R, C); // text for each cell
switch ( context ) {
case CONTEXT_STARTPAGE: // Fl_Table telling us its starting to draw page
case CONTEXT_STARTPAGE: // Fl_Table telling us it's starting to draw page
fl_font(FL_HELVETICA, 16);
return;
case CONTEXT_ROW_HEADER: // Fl_Table telling us it's draw row/col headers
case CONTEXT_ROW_HEADER: // Fl_Table telling us to draw row/col headers
case CONTEXT_COL_HEADER:
fl_push_clip(X, Y, W, H);
{
Expand Down Expand Up @@ -577,7 +579,7 @@ public:
}

/**
Returns the current value of this flag.
Returns if row resizing by the user is allowed.
*/
inline int row_resize() {
return(_row_resize);
Expand All @@ -594,7 +596,7 @@ public:
}

/**
Returns the current value of this flag.
Returns if column resizing by the user is allowed.
*/
inline int col_resize() {
return(_col_resize);
Expand All @@ -610,16 +612,16 @@ public:
}

/**
Sets the current column minimum resize value.
This is used to prevent the user from interactively resizing
any column to be smaller than 'pixels'. Must be a value >=1.
Returns the current column minimum resize value.
*/
inline int col_resize_min() { // column minimum resizing width
return(_col_resize_min);
}

/**
Returns the current column minimum resize value.
Sets the current column minimum resize value.
This is used to prevent the user from interactively resizing
any column to be smaller than 'pixels'. Must be a value >=1.
*/
void col_resize_min(int val) {
_col_resize_min = ( val < 1 ) ? 1 : val;
Expand All @@ -642,7 +644,7 @@ public:
}

/**
Returns the value of this flag.
Returns if row headers are enabled or not.
*/
inline int row_header() { // set/get row header enable flag
return(_row_header);
Expand Down Expand Up @@ -933,7 +935,7 @@ public:
/**
* Returns the current row the event occurred on.
*
* This function should only be used from within the user's callback function
* This function should only be used from within the user's callback function.
*/
int callback_row() {
return(_callback_row);
Expand All @@ -942,7 +944,7 @@ public:
/**
* Returns the current column the event occurred on.
*
* This function should only be used from within the user's callback function
* This function should only be used from within the user's callback function.
*/
int callback_col() {
return(_callback_col);
Expand All @@ -951,7 +953,7 @@ public:
/**
* Returns the current 'table context'.
*
* This function should only be used from within the user's callback function
* This function should only be used from within the user's callback function.
*/
TableContext callback_context() {
return(_callback_context);
Expand Down Expand Up @@ -985,13 +987,13 @@ public:
</td>
</tr>
</table>
The callback() routine is sent a TableContext that indicates the context the
event occurred in, such as in a cell, in a header, or elsewhere on the table.
When an event occurs in a cell or header, callback_row() and
callback_col() can be used to determine the row and column. The callback can
also look at the regular fltk event values (ie. Fl::event() and Fl::button())
to determine what kind of event is occurring.
The callback() routine is sent a TableContext that indicates the context the
event occurred in, such as in a cell, in a header, or elsewhere on the table.
When an event occurs in a cell or header, callback_row() and
callback_col() can be used to determine the row and column. The callback
can also look at the regular fltk event values (ie. Fl::event() and
Fl::event_button()) to determine what kind of event is occurring.
*/
void when(Fl_When flags);
#endif
Expand All @@ -1002,11 +1004,11 @@ public:
Callback functions should use the following functions to determine the
context/row/column:
* Fl_Table::callback_row() returns current row
* Fl_Table::callback_col() returns current column
* Fl_Table::callback_context() returns current table context
- Fl_Table::callback_row() returns current row
- Fl_Table::callback_col() returns current column
- Fl_Table::callback_context() returns current table context
callback_row() and callback_col() will be set to the row and column number the
event occurred on. If someone clicked on a row header, \p col will be \a 0.
If someone clicked on a column header, \p row will be \a 0.
Expand Down Expand Up @@ -1061,7 +1063,7 @@ public:
// Actual static callback
static void event_callback(Fl_Widget*, void* data) {
MyTable *o = (MyTable*)data;
o-&gt;event_callback2();
o->event_callback2();
}
public:
Expand All @@ -1085,7 +1087,7 @@ public:
If this value is zero (default), this widget will use the
Fl::scrollbar_size() value as the scrollbar's width.
\returns Scrollbar size in pixels, or 0 if the global Fl::scrollsize() is being used.
\returns Scrollbar size in pixels, or 0 if the global Fl::scrollbar_size() is being used.
\see Fl::scrollbar_size(int)
*/
int scrollbar_size() const {
Expand Down
4 changes: 2 additions & 2 deletions src/Fl_Table.cxx
View file
Expand Up @@ -1289,8 +1289,8 @@ void Fl_Table::draw() {
fl_rectf(tix, tiy + table_h, tiw, tih - table_h, color());
if ( row_header() ) {
// NOTE:
// Careful with that lower corner; don't use tih; when eg.
// table->box(FL_THIN_UPFRAME) and hscrollbar hidden,
// Careful with that lower corner; don't use tih; when eg.
// table->box(FL_THIN_UP_FRAME) and hscrollbar hidden,
// leaves a row of dead pixels.
//
fl_rectf(wix, tiy + table_h, row_header_width(),
Expand Down
2 changes: 1 addition & 1 deletion src/Fl_Tree.cxx
View file
Expand Up @@ -2760,7 +2760,7 @@ int Fl_Tree::is_scrollbar(Fl_Widget *w) {
/// If this value is zero (default), this widget will use the global
/// Fl::scrollbar_size() value as the scrollbar's width.
///
/// \returns Scrollbar size in pixels, or 0 if the global Fl::scrollsize() is being used.
/// \returns Scrollbar size in pixels, or 0 if the global Fl::scrollbar_size() is being used.
/// \see Fl::scrollbar_size(int)
///
int Fl_Tree::scrollbar_size() const {
Expand Down

0 comments on commit 98ef8d5

Please sign in to comment.