1//---------------------------------------------------------------------------
2// This file is generated by wxPython's SIP generator.  Do not edit by hand.
3//
4// Copyright: (c) 2018 by Total Control Software
5// License:   wxWindows License
6//
7// This file will be included by _html.sip
8//
9//---------------------------------------------------------------------------
10
11//---------------------------------------------------------------------------
12
13class wxHtmlTag
14{
15    %Docstring
16        This class represents a single HTML tag.
17    %End
18    %TypeHeaderCode
19        #include <wx/html/htmltag.h>
20    %End
21
22public:
23    wxString GetAllParams() const;
24    %Docstring
25        GetAllParams() -> String
26
27        Returns a string containing all parameters.
28    %End
29
30    int GetBeginPos() const   /Deprecated/;
31    %Docstring
32        GetBeginPos() -> int
33
34        Returns beginning position of the text between this tag and paired
35        ending tag.
36    %End
37
38    int GetEndPos1() const   /Deprecated/;
39    %Docstring
40        GetEndPos1() -> int
41
42        Returns ending position of the text between this tag and paired ending
43        tag.
44    %End
45
46    int GetEndPos2() const   /Deprecated/;
47    %Docstring
48        GetEndPos2() -> int
49
50        Returns ending position 2 of the text between this tag and paired
51        ending tag.
52    %End
53
54    wxString GetName() const;
55    %Docstring
56        GetName() -> String
57
58        Returns tag's name.
59    %End
60
61    wxString GetParam(
62        const wxString & par,
63        bool with_quotes = false
64    ) const;
65    %Docstring
66        GetParam(par, with_quotes=False) -> String
67
68        Returns the value of the parameter.
69    %End
70
71    bool GetParamAsColour(
72        const wxString & par,
73        wxColour * clr   /Out/
74    ) const;
75    %Docstring
76        GetParamAsColour(par) -> (bool, clr)
77
78        Interprets tag parameter par as colour specification and saves its
79        value into wxColour variable pointed by clr.
80    %End
81
82    bool GetParamAsInt(
83        const wxString & par,
84        int * value   /Out/
85    ) const;
86    %Docstring
87        GetParamAsInt(par) -> (bool, value)
88
89        Interprets tag parameter par as an integer and saves its value into
90        int variable pointed by value.
91    %End
92
93    bool GetParamAsString(
94        const wxString & par,
95        wxString * value
96    ) const;
97    %Docstring
98        GetParamAsString(par, value) -> bool
99
100        Get the value of the parameter.
101    %End
102
103    bool HasEnding() const;
104    %Docstring
105        HasEnding() -> bool
106
107        Returns true if this tag is paired with ending tag, false otherwise.
108    %End
109
110    bool HasParam(
111        const wxString & par
112    ) const;
113    %Docstring
114        HasParam(par) -> bool
115
116        Returns true if the tag has a parameter of the given name.
117    %End
118
119    static
120    bool ParseAsColour(
121        const wxString & str,
122        wxColour * clr   /Out/
123    );
124    %Docstring
125        ParseAsColour(str) -> (bool, clr)
126
127        Parses the given string as an HTML colour.
128    %End
129
130    private:
131        wxHtmlTag(const wxHtmlTag&);
132
133
134    public:
135
136
137    %Property(name=AllParams, get=GetAllParams)
138    %Property(name=BeginPos, get=GetBeginPos)
139    %Property(name=EndPos1, get=GetEndPos1)
140    %Property(name=EndPos2, get=GetEndPos2)
141    %Property(name=Name, get=GetName)
142};  // end of class wxHtmlTag
143
144
145
146//---------------------------------------------------------------------------
147
148