1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
/////////////////////////////////////////////////////////////////////////////
// Name: html/htmltag.h
// Purpose: interface of wxHtmlTag
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@class wxHtmlTag
This class represents a single HTML tag.
It is used by @ref overview_html_handlers "tag handlers".
@library{wxhtml}
@category{html}
*/
class wxHtmlTag
{
protected:
/**
Constructor. You will probably never have to construct a wxHtmlTag object
yourself. Feel free to ignore the constructor parameters.
Have a look at @c src/html/htmlpars.cpp if you're interested in creating it.
*/
wxHtmlTag(wxHtmlTag* parent, const wxString* source,
const const_iterator& pos, const const_iterator& end_pos,
wxHtmlTagsCache* cache, wxHtmlEntitiesParser* entParser);
public:
/**
Returns a string containing all parameters.
Example: tag contains \<FONT SIZE=+2 COLOR="#000000"\>.
Call to tag.GetAllParams() would return @c 'SIZE=+2 COLOR="#000000"'.
*/
wxString GetAllParams() const;
/**
Returns beginning position of the text @e between this tag and paired
ending tag. See explanation (returned position is marked with '|'):
@code
bla bla bla <MYTAG> bla bla internal text</MYTAG> bla bla
|
@endcode
@deprecated @todo provide deprecation description
*/
int GetBeginPos() const;
/**
Returns ending position of the text @e between this tag and paired
ending tag. See explanation (returned position is marked with '|'):
@code
bla bla bla <MYTAG> bla bla internal text</MYTAG> bla bla
|
@endcode
@deprecated @todo provide deprecation description
*/
int GetEndPos1() const;
/**
Returns ending position 2 of the text @e between this tag and paired
ending tag. See explanation (returned position is marked with '|'):
@code
bla bla bla <MYTAG> bla bla internal text</MYTAG> bla bla
|
@endcode
@deprecated @todo provide deprecation description
*/
int GetEndPos2() const;
/**
Returns tag's name. The name is always in uppercase and it doesn't contain
" or '/' characters. (So the name of \<FONT SIZE=+2\> tag is "FONT"
and name of \</table\> is "TABLE").
*/
wxString GetName() const;
/**
Returns the value of the parameter.
You should check whether the parameter exists or not (use
wxHtmlTag::HasParam) first or use GetParamAsString() if you need to
distinguish between non-specified and empty parameter values.
@param par
The parameter's name.
@param with_quotes
@true if you want to get quotes as well. See example.
Example:
@code
...
// you have wxHtmlTag variable tag which is equal to the
// HTML tag <FONT SIZE=+2 COLOR="#0000FF">
dummy = tag.GetParam("SIZE");
// dummy == "+2"
dummy = tag.GetParam("COLOR");
// dummy == "#0000FF"
dummy = tag.GetParam("COLOR", true);
// dummy == "\"#0000FF\"" -- see the difference!!
@endcode
*/
wxString GetParam(const wxString& par, bool with_quotes = false) const;
/**
Interprets tag parameter @a par as colour specification and saves its value
into wxColour variable pointed by @a clr.
Returns @true on success and @false if @a par is not colour specification or
if the tag has no such parameter.
@see ParseAsColour()
*/
bool GetParamAsColour(const wxString& par, wxColour* clr) const;
/**
Interprets tag parameter @a par as an integer and saves its value
into int variable pointed by @a value.
Returns @true on success and @false if @a par is not an integer or
if the tag has no such parameter.
*/
bool GetParamAsInt(const wxString& par, int* value) const;
/**
Get the value of the parameter.
If the tag doesn't have such parameter at all, simply returns @false.
Otherwise, fills @a value with the parameter value and returns @true.
@param par
The parameter's name.
@param value
Pointer to the string to be filled with the parameter value, must
be non-@NULL.
@since 3.0
*/
bool GetParamAsString(const wxString& par, wxString* value) const;
/**
Returns @true if this tag is paired with ending tag, @false otherwise.
See the example of HTML document:
@code
<html><body>
Hello<p>
How are you?
<p align=center>This is centered...</p>
Oops<br>Oooops!
</body></html>
@endcode
In this example tags HTML and BODY have ending tags, first P and BR
doesn't have ending tag while the second P has.
The third P tag (which is ending itself) of course doesn't have ending tag.
*/
bool HasEnding() const;
/**
Returns @true if the tag has a parameter of the given name.
Example: \<FONT SIZE=+2 COLOR="\#FF00FF"\> has two parameters named
"SIZE" and "COLOR".
@param par
the parameter you're looking for.
*/
bool HasParam(const wxString& par) const;
/**
Parses the given string as an HTML colour.
This function recognizes the standard named HTML 4 colours as well as
the usual RGB syntax.
@since 2.9.1
@see wxColour::Set()
@return @true if the string was successfully parsed and @a clr was
filled with the result or @false otherwise.
*/
static bool ParseAsColour(const wxString& str, wxColour *clr);
//@{
/**
This method scans the given parameter. Usage is exactly the same as sscanf's
usage except that you don't pass a string but a parameter name as the first
argument and you can only retrieve one value (i.e. you can use only one "%"
element in @a format).
@param par
The name of the tag you want to query
@param format
scanf()-like format string.
@param value
pointer to a variable to store the value in
*/
int ScanParam(const wxString& par, const wchar_t* format, void* value) const;
int ScanParam(const wxString& par, const char* format, void* value) const;
//@}
};
|
