Skip to content

Commit

Permalink
more documentation updates for Fl_Help_View.H
Browse files Browse the repository at this point in the history
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6693 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
  • Loading branch information
Albrecht Schlosser committed Mar 15, 2009
1 parent 6eb194a commit 52c0cd3
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions FL/Fl_Help_View.H
Expand Up @@ -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 */
Expand Down Expand Up @@ -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.
*/
Expand All @@ -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(); }
Expand Down

0 comments on commit 52c0cd3

Please sign in to comment.