diff options
| author | Albrecht Schlosser <albrechts.fltk@online.de> | 2009-03-15 21:28:50 +0000 |
|---|---|---|
| committer | Albrecht Schlosser <albrechts.fltk@online.de> | 2009-03-15 21:28:50 +0000 |
| commit | 52c0cd3d9abb1671a6afe3c19f67894b4c72e8e0 (patch) | |
| tree | ba3146deb7657e015b5dc9d5d34220d46ff02d20 /FL/Fl_Help_View.H | |
| parent | 6eb194ae48657e3d12819e7d1b28c8b7550fb464 (diff) | |
more documentation updates for Fl_Help_View.H
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6693 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'FL/Fl_Help_View.H')
| -rw-r--r-- | FL/Fl_Help_View.H | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/FL/Fl_Help_View.H b/FL/Fl_Help_View.H index 628601fb9..6b1ce3054 100644 --- a/FL/Fl_Help_View.H +++ b/FL/Fl_Help_View.H @@ -132,7 +132,7 @@ struct Fl_Help_Font_Stack { protected: size_t nfonts_; ///< current number of fonts in stack - Fl_Help_Font_Style elts_[100]; ///< font eletments + Fl_Help_Font_Style elts_[100]; ///< font elements }; /** Fl_Help_Target structure */ @@ -242,23 +242,23 @@ public: int find(const char *s, int p = 0); /** This method assigns a callback function to use when a link is - followed or a file is loaded (via - Fl_Help_View::load()) that requires a different - file or path. The callback function receives a pointer to the - Fl_Help_View widget and the URI or full pathname - for the file in question. It must return a pathname that can be - opened as a local file or NULL:</P> + followed or a file is loaded (via Fl_Help_View::load()) that + requires a different file or path. + + The callback function receives a pointer to the Fl_Help_View + widget and the URI or full pathname for the file in question. + It must return a pathname that can be opened as a local file or NULL: \code const char *fn(Fl_Widget *w, const char *uri); \endcode - <P>The link function can be used to retrieve remote or virtual + The link function can be used to retrieve remote or virtual documents, returning a temporary file that contains the actual data. If the link function returns NULL, the value of - the Fl_Help_View widget will remain unchanged.</P> + the Fl_Help_View widget will remain unchanged. - <P>If the link callback cannot handle the URI scheme, it should + If the link callback cannot handle the URI scheme, it should return the uri value unchanged or set the value() of the widget before returning NULL. */ @@ -270,7 +270,7 @@ public: void size(int W, int H) { Fl_Widget::size(W, H); } /** Sets the default text color. */ void textcolor(Fl_Color c) { if (textcolor_ == defcolor_) textcolor_ = c; defcolor_ = c; } - /** Returns the current default text color. */ + /** Returns the current default text color. */ Fl_Color textcolor() const { return (defcolor_); } /** Sets the default text font. */ void textfont(Fl_Font f) { textfont_ = f; format(); } |
