src/Fl_Help_Dialog_Dox.cxx

   1 //
   2 // "$Id: Fl_Help_Dialog_Dox.cxx 7981 2010-12-08 23:53:04Z greg.ercolano $"
   3 //
   4 // Fl_Help_Dialog dialog for the Fast Light Tool Kit (FLTK).
   5 //
   6 // Copyright 1998-2010 by Bill Spitzak and others.
   7 //
   8 // This library is free software; you can redistribute it and/or
   9 // modify it under the terms of the GNU Library General Public
  10 // License as published by the Free Software Foundation; either
  11 // version 2 of the License, or (at your option) any later version.
  12 //
  13 // This library is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 // Library General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU Library General Public
  19 // License along with this library; if not, write to the Free Software
  20 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  21 // USA.
  22 //
  23 // Please report all bugs and problems on the following page:
  24 //
  25 //     http://www.fltk.org/str.php
  26 //
  27
  28 // Fl_Help_Dialog (autogenerated class) doxygen documentation placeholder
  29
  30 /** \class Fl_Help_Dialog
  31   The Fl_Help_Dialog widget displays a standard help dialog window
  32   using the Fl_Help_View widget.
  33
  34   <P ALIGN=CENTER> \image html Fl_Help_Dialog.png </P>
  35   \image latex  Fl_Help_Dialog.png "Fl_Help_Dialog" width=8cm
  36 */
  37
  38 /** \fn Fl_Help_Dialog::Fl_Help_Dialog()
  39   The constructor creates the dialog pictured above.*/
  40
  41 /** \fn Fl_Help_Dialog::~Fl_Help_Dialog()
  42   The destructor destroys the widget and frees all memory that has been
  43   allocated for the current file.
  44 */
  45
  46 /** \fn void Fl_Help_Dialog::hide()
  47   Hides the Fl_Help_Dialog window.*/
  48
  49 /** \fn void Fl_Help_Dialog::load(const char *f)
  50   Loads the specified HTML file into the Fl_Help_View widget.
  51   The filename can also contain a target name ("filename.html#target").
  52 */
  53
  54 /** \fn void Fl_Help_Dialog::position(int x, int y)
  55   Set the screen position of the dialog.*/
  56
  57 /** \fn void Fl_Help_Dialog::resize(int xx, int yy, int ww, int hh)
  58   Change the position and size of the dialog.*/
  59
  60 /** \fn void Fl_Help_Dialog::show()
  61   Shows the Fl_Help_Dialog window.*/
  62
  63 /** \fn void Fl_Help_Dialog::textsize(Fl_Fontsize s)
  64   Sets or gets the default text size for the help view.*/
  65
  66 /** \fn uchar Fl_Help_Dialog::textsize()
  67   Sets or gets the default text size for the help view.*/
  68
  69 /** \fn void Fl_Help_Dialog::topline(const char *n)
  70   Sets the top line in the Fl_Help_View widget to the named or
  71   numbered line.
  72 */
  73
  74 /** \fn void Fl_Help_Dialog::topline(int n)
  75   Sets the top line in the Fl_Help_View widget to the named or
  76   numbered line.
  77 */
  78
  79 /** \fn void Fl_Help_Dialog::value(const char *v)
  80   The first form sets the current buffer to the string provided and
  81   reformats the text. It also clears the history of the "back" and
  82   "forward" buttons. The second form returns the current buffer contents.
  83 */
  84
  85 /** \fn const char *Fl_Help_Dialog::value() const
  86   The first form sets the current buffer to the string provided and
  87   reformats the text. It also clears the history of the "back" and
  88   "forward" buttons. The second form returns the current buffer contents.
  89 */
  90
  91 /** \fn int Fl_Help_Dialog::visible()
  92   Returns 1 if the Fl_Help_Dialog window is visible.*/
  93
  94 /** \fn int Fl_Help_Dialog::x()
  95   Returns the position and size of the help dialog.*/
  96
  97 /** \fn int Fl_Help_Dialog::y()
  98   Returns the position and size of the help dialog.*/
  99
 100 /** \fn int Fl_Help_Dialog::w()
 101   Returns the position and size of the help dialog.*/
 102
 103 /** \fn int Fl_Help_Dialog::h()
 104   Returns the position and size of the help dialog.*/
 105
 106 /** \fn void Fl_Help_Dialog::show()
 107   Shows the main Help Dialog Window
 108   Delegates call to encapsulated window_ void Fl_Window::show() method */
 109
 110 /** \fn void Fl_Help_Dialog::show(int argc, char **argv)
 111   Shows the main Help Dialog Window
 112   Delegates call to encapsulated window_ void Fl_Window::show(int argc, char **argv) instance method */
 113
 114 /** \fn void Fl_Help_Dialog::textsize(Fl_Fontsize s)
 115   Sets the internal Fl_Help_View instance text size.
 116   Delegates call to encapsulated view_ void Fl_Help_View::textsize(Fl_Fontsize s) instance method */
 117
 118 //
 119 // End of "$Id: Fl_Help_Dialog_Dox.cxx 7981 2010-12-08 23:53:04Z greg.ercolano $".
 120 //