From 497afccb07164373e0de6639e754d7d691f1926f Mon Sep 17 00:00:00 2001 From: Fabien Costantini Date: Tue, 14 Oct 2008 22:12:25 +0000 Subject: Doxygen pdf man: First version added in documentation/fltk.pdf, old doc removed, images, dox files moved to a new src directory. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6431 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/Fl_Help_View.html | 141 ---------------------------------------- 1 file changed, 141 deletions(-) delete mode 100644 documentation/Fl_Help_View.html (limited to 'documentation/Fl_Help_View.html') diff --git a/documentation/Fl_Help_View.html b/documentation/Fl_Help_View.html deleted file mode 100644 index 4b10afda8..000000000 --- a/documentation/Fl_Help_View.html +++ /dev/null @@ -1,141 +0,0 @@ - - - Fl_Help_View - - - -

class Fl_Help_View

- -
- -

Class Hierarchy

- - - -

Include Files

- - - -

Description

- -

The Fl_Help_View 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

- - - -

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

- -

The constructor creates the Fl_Help_View widget at the specified -position and size. - -

~Fl_Help_View()

- -

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(Fl_Help_Func *fn)

- -

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:

- - - -

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.

- -

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.

- -

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