]>
git.saurik.com Git - wxWidgets.git/blob - interface/html/htmltag.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: html/htmltag.h
3 // Purpose: interface of wxHtmlTag
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
11 @headerfile htmltag.h wx/html/htmltag.h
13 This class represents a single HTML tag.
14 It is used by @ref overview_handlers "tag handlers".
23 Constructor. You will probably never have to construct a wxHtmlTag object
24 yourself. Feel free to ignore the constructor parameters.
25 Have a look at src/html/htmlpars.cpp if you're interested in creating it.
27 wxHtmlTag(wxHtmlTag
* parent
, const wxString
& source
, int pos
,
28 int end_pos
, wxHtmlTagsCache
* cache
,
29 wxHtmlEntitiesParser
* entParser
);
32 Returns a string containing all parameters.
33 Example : tag contains @c FONT SIZE=+2 COLOR="#000000". Call to
34 tag.GetAllParams() would return @c SIZE=+2 COLOR="#000000".
36 const wxString
GetAllParams() const;
39 Returns beginning position of the text @e between this tag and paired
41 See explanation (returned position is marked with '|'):
43 int GetBeginPos() const;
46 Returns ending position of the text @e between this tag and paired
48 See explanation (returned position is marked with '|'):
50 int GetEndPos1() const;
53 Returns ending position 2 of the text @e between this tag and paired
55 See explanation (returned position is marked with '|'):
57 int GetEndPos2() const;
60 Returns tag's name. The name is always in uppercase and it doesn't contain
61 " or '/' characters. (So the name of @c FONT SIZE=+2 tag is "FONT"
62 and name of @c /table is "TABLE")
64 wxString
GetName() const;
67 Returns the value of the parameter. You should check whether the
68 parameter exists or not (use wxHtmlTag::HasParam) first.
73 @true if you want to get quotes as well. See example.
75 wxString
GetParam(const wxString
& par
, bool with_quotes
= false) const;
78 Interprets tag parameter @a par as colour specification and saves its value
79 into wxColour variable pointed by @e clr.
80 Returns @true on success and @false if @a par is not colour specification or
81 if the tag has no such parameter.
83 bool GetParamAsColour(const wxString
& par
, wxColour
* clr
) const;
86 Interprets tag parameter @a par as an integer and saves its value
87 into int variable pointed by @e value.
88 Returns @true on success and @false if @a par is not an integer or
89 if the tag has no such parameter.
91 bool GetParamAsInt(const wxString
& par
, int* value
) const;
94 Returns @true if this tag is paired with ending tag, @false otherwise.
95 See the example of HTML document:
97 In this example tags HTML and BODY have ending tags, first P and BR
98 doesn't have ending tag while the second P has. The third P tag (which
99 is ending itself) of course doesn't have ending tag.
101 bool HasEnding() const;
104 Returns @true if the tag has a parameter of the given name.
105 Example : @c FONT SIZE=+2 COLOR="#FF00FF" has two parameters named
109 the parameter you're looking for.
111 bool HasParam(const wxString
& par
) const;
114 This method scans the given parameter. Usage is exactly the same as sscanf's
115 usage except that you don't pass a string but a parameter name as the first
117 and you can only retrieve one value (i.e. you can use only one "%" element
121 The name of the tag you want to query
123 scanf()-like format string.
125 pointer to a variable to store the value in
127 wxString
ScanParam(const wxString
& par
, const wxChar
* format
,