fltk/documentation/Fl_Help_Dialog.html

121 lines
3.2 KiB
HTML
Raw Normal View History

<HTML>
<HEAD>
<TITLE>Fl_Help_Dialog</TITLE>
</HEAD>
<BODY>
<!-- NEW PAGE -->
<H2><A NAME="Fl_Help_Dialog">class Fl_Help_Dialog</A></H2>
<HR>
<H3>Class Hierarchy</H3>
<UL><PRE>
<B>Fl_Help_Dialog</B>
</PRE></UL>
<H3>Include Files</H3>
<UL><PRE>
#include "Fl_Help_Dialog.h"
</PRE></UL>
<H3>Additional Libraries</H3>
<UL><PRE>
-lfltk_images / fltkimages.lib
</PRE></UL>
<H3>Description</H3>
<P>The <CODE>Fl_Help_Dialog</CODE> widget displays a standard help dialog window
using the <CODE>Fl_Help_View</CODE> widget.
<CENTER><IMG SRC="Fl_Help_Dialog.gif" WIDTH="80%" ALT="Fl_Help_Dialog Window"></CENTER>
<H3>Methods</H3>
<UL>
<LI><A HREF="#Fl_Help_Dialog.Fl_Help_Dialog">Fl_Help_Dialog</A>
<LI><A HREF="#Fl_Help_Dialog.~Fl_Help_Dialog">~Fl_Help_Dialog</A>
<LI><A HREF="#Fl_Help_Dialog.xywh">h</A>
<LI><A HREF="#Fl_Help_Dialog.hide">hide</A>
<LI><A HREF="#Fl_Help_Dialog.load">load</A>
<LI><A HREF="#Fl_Help_Dialog.position">position</A>
<LI><A HREF="#Fl_Help_Dialog.resize">resize</A>
<LI><A HREF="#Fl_Help_Dialog.show">show</A>
<LI><A HREF="#Fl_Help_Dialog.textsize">textsize</A>
<LI><A HREF="#Fl_Help_Dialog.topline">topline</A>
<LI><A HREF="#Fl_Help_Dialog.value">value</A>
<LI><A HREF="#Fl_Help_Dialog.visible">visible</A>
<LI><A HREF="#Fl_Help_Dialog.xywh">w</A>
<LI><A HREF="#Fl_Help_Dialog.xywh">x</A>
<LI><A HREF="#Fl_Help_Dialog.xywh">y</A>
</UL>
<H4><A NAME="Fl_Help_Dialog.Fl_Help_Dialog">Fl_Help_Dialog()</A></H4>
<P>The constructor creates the dialog pictured above.
<H4><A NAME="Fl_Help_Dialog.~Fl_Help_Dialog">~Fl_Help_Dialog()</A></H4>
<P>The destructor destroys the widget and frees all memory that has been
allocated for the current file.
<H4><A NAME="Fl_Help_Dialog.hide">void hide()</A></H4>
<P>Hides the <code>Fl_Help_Dialog</code> window.
<H4><A NAME="Fl_Help_Dialog.load">void load(const char *f)</A></H4>
<P>Loads the specified HTML file into the <CODE>Fl_Help_View</CODE> widget.
The filename can also contain a target name ("filename.html#target").
<H4><A NAME="Fl_Help_Dialog.position">void position(int x, int y)</A></H4>
<P>Set the screen position of the dialog.
<H4><A NAME="Fl_Help_Dialog.resize">void resize(int xx, int yy, int ww, int hh)</A></H4>
<P>Change the position and size of the dialog.
<H4><A NAME="Fl_Help_Dialog.show">void show()</A></H4>
<P>Shows the <code>Fl_Help_Dialog</code> window.
<H4><A NAME="Fl_Help_Dialog.textsize">void textsize(uchar s)<BR>
uchar textsize()</A></H4>
<P>Sets or gets the default text size for the help view.
<H4><A NAME="Fl_Help_Dialog.topline">void topline(const char *n)<BR>
void topline(int n)</A></H4>
<P>Sets the top line in the <CODE>Fl_Help_View</CODE> widget to the named or
numbered line.
<H4><A NAME="Fl_Help_Dialog.value">void value(const char *v)<BR>
const char *value() const</A></H4>
<P>The first form sets the current buffer to the string provided and
reformats the text. It also clears the history of the "back" and
"forward" buttons. The second form returns the current buffer contents.
<H4><A NAME="Fl_Help_Dialog.visible">int visible()</A></H4>
<P>Returns 1 if the <code>Fl_Help_Dialog</code> window is visible.
<H4><A NAME="Fl_Help_Dialog.xywh">int x()<BR>
int y()<BR>
int w()<BR>
int h()<BR>
</A></H4>
<P>Returns the position and size of the help dialog.
</BODY>
</HTML>