diff options
| author | Michael R Sweet <michael.r.sweet@gmail.com> | 2001-08-02 18:31:29 +0000 |
|---|---|---|
| committer | Michael R Sweet <michael.r.sweet@gmail.com> | 2001-08-02 18:31:29 +0000 |
| commit | b0e56bb248b4690fc34505f58b8b795521628ff2 (patch) | |
| tree | df6d0c989fe3a13558f74a588d6de3130ef912e5 /documentation/Fl_HelpDialog.html | |
| parent | 58b0f306be3f6d5a1161d83d1ac6e0e3b8d8ad19 (diff) | |
Documentation...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@1529 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation/Fl_HelpDialog.html')
| -rw-r--r-- | documentation/Fl_HelpDialog.html | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/documentation/Fl_HelpDialog.html b/documentation/Fl_HelpDialog.html new file mode 100644 index 000000000..5fd28c7e6 --- /dev/null +++ b/documentation/Fl_HelpDialog.html @@ -0,0 +1,89 @@ +<HTML> +<HEAD> + <TITLE>HelpDialog - ESP Widget Set for FLTK</TITLE> + <LINK REL="STYLESHEET" TYPE="text/css" HREF="fltk.css"> + <MAP NAME="navbar"> + <AREA SHAPE="RECT" COORD="20,19,74,36" HREF="index.html" ALT="Widget Set Home Page"> + <AREA SHAPE="RECT" COORD="96,19,240,36" HREF="documentation.html" ALT="Widget Set Documentation"> + <AREA SHAPE="RECT" COORD="262,19,356,36" HREF="download.html" ALT="Download Widget Set"> + <AREA SHAPE="RECT" COORD="378,19,416,36" HREF="http://www.easysw.com" ALT="ESP Home Page"> + <AREA SHAPE="RECT" COORD="438,19,487,36" HREF="http://www.fltk.org" ALT="FLTK Home Page"> + </MAP> +</HEAD> + +<BODY BGCOLOR="#ccccff"> + +<!-- NEW PAGE --> +<H2>class HelpDialog</H2> + +<HR> + +<H3>Class Hierarchy</H3> + +<UL><PRE> +Fl_Group + | + +----<B>HelpDialog</B> +</PRE></UL> + +<H3>Include Files</H3> + +<UL><PRE> +#include "HelpDialog.h" +</PRE></UL> + +<H3>Description</H3> + +<P>The <CODE>HelpDialog</CODE> widget displays a standard help dialog window +using the <CODE>HelpView</CODE> widget. + +<CENTER><IMG SRC="HelpDialog.gif" WIDTH="80%" ALT="HelpDialog Window"></CENTER> + +<H3>Methods</H3> + +<UL> + + <LI><A HREF="#HelpDialog.HelpDialog">HelpDialog</A> + <LI><A HREF="#HelpDialog.~HelpDialog">~HelpDialog</A> + <LI><A HREF="#HelpDialog.hide">hide</A> + <LI><A HREF="#HelpDialog.load">load</A> + <LI><A HREF="#HelpDialog.show">show</A> + <LI><A HREF="#HelpDialog.topline">topline</A> + <LI><A HREF="#HelpDialog.visible">visible</A> + +</UL> + +<H4><A NAME="HelpDialog.HelpDialog">HelpDialog()</A></H4> + +<P>The constructor creates the dialog pictured above. + +<H4><A NAME="HelpView.~HelpView">~HelpView()</A></H4> + +<P>The destructor destroys the widget and frees all memory that has been +allocated for the current file. + +<H4><A NAME="HelpDialog.hide">void hide()</A></H4> + +<P>Hides the <code>HelpDialog</code> window. + +<H4><A NAME="HelpDialog.load">void load(const char *f)</A></H4> + +<P>Loads the specified HTML file into the <CODE>HelpView</CODE> widget. +The filename can also contain a target name ("filename.html#target"). + +<H4><A NAME="HelpDialog.show">void show()</A></H4> + +<P>Shows the <code>HelpDialog</code> window. + +<H4><A NAME="HelpDialog.topline">void topline(const char *n)<BR> +void topline(int n)</A></H4> + +<P>Sets the top line in the <CODE>HelpView</CODE> widget to the named or +numbered line. + +<H4><A NAME="HelpDialog.visible">int visible()</A></H4> + +<P>Returns 1 if the <code>HelpDialog</code> window is visible. + +</BODY> +</HTML> |