From b0e56bb248b4690fc34505f58b8b795521628ff2 Mon Sep 17 00:00:00 2001 From: Michael R Sweet Date: Thu, 2 Aug 2001 18:31:29 +0000 Subject: Documentation... git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@1529 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/Fl_HelpView.html | 130 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 130 insertions(+) create mode 100644 documentation/Fl_HelpView.html (limited to 'documentation/Fl_HelpView.html') diff --git a/documentation/Fl_HelpView.html b/documentation/Fl_HelpView.html new file mode 100644 index 000000000..e9e5b8a85 --- /dev/null +++ b/documentation/Fl_HelpView.html @@ -0,0 +1,130 @@ + + + HelpView - ESP Widget Set for FLTK + + + + + + +

class HelpView

+ +
+ +

Class Hierarchy

+ + + +

Include Files

+ + + +

Description

+ +

The HelpView widget displays HTML text. Most HTML 2.0 +elements are supported, as well as a primitive implementation of tables. +GIF, JPEG, and PNG images are displayed inline. + +

Methods

+ + + +

HelpView(int xx, int yy, int ww, int hh, const char *l = 0)

+ +

The constructor creates the HelpView widget at the specified +position and size. + +

~HelpView()

+ +

The destructor destroys the widget and frees all memory that has been +allocated for the current file. + +

const char *directory() const

+ +

This method returns the current directory (base) path for the file +in the buffer. + +

const char *filename() const

+ +

This method returns the current filename for the text in the buffer. + +

void link(HelpFunc *fn)

+ +

This method assigns a callback function to use when a link is +followed or a file is loaded (via HelpView::load()) that +requires a different file or path. The callback function receives the +full pathname for the file in question and must return a pathname that +can be opened as a local file. This is used by the +HelpApp widget to support WWW +addresses. + +

int load(const char *f)

+ +

This method loads the specified file or URL. + +

int size() const

+ +

This method returns the length of the buffer text in pixels. + +

void textcolor(Fl_Color c)
+Fl_Color textcolor() const

+ +

The first form sets the default text color. The second returns +the current default text color. + +

void textfont(uchar f)
+uchar textfont() const

+ +

The first form sets the default text font. The second returns +the current default text font. + +

void textsize(uchar s)
+uchar textsize() const

+ +

The first form sets the default text size. The second returns +the current default text size. + +

const char *title()

+ +

This method returns the current document title, or NULL if there +is no title. + +

void topline(const char *n)
+void topline(int)
+int topline() const

+ +

The first two forms scroll the text to the indicated position, either +with a named destination or by pixel line. + +

The second form returns the current top line in pixels. + +

void value(const char *v)
+const char *value() const

+ +

The first form sets the current buffer to the string provided and +reformats the text. The second form returns the current buffer contents. + + + -- cgit v1.2.3