diff options
| -rw-r--r-- | FL/Fl_File_Input.H | 32 | ||||
| -rw-r--r-- | src/Fl_File_Input.cxx | 44 |
2 files changed, 60 insertions, 16 deletions
diff --git a/FL/Fl_File_Input.H b/FL/Fl_File_Input.H index 6febdb5f8..8e32a9e67 100644 --- a/FL/Fl_File_Input.H +++ b/FL/Fl_File_Input.H @@ -34,7 +34,15 @@ # include <FL/Fl_Input.H> +/** + \class Fl_File_Input + \brief This widget displays a pathname in a text input field. + A navigation bar located above the input field allows the user to + navigate upward in the directory tree. + + \image html Fl_File_Input.gif +*/ class FL_EXPORT Fl_File_Input : public Fl_Input { Fl_Color errorcolor_; @@ -49,19 +57,31 @@ class FL_EXPORT Fl_File_Input : public Fl_Input public: - Fl_File_Input(int,int,int,int,const char *t=0); + Fl_File_Input(int X, int Y, int W, int H, const char *L=0); - virtual int handle(int); + virtual int handle(int event); virtual void draw(); - /** Gets or sets the box type to use for the navigation bar. */ + /** Gets the box type used for the navigation bar. */ Fl_Boxtype down_box() const { return (Fl_Boxtype)down_box_; } - /** Gets or sets the box type to use for the navigation bar. */ + /** Sets the box type to use for the navigation bar. */ void down_box(Fl_Boxtype b) { down_box_ = b; } + + /** + Gets the current error color. + \todo Better docs for Fl_File_Input::errorcolor() - is it even used? + */ Fl_Color errorcolor() const { return errorcolor_; } + /** Sets the current error color to \a c */ void errorcolor(Fl_Color c) { errorcolor_ = c; } - int value(const char*); - int value(const char*, int); + + int value(const char *str); + int value(const char *str, int len); + + /** + Returns the current value, which is a pointer to an internal buffer + and is valid only until the next event is handled. + */ const char *value() { return Fl_Input_::value(); } }; diff --git a/src/Fl_File_Input.cxx b/src/Fl_File_Input.cxx index 39804d809..7e96ecdd7 100644 --- a/src/Fl_File_Input.cxx +++ b/src/Fl_File_Input.cxx @@ -51,9 +51,11 @@ /** Creates a new Fl_File_Input widget using the given position, size, and label string. The default boxtype is FL_DOWN_BOX. + \param[in] X, Y, W, H position and size of the widget + \param[in] L widget label, default is no label */ -Fl_File_Input::Fl_File_Input(int X, int Y, int W, int H, const char *l) - : Fl_Input(X, Y, W, H, l) { +Fl_File_Input::Fl_File_Input(int X, int Y, int W, int H, const char *L) + : Fl_Input(X, Y, W, H, L) { buttons_[0] = 0; errorcolor_ = FL_RED; ok_entry_ = 1; @@ -62,7 +64,9 @@ Fl_File_Input::Fl_File_Input(int X, int Y, int W, int H, const char *l) down_box(FL_UP_BOX); } -/** Draw directory buttons. */ +/** + Draw directory buttons. +*/ void Fl_File_Input::draw_buttons() { int i, // Looping var X; // Current X position @@ -97,7 +101,9 @@ void Fl_File_Input::draw_buttons() { } } -/** Update the sizes of the directory buttons.*/ +/** + Update the sizes of the directory buttons. +*/ void Fl_File_Input::update_buttons() { int i; // Looping var const char *start, // Start of path component @@ -132,8 +138,12 @@ void Fl_File_Input::update_buttons() { } -// -/** Sets the value of the widget given a new string value and its length, Returns non 0 on success */ +/** + Sets the value of the widget given a new string value and its length. + Returns non 0 on success. + \param[in] str new string value + \param[in] len lengh of value +*/ int // O - TRUE on success Fl_File_Input::value(const char *str, // I - New string value int len) { // I - Length of value @@ -142,7 +152,11 @@ Fl_File_Input::value(const char *str, // I - New string value } -/** Sets the value of the widget given a new string value, Returns non 0 on success */ +/** + Sets the value of the widget given a new string value. + Returns non 0 on success. + \param[in] str new string value +*/ int // O - TRUE on success Fl_File_Input::value(const char *str) { // I - New string value damage(FL_DAMAGE_BAR); @@ -150,7 +164,9 @@ Fl_File_Input::value(const char *str) { // I - New string value } -/** Draws the file input widget */ +/** + Draws the file input widget +*/ void Fl_File_Input::draw() { Fl_Boxtype b = box(); if (damage() & (FL_DAMAGE_BAR | FL_DAMAGE_ALL)) draw_buttons(); @@ -166,7 +182,11 @@ void Fl_File_Input::draw() { -/** Handle events in the widget, return non zero if event is handled */ +/** + Handle events in the widget. + Return non zero if event is handled. + \param[in] event +*/ int // O - TRUE if we handled event Fl_File_Input::handle(int event) // I - Event { @@ -201,7 +221,11 @@ Fl_File_Input::handle(int event) // I - Event -/** Handles button events in the widget , return non zero if event is handled */ +/** + Handles button events in the widget. + Return non zero if event is handled. + \param[in] event +*/ int // O - TRUE if we handled event Fl_File_Input::handle_button(int event) // I - Event { |