The Fl_Help_View widget displays HTML text. More...

#include <Fl_Help_View.H>

Inheritance diagram for Fl_Help_View:

Public Member Functions
void	clear_selection ()
	Removes the current text selection. More...

const char *	directory () const
	Returns the current directory for the text in the buffer. More...

const char *	filename () const
	Returns the current filename for the text in the buffer. More...

int	find (const char *s, int p=0)
	Finds the specified string `s` at starting position `p`. More...

	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.

void	leftline (int)
	Scrolls the text to the indicated position, given a pixel column. More...

int	leftline () const
	Gets the left position in pixels. More...

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. More...

int	load (const char *f)
	Loads the specified file. More...

void	resize (int, int, int, int)
	Resizes the help widget. More...

int	scrollbar_size () const
	Gets the current size of the scrollbars' troughs, in pixels. More...

void	scrollbar_size (int newSize)
	Sets the pixel size of the scrollbars' troughs to `newSize`, in pixels. More...

void	select_all ()
	Selects all the text in the view. More...

int	size () const
	Gets the size of the help view. More...

void	size (int W, int H)

void	textcolor (Fl_Color c)
	Sets the default text color. More...

Fl_Color	textcolor () const
	Returns the current default text color. More...

void	textfont (Fl_Font f)
	Sets the default text font. More...

Fl_Font	textfont () const
	Returns the current default text font. More...

void	textsize (Fl_Fontsize s)
	Sets the default text size. More...

Fl_Fontsize	textsize () const
	Gets the default text size. More...

const char *	title ()
	Returns the current document title, or NULL if there is no title. More...

void	topline (const char *n)
	Scrolls the text to the indicated position, given a named destination. More...

void	topline (int)
	Scrolls the text to the indicated position, given a pixel line. More...

int	topline () const
	Returns the current top line in pixels. More...

void	value (const char *val)
	Sets the current help text buffer to the string provided and reformats the text. More...

const char *	value () const
	Returns the current buffer contents. More...

	~Fl_Help_View ()
	Destroys the Fl_Help_View widget. More...

Public Member Functions inherited from Fl_Group
Fl_Widget *&	_ddfdesign_kludge ()
	This is for forms compatibility only.

void	add (Fl_Widget &)
	The widget is removed from its current group (if any) and then added to the end of this group.

void	add (Fl_Widget *o)
	See void Fl_Group::add(Fl_Widget &w)

void	add_resizable (Fl_Widget &o)
	Adds a widget to the group and makes it the resizable widget.

Fl_Widget const	array () const
	Returns a pointer to the array of children. More...

virtual Fl_Group *	as_group ()
	Returns an Fl_Group pointer if this widget is an Fl_Group. More...

void	begin ()
	Sets the current group so you can build the widget tree by just constructing the widgets. More...

Fl_Widget *	child (int n) const
	Returns array()[n]. More...

int	children () const
	Returns how many child widgets the group has.

void	clear ()
	Deletes all child widgets from memory recursively. More...

void	clip_children (int c)
	Controls whether the group widget clips the drawing of child widgets to its bounding box. More...

unsigned int	clip_children ()
	Returns the current clipping mode. More...

void	end ()
	Exactly the same as current(this->parent()). More...

int	find (const Fl_Widget *) const
	Searches the child array for the widget and returns the index. More...

int	find (const Fl_Widget &o) const
	See int Fl_Group::find(const Fl_Widget *w) const.

	Fl_Group (int, int, int, int, const char *=0)
	Creates a new Fl_Group widget using the given position, size, and label string. More...

void	focus (Fl_Widget *W)

void	forms_end ()
	This is for forms compatibility only.

void	init_sizes ()
	Resets the internal array of widget sizes and positions. More...

void	insert (Fl_Widget &, int i)
	The widget is removed from its current group (if any) and then inserted into this group. More...

void	insert (Fl_Widget &o, Fl_Widget *before)
	This does insert(w, find(before)). More...

void	remove (int index)
	Removes the widget at `index` from the group but does not delete it. More...

void	remove (Fl_Widget &)
	Removes a widget from the group but does not delete it. More...

void	remove (Fl_Widget *o)
	Removes the widget `o` from the group. More...

void	resizable (Fl_Widget &o)
	See void Fl_Group::resizable(Fl_Widget *box)

void	resizable (Fl_Widget *o)
	The resizable widget defines the resizing box for the group. More...

Fl_Widget *	resizable () const
	See void Fl_Group::resizable(Fl_Widget *box)

virtual	~Fl_Group ()
	The destructor also deletes all the children. More...

Public Member Functions inherited from Fl_Widget
void	_clear_fullscreen ()

void	_set_fullscreen ()

void	activate ()
	Activates the widget. More...

unsigned int	active () const
	Returns whether the widget is active. More...

int	active_r () const
	Returns whether the widget and all of its parents are active. More...

Fl_Align	align () const
	Gets the label alignment. More...

void	align (Fl_Align alignment)
	Sets the label alignment. More...

long	argument () const
	Gets the current user data (long) argument that is passed to the callback function.

void	argument (long v)
	Sets the current user data (long) argument that is passed to the callback function. More...

virtual class Fl_Gl_Window *	as_gl_window ()
	Returns an Fl_Gl_Window pointer if this widget is an Fl_Gl_Window. More...

virtual Fl_Window *	as_window ()
	Returns an Fl_Window pointer if this widget is an Fl_Window. More...

Fl_Boxtype	box () const
	Gets the box type of the widget. More...

void	box (Fl_Boxtype new_box)
	Sets the box type for the widget. More...

Fl_Callback_p	callback () const
	Gets the current callback function for the widget. More...

void	callback (Fl_Callback cb, void p)
	Sets the current callback function for the widget. More...

void	callback (Fl_Callback *cb)
	Sets the current callback function for the widget. More...

void	callback (Fl_Callback0 *cb)
	Sets the current callback function for the widget. More...

void	callback (Fl_Callback1 *cb, long p=0)
	Sets the current callback function for the widget. More...

unsigned int	changed () const
	Checks if the widget value changed since the last callback. More...

void	clear_active ()
	Marks the widget as inactive without sending events or changing focus. More...

void	clear_changed ()
	Marks the value of the widget as unchanged. More...

void	clear_damage (uchar c=0)
	Clears or sets the damage flags. More...

void	clear_output ()
	Sets a widget to accept input. More...

void	clear_visible ()
	Hides the widget. More...

void	clear_visible_focus ()
	Disables keyboard focus navigation with this widget. More...

Fl_Color	color () const
	Gets the background color of the widget. More...

void	color (Fl_Color bg)
	Sets the background color of the widget. More...

void	color (Fl_Color bg, Fl_Color sel)
	Sets the background and selection color of the widget. More...

Fl_Color	color2 () const
	For back compatibility only. More...

void	color2 (unsigned a)
	For back compatibility only. More...

int	contains (const Fl_Widget *w) const
	Checks if w is a child of this widget. More...

void	copy_label (const char *new_label)
	Sets the current label. More...

void	copy_tooltip (const char *text)
	Sets the current tooltip text. More...

uchar	damage () const
	Returns non-zero if draw() needs to be called. More...

void	damage (uchar c)
	Sets the damage bits for the widget. More...

void	damage (uchar c, int x, int y, int w, int h)
	Sets the damage bits for an area inside the widget. More...

int	damage_resize (int, int, int, int)
	Internal use only. More...

void	deactivate ()
	Deactivates the widget. More...

Fl_Image *	deimage ()
	Gets the image that is used as part of the widget label. More...

const Fl_Image *	deimage () const

void	deimage (Fl_Image *img)
	Sets the image to use as part of the widget label. More...

void	deimage (Fl_Image &img)
	Sets the image to use as part of the widget label. More...

void	do_callback ()
	Calls the widget callback. More...

void	do_callback (Fl_Widget *o, long arg)
	Calls the widget callback. More...

void	do_callback (Fl_Widget o, void arg=0)
	Calls the widget callback. More...

void	draw_label (int, int, int, int, Fl_Align) const
	Draws the label in an arbitrary bounding box with an arbitrary alignment. More...

int	h () const
	Gets the widget height. More...

virtual void	hide ()
	Makes a widget invisible. More...

Fl_Image *	image ()
	Gets the image that is used as part of the widget label. More...

const Fl_Image *	image () const

void	image (Fl_Image *img)
	Sets the image to use as part of the widget label. More...

void	image (Fl_Image &img)
	Sets the image to use as part of the widget label. More...

int	inside (const Fl_Widget *wgt) const
	Checks if this widget is a child of `wgt`. More...

const char *	label () const
	Gets the current label text. More...

void	label (const char *text)
	Sets the current label pointer. More...

void	label (Fl_Labeltype a, const char *b)
	Shortcut to set the label text and type in one call. More...

Fl_Color	labelcolor () const
	Gets the label color. More...

void	labelcolor (Fl_Color c)
	Sets the label color. More...

Fl_Font	labelfont () const
	Gets the font to use. More...

void	labelfont (Fl_Font f)
	Sets the font to use. More...

Fl_Fontsize	labelsize () const
	Gets the font size in pixels. More...

void	labelsize (Fl_Fontsize pix)
	Sets the font size in pixels. More...

Fl_Labeltype	labeltype () const
	Gets the label type. More...

void	labeltype (Fl_Labeltype a)
	Sets the label type. More...

void	measure_label (int &ww, int &hh) const
	Sets width ww and height hh accordingly with the label size. More...

unsigned int	output () const
	Returns if a widget is used for output only. More...

Fl_Group *	parent () const
	Returns a pointer to the parent widget. More...

void	parent (Fl_Group *p)
	Internal use only - "for hacks only". More...

void	position (int X, int Y)
	Repositions the window or widget. More...

void	redraw ()
	Schedules the drawing of the widget. More...

void	redraw_label ()
	Schedules the drawing of the label. More...

Fl_Color	selection_color () const
	Gets the selection color. More...

void	selection_color (Fl_Color a)
	Sets the selection color. More...

void	set_active ()
	Marks the widget as active without sending events or changing focus. More...

void	set_changed ()
	Marks the value of the widget as changed. More...

void	set_output ()
	Sets a widget to output only. More...

void	set_visible ()
	Makes the widget visible. More...

void	set_visible_focus ()
	Enables keyboard focus navigation with this widget. More...

virtual void	show ()
	Makes a widget visible. More...

void	size (int W, int H)
	Changes the size of the widget. More...

int	take_focus ()
	Gives the widget the keyboard focus. More...

unsigned int	takesevents () const
	Returns if the widget is able to take events. More...

int	test_shortcut ()
	Returns true if the widget's label contains the entered '&x' shortcut. More...

const char *	tooltip () const
	Gets the current tooltip text. More...

void	tooltip (const char *text)
	Sets the current tooltip text. More...

Fl_Window *	top_window () const
	Returns a pointer to the top-level window for the widget. More...

Fl_Window *	top_window_offset (int &xoff, int &yoff) const
	Finds the x/y offset of the current widget relative to the top-level window. More...

uchar	type () const
	Gets the widget type. More...

void	type (uchar t)
	Sets the widget type. More...

int	use_accents_menu ()
	Returns non zero if MAC_USE_ACCENTS_MENU flag is set, 0 otherwise.

void *	user_data () const
	Gets the user data for this widget. More...

void	user_data (void *v)
	Sets the user data for this widget. More...

unsigned int	visible () const
	Returns whether a widget is visible. More...

void	visible_focus (int v)
	Modifies keyboard focus navigation. More...

unsigned int	visible_focus ()
	Checks whether this widget has a visible focus. More...

int	visible_r () const
	Returns whether a widget and all its parents are visible. More...

int	w () const
	Gets the widget width. More...

Fl_When	when () const
	Returns the conditions under which the callback is called. More...

void	when (uchar i)
	Sets the flags used to decide when a callback is called. More...

Fl_Window *	window () const
	Returns a pointer to the nearest parent window up the widget hierarchy. More...

int	x () const
	Gets the widget position in its window. More...

int	y () const
	Gets the widget position in its window. More...

virtual	~Fl_Widget ()
	Destroys the widget. More...

Additional Inherited Members
Static Public Member Functions inherited from Fl_Group
static Fl_Group *	current ()
	Returns the currently active group. More...

static void	current (Fl_Group *g)
	Sets the current group. More...

Static Public Member Functions inherited from Fl_Widget
static void	default_callback (Fl_Widget cb, void d)
	Sets the default callback for all widgets. More...

static unsigned int	label_shortcut (const char *t)
	Returns the Unicode value of the '&x' shortcut in a given text. More...

static int	test_shortcut (const char *, const bool require_alt=false)
	Returns true if the given text `t` contains the entered '&x' shortcut. More...

Protected Types inherited from Fl_Widget
enum	{ INACTIVE = 1<<0, INVISIBLE = 1<<1, OUTPUT = 1<<2, NOBORDER = 1<<3, FORCE_POSITION = 1<<4, NON_MODAL = 1<<5, SHORTCUT_LABEL = 1<<6, CHANGED = 1<<7, OVERRIDE = 1<<8, VISIBLE_FOCUS = 1<<9, COPIED_LABEL = 1<<10, CLIP_CHILDREN = 1<<11, MENU_WINDOW = 1<<12, TOOLTIP_WINDOW = 1<<13, MODAL = 1<<14, NO_OVERLAY = 1<<15, GROUP_RELATIVE = 1<<16, COPIED_TOOLTIP = 1<<17, FULLSCREEN = 1<<18, MAC_USE_ACCENTS_MENU = 1<<19, USERFLAG3 = 1<<29, USERFLAG2 = 1<<30, USERFLAG1 = 1<<31 }
	flags possible values enumeration. More...

Protected Member Functions inherited from Fl_Group
void	draw_child (Fl_Widget &widget) const
	Forces a child to redraw. More...

void	draw_children ()
	Draws all children of the group. More...

void	draw_outside_label (const Fl_Widget &widget) const
	Parents normally call this to draw outside labels of child widgets. More...

int *	sizes ()
	Returns the internal array of widget sizes and positions. More...

void	update_child (Fl_Widget &widget) const
	Draws a child only if it needs it. More...

Protected Member Functions inherited from Fl_Widget
void	clear_flag (unsigned int c)
	Clears a flag in the flags mask.

void	draw_backdrop () const
	If FL_ALIGN_IMAGE_BACKDROP is set, the image or deimage will be drawn.

void	draw_box () const
	Draws the widget box according its box style.

void	draw_box (Fl_Boxtype t, Fl_Color c) const
	Draws a box of type t, of color c at the widget's position and size. More...

void	draw_box (Fl_Boxtype t, int x, int y, int w, int h, Fl_Color c) const
	Draws a box of type t, of color c at the position X,Y and size W,H. More...

void	draw_focus ()
	draws a focus rectangle around the widget

void	draw_focus (Fl_Boxtype t, int x, int y, int w, int h) const
	Draws a focus box for the widget at the given position and size.

void	draw_label () const
	Draws the widget's label at the defined label position. More...

void	draw_label (int, int, int, int) const
	Draws the label in an arbitrary bounding box. More...

	Fl_Widget (int x, int y, int w, int h, const char *label=0L)
	Creates a widget at the given position and size. More...

unsigned int	flags () const
	Gets the widget flags mask.

void	h (int v)
	Internal use only. More...

void	set_flag (unsigned int c)
	Sets a flag in the flags mask.

void	w (int v)
	Internal use only. More...

void	x (int v)
	Internal use only. More...

void	y (int v)
	Internal use only. More...

Detailed 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.

Supported HTML tags:

A: HREF/NAME
B
BODY: BGCOLOR/TEXT/LINK
BR
CENTER
CODE
DD
DL
DT
EM
FONT: COLOR/SIZE/FACE=(helvetica/arial/sans/times/serif/symbol/courier)
H1/H2/H3/H4/H5/H6
HEAD
HR
I
IMG: SRC/WIDTH/HEIGHT/ALT
KBD
LI
OL
P
PRE
STRONG
TABLE: TH/TD/TR/BORDER/BGCOLOR/COLSPAN/ALIGN=CENTER|RIGHT|LEFT
TITLE
TT
U
UL
VAR

Supported color names:

black,red,green,yellow,blue,magenta,fuchsia,cyan,aqua,white,gray,grey,lime,maroon,navy,olive,purple,silver,teal.

Supported urls:

Internal: file:
External: http: ftp: https: ipp: mailto: news:

Quoted char names:

Aacute aacute Acirc acirc acute AElig aelig Agrave agrave amp Aring aring Atilde atilde Auml auml
brvbar bull
Ccedil ccedil cedil cent copy curren
deg divide
Eacute eacute Ecirc ecirc Egrave egrave ETH eth Euml euml euro
frac12 frac14 frac34
gt
Iacute iacute Icirc icirc iexcl Igrave igrave iquest Iuml iuml
laquo lt
macr micro middot
nbsp not Ntilde ntilde
Oacute oacute Ocirc ocirc Ograve ograve ordf ordm Oslash oslash Otilde otilde Ouml ouml
para premil plusmn pound
quot
raquo reg
sect shy sup1 sup2 sup3 szlig
THORN thorn times trade
Uacute uacute Ucirc ucirc Ugrave ugrave uml Uuml uuml
Yacute yacute
yen Yuml yuml

Constructor & Destructor Documentation

Fl_Help_View::~Fl_Help_View ( )

Destroys the Fl_Help_View widget.

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

Member Function Documentation

void Fl_Help_View::clear_selection ( )

Removes the current text selection.

const char* Fl_Help_View::directory ( ) const

inline

Returns the current directory for the text in the buffer.

const char* Fl_Help_View::filename ( ) const

inline

Returns the current filename for the text in the buffer.

int Fl_Help_View::find	(	const char *	s,
		int	p = `0`
	)

Finds the specified string s at starting position p.

Returns: the matching position or -1 if not found

void Fl_Help_View::leftline ( int left )

Scrolls the text to the indicated position, given a pixel column.

If the given pixel value left is out of range, then the text is scrolled to the left or right side of the document, resp.

Parameters

[in] left left column number in pixels (0 = left side)

int Fl_Help_View::leftline ( ) const

inline

Gets the left position in pixels.

void Fl_Help_View::link ( Fl_Help_Func * fn )

inline

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:

const char *fn(Fl_Widget *w, const char *uri);

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 Fl_Help_View::load ( const char * f )

Loads the specified file.

This method loads the specified file or URL.

void Fl_Help_View::resize	(	int	xx,
		int	yy,
		int	ww,
		int	hh
	)

virtual

Resizes the help widget.

Reimplemented from Fl_Group.

int Fl_Help_View::scrollbar_size ( ) const

inline

Gets the current size of the scrollbars' troughs, in pixels.

If this value is zero (default), this widget will use the Fl::scrollbar_size() value as the scrollbar's width.

Returns: Scrollbar size in pixels, or 0 if the global Fl::scrollbar_size() is being used.

See Also: Fl::scrollbar_size(int)

void Fl_Help_View::scrollbar_size ( int newSize )

inline

Sets the pixel size of the scrollbars' troughs to newSize, in pixels.

Normally you should not need this method, and should use Fl::scrollbar_size(int) instead to manage the size of ALL your widgets' scrollbars. This ensures your application has a consistent UI, is the default behavior, and is normally what you want.

Only use THIS method if you really need to override the global scrollbar size. The need for this should be rare.

Setting newSize to the special value of 0 causes the widget to track the global Fl::scrollbar_size(), which is the default.

Parameters

[in] newSize Sets the scrollbar size in pixels.
If 0 (default), scrollbar size tracks the global Fl::scrollbar_size()

See Also: Fl::scrollbar_size()

void Fl_Help_View::select_all ( )

Selects all the text in the view.

int Fl_Help_View::size ( ) const

inline

Gets the size of the help view.

void Fl_Help_View::textcolor ( Fl_Color c )

inline

Sets the default text color.

Fl_Color Fl_Help_View::textcolor ( ) const

inline

Returns the current default text color.

void Fl_Help_View::textfont ( Fl_Font f )

inline

Sets the default text font.

Fl_Font Fl_Help_View::textfont ( ) const

inline

Returns the current default text font.

void Fl_Help_View::textsize ( Fl_Fontsize s )

inline

Sets the default text size.

Fl_Fontsize Fl_Help_View::textsize ( ) const

inline

Gets the default text size.

const char* Fl_Help_View::title ( )

inline

Returns the current document title, or NULL if there is no title.

void Fl_Help_View::topline ( const char * n )

Scrolls the text to the indicated position, given a named destination.

Parameters

[in] n target name

void Fl_Help_View::topline ( int top )

Scrolls the text to the indicated position, given a pixel line.

If the given pixel value top is out of range, then the text is scrolled to the top or bottom of the document, resp.

Parameters

[in] top top line number in pixels (0 = start of document)

int Fl_Help_View::topline ( ) const

inline

Returns the current top line in pixels.

void Fl_Help_View::value ( const char * val )

Sets the current help text buffer to the string provided and reformats the text.

The provided character string val is copied internally and will be freed when value() is called again, or when the widget is destroyed.

If val is NULL, then the widget is cleared.

const char* Fl_Help_View::value ( ) const

inline

Returns the current buffer contents.

The documentation for this class was generated from the following files:

Fl_Help_View.H
Fl_Help_View.cxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation