From 58548b781d7c3f0fa6c8c72c63dece888a02ea43 Mon Sep 17 00:00:00 2001 From: Fabien Costantini Date: Sun, 14 Sep 2008 12:45:42 +0000 Subject: Doxygen Documentation WP2 done. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6235 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- FL/Fl_Check_Browser.H | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'FL/Fl_Check_Browser.H') diff --git a/FL/Fl_Check_Browser.H b/FL/Fl_Check_Browser.H index 713f5cd56..a69e69288 100644 --- a/FL/Fl_Check_Browser.H +++ b/FL/Fl_Check_Browser.H @@ -31,6 +31,10 @@ #include "Fl.H" #include "Fl_Browser_.H" +/** + The Fl_Check_Browser widget displays a scrolling list of text + lines that may be selected and/or checked by the user. +*/ class FL_EXPORT Fl_Check_Browser : public Fl_Browser_ { /* required routines for Fl_Browser_ subclass: */ @@ -69,6 +73,7 @@ class FL_EXPORT Fl_Check_Browser : public Fl_Browser_ { public: Fl_Check_Browser(int x, int y, int w, int h, const char *l = 0); + /** The destructor deletes all list items and destroys the browser. */ ~Fl_Check_Browser() { clear(); } int add(char *s); // add an (unchecked) item int add(char *s, int b); // add an item and set checked @@ -76,14 +81,22 @@ class FL_EXPORT Fl_Check_Browser : public Fl_Browser_ { int remove(int item); // delete an item. Returns nitems() // inline const char * methods to avoid breaking binary compatibility... + /** See int Fl_Check_Browser::add(char *s) */ int add(const char *s) { return add((char *)s); } + /** See int Fl_Check_Browser::add(char *s) */ int add(const char *s, int b) { return add((char *)s, b); } void clear(); // delete all items + /** + Returns how many lines are in the browser. The last line number is equal to + this. + */ int nitems() const { return nitems_; } + /** Returns how many items are currently checked. */ int nchecked() const { return nchecked_; } int checked(int item) const; void checked(int item, int b); + /** Equivalent to Fl_Check_Browser::checked(item, 1). */ void set_checked(int item) { checked(item, 1); } void check_all(); void check_none(); -- cgit v1.2.3