1 | <HTML> |
---|
2 | <HEAD> |
---|
3 | <TITLE>Fl_Help_View</TITLE> |
---|
4 | </HEAD> |
---|
5 | <BODY> |
---|
6 | <!-- NEW PAGE --> |
---|
7 | <H2><A name="Fl_Help_View">class Fl_Help_View</A></H2> |
---|
8 | |
---|
9 | <HR> |
---|
10 | |
---|
11 | <H3>Class Hierarchy</H3> |
---|
12 | |
---|
13 | <UL><PRE> |
---|
14 | Fl_Group |
---|
15 | | |
---|
16 | +----<B>Fl_Help_View</B> |
---|
17 | </PRE></UL> |
---|
18 | |
---|
19 | <H3>Include Files</H3> |
---|
20 | |
---|
21 | <UL><PRE> |
---|
22 | #include "Fl_Help_View.h" |
---|
23 | </PRE></UL> |
---|
24 | |
---|
25 | <H3>Description</H3> |
---|
26 | |
---|
27 | <P>The <CODE>Fl_Help_View</CODE> widget displays HTML text. Most HTML 2.0 |
---|
28 | elements are supported, as well as a primitive implementation of tables. |
---|
29 | GIF, JPEG, and PNG images are displayed inline. |
---|
30 | |
---|
31 | <H3>Methods</H3> |
---|
32 | |
---|
33 | <UL> |
---|
34 | |
---|
35 | <LI><A HREF="#Fl_Help_View.Fl_Help_View">Fl_Help_View</A> |
---|
36 | <LI><A HREF="#Fl_Help_View.~Fl_Help_View">~Fl_Help_View</A> |
---|
37 | <LI><A HREF="#Fl_Help_View.directory">directory</A> |
---|
38 | <LI><A HREF="#Fl_Help_View.filename">filename</A> |
---|
39 | <LI><A HREF="#Fl_Help_View.link">link</A> |
---|
40 | <LI><A HREF="#Fl_Help_View.load">load</A> |
---|
41 | <LI><A HREF="#Fl_Help_View.size">size</A> |
---|
42 | <LI><A HREF="#Fl_Help_View.textcolor">textcolor</A> |
---|
43 | <LI><A HREF="#Fl_Help_View.textfont">textfont</A> |
---|
44 | <LI><A HREF="#Fl_Help_View.textsize">textsize</A> |
---|
45 | <LI><A HREF="#Fl_Help_View.title">title</A> |
---|
46 | <LI><A HREF="#Fl_Help_View.topline">topline</A> |
---|
47 | <LI><A HREF="#Fl_Help_View.value">value</A> |
---|
48 | |
---|
49 | </UL> |
---|
50 | |
---|
51 | <H4><A NAME="Fl_Help_View.Fl_Help_View">Fl_Help_View(int xx, int yy, int ww, int hh, const char *l = 0)</A></H4> |
---|
52 | |
---|
53 | <P>The constructor creates the <CODE>Fl_Help_View</CODE> widget at the specified |
---|
54 | position and size. |
---|
55 | |
---|
56 | <H4><A NAME="Fl_Help_View.~Fl_Help_View">~Fl_Help_View()</A></H4> |
---|
57 | |
---|
58 | <P>The destructor destroys the widget and frees all memory that has been |
---|
59 | allocated for the current file. |
---|
60 | |
---|
61 | <H4><A NAME="Fl_Help_View.directory">const char *directory() const</A></H4> |
---|
62 | |
---|
63 | <P>This method returns the current directory (base) path for the file |
---|
64 | in the buffer. |
---|
65 | |
---|
66 | <H4><A NAME="Fl_Help_View.filename">const char *filename() const</A></H4> |
---|
67 | |
---|
68 | <P>This method returns the current filename for the text in the buffer. |
---|
69 | |
---|
70 | <H4><A NAME="Fl_Help_View.link">void link(Fl_Help_Func *fn)</A></H4> |
---|
71 | |
---|
72 | <P>This method assigns a callback function to use when a link is |
---|
73 | followed or a file is loaded (via |
---|
74 | <CODE>Fl_Help_View::load()</CODE>) that requires a different |
---|
75 | file or path. The callback function receives a pointer to the |
---|
76 | <CODE>Fl_Help_View</CODE> widget and the URI or full pathname |
---|
77 | for the file in question. It must return a pathname that can be |
---|
78 | opened as a local file or <TT>NULL</TT>:</P> |
---|
79 | |
---|
80 | <UL><PRE> |
---|
81 | const char *fn(Fl_Widget *w, const char *uri); |
---|
82 | </PRE></UL> |
---|
83 | |
---|
84 | <P>The link function can be used to retrieve remote or virtual |
---|
85 | documents, returning a temporary file that contains the actual |
---|
86 | data. If the link function returns <TT>NULL</TT>, the value of |
---|
87 | the <TT>Fl_Help_View</TT> widget will remain unchanged.</P> |
---|
88 | |
---|
89 | <P>If the link callback cannot handle the URI scheme, it should |
---|
90 | return the <TT>uri</TT> value unchanged or set the <A |
---|
91 | HREF="#Fl_Help_View.value"><TT>value()</TT></A> of the widget |
---|
92 | before returning <TT>NULL</TT>.</P> |
---|
93 | |
---|
94 | <H4><A NAME="Fl_Help_View.load">int load(const char *f)</A></H4> |
---|
95 | |
---|
96 | <P>This method loads the specified file or URL. |
---|
97 | |
---|
98 | <H4><A NAME="Fl_Help_View.size">int size() const</A></H4> |
---|
99 | |
---|
100 | <P>This method returns the length of the buffer text in pixels. |
---|
101 | |
---|
102 | <H4><A NAME="Fl_Help_View.textcolor">void textcolor(Fl_Color c)<BR> |
---|
103 | Fl_Color textcolor() const</A></H4> |
---|
104 | |
---|
105 | <P>The first form sets the default text color. The second returns |
---|
106 | the current default text color. |
---|
107 | |
---|
108 | <H4><A NAME="Fl_Help_View.textfont">void textfont(uchar f)<BR> |
---|
109 | uchar textfont() const</A></H4> |
---|
110 | |
---|
111 | <P>The first form sets the default text font. The second returns |
---|
112 | the current default text font. |
---|
113 | |
---|
114 | <H4><A NAME="Fl_Help_View.textsize">void textsize(uchar s)<BR> |
---|
115 | uchar textsize() const</A></H4> |
---|
116 | |
---|
117 | <P>The first form sets the default text size. The second returns |
---|
118 | the current default text size. |
---|
119 | |
---|
120 | <H4><A NAME="Fl_Help_View.title">const char *title()</A></H4> |
---|
121 | |
---|
122 | <P>This method returns the current document title, or NULL if there |
---|
123 | is no title. |
---|
124 | |
---|
125 | <H4><A NAME="Fl_Help_View.topline">void topline(const char *n)<BR> |
---|
126 | void topline(int)<BR> |
---|
127 | int topline() const</A></H4> |
---|
128 | |
---|
129 | <P>The first two forms scroll the text to the indicated position, either |
---|
130 | with a named destination or by pixel line. |
---|
131 | |
---|
132 | <P>The second form returns the current top line in pixels. |
---|
133 | |
---|
134 | <H4><A NAME="Fl_Help_View.value">void value(const char *v)<BR> |
---|
135 | const char *value() const</A></H4> |
---|
136 | |
---|
137 | <P>The first form sets the current buffer to the string provided and |
---|
138 | reformats the text. The second form returns the current buffer contents. |
---|
139 | |
---|
140 | </BODY> |
---|
141 | </HTML> |
---|