]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/richtextxmlhandler.tex
only change the bitmap size for the borderless controls
[wxWidgets.git] / docs / latex / wx / richtextxmlhandler.tex
CommitLineData
5f35b46a
JS
1\section{\class{wxRichTextXMLHandler}}\label{wxrichtextxmlhandler}
2
3A handler for loading and saving content in an XML format specific
4to wxRichTextBuffer. You can either add the handler to the buffer
5and load and save through the buffer or control API, or you can
6create an instance of the handler on the stack and call its
7functions directly.
8
9\wxheading{Derived from}
10
11\helpref{wxRichTextFileHandler}{wxrichtextfilehandler}
12
13\wxheading{Include files}
14
15<wx/richtext/richtextxml.h>
16
17\wxheading{Data structures}
18
19\latexignore{\rtfignore{\wxheading{Members}}}
20
21\membersection{wxRichTextXMLHandler::wxRichTextXMLHandler}\label{wxrichtextxmlhandlerwxrichtextxmlhandler}
22
23\func{}{wxRichTextXMLHandler}{\param{const wxString\& }{name = wxT("XML")}, \param{const wxString\& }{ext = wxT("xml")}, \param{int }{type = wxRICHTEXT\_TYPE\_XML}}
24
25Constructor.
26
27\membersection{wxRichTextXMLHandler::CanLoad}\label{wxrichtextxmlhandlercanload}
28
29\constfunc{bool}{CanLoad}{\void}
30
31Returns \true.
32
33\membersection{wxRichTextXMLHandler::CanSave}\label{wxrichtextxmlhandlercansave}
34
35\constfunc{bool}{CanSave}{\void}
36
37Returns \true.
38
39\membersection{wxRichTextXMLHandler::CreateStyle}\label{wxrichtextxmlhandlercreatestyle}
40
41\func{wxString}{CreateStyle}{\param{const wxTextAttrEx\& }{attr}, \param{bool }{isPara = false}}
42
43Creates XML code for a given character or paragraph style.
44
45\membersection{wxRichTextXMLHandler::DoLoadFile}\label{wxrichtextxmlhandlerdoloadfile}
46
47\func{bool}{DoLoadFile}{\param{wxRichTextBuffer* }{buffer}, \param{wxInputStream\& }{stream}}
48
49Loads buffer context from the given stream.
50
51\membersection{wxRichTextXMLHandler::DoSaveFile}\label{wxrichtextxmlhandlerdosavefile}
52
53\func{bool}{DoSaveFile}{\param{wxRichTextBuffer* }{buffer}, \param{wxOutputStream\& }{stream}}
54
55Saves buffer context to the given stream.
56
57\membersection{wxRichTextXMLHandler::ExportXML}\label{wxrichtextxmlhandlerexportxml}
58
59\func{bool}{ExportXML}{\param{wxOutputStream\& }{stream}, \param{wxMBConv* }{convMem}, \param{wxMBConv* }{convFile}, \param{wxRichTextObject\& }{obj}, \param{int }{level}}
60
61Recursively exports an object to the stream.
62
63\membersection{wxRichTextXMLHandler::GetNodeContent}\label{wxrichtextxmlhandlergetnodecontent}
64
65\func{wxString}{GetNodeContent}{\param{wxXmlNode* }{node}}
66
67Helper function: gets node context.
68
69\membersection{wxRichTextXMLHandler::GetParamNode}\label{wxrichtextxmlhandlergetparamnode}
70
71\func{wxXmlNode*}{GetParamNode}{\param{wxXmlNode* }{node}, \param{const wxString\& }{param}}
72
73Helper function: gets a named parameter from the XML node.
74
75\membersection{wxRichTextXMLHandler::GetParamValue}\label{wxrichtextxmlhandlergetparamvalue}
76
77\func{wxString}{GetParamValue}{\param{wxXmlNode* }{node}, \param{const wxString\& }{param}}
78
79Helper function: gets a named parameter from the XML node.
80
81\membersection{wxRichTextXMLHandler::GetStyle}\label{wxrichtextxmlhandlergetstyle}
82
83\func{bool}{GetStyle}{\param{wxTextAttrEx\& }{attr}, \param{wxXmlNode* }{node}, \param{bool }{isPara = false}}
84
85Helper function: gets style parameters from the given XML node.
86
87\membersection{wxRichTextXMLHandler::GetText}\label{wxrichtextxmlhandlergettext}
88
89\func{wxString}{GetText}{\param{wxXmlNode* }{node}, \param{const wxString\& }{param = wxEmptyString}, \param{bool }{translate = false}}
90
91Helper function: gets text from the node.
92
93\membersection{wxRichTextXMLHandler::HasParam}\label{wxrichtextxmlhandlerhasparam}
94
95\func{bool}{HasParam}{\param{wxXmlNode* }{node}, \param{const wxString\& }{param}}
96
97Helper function: returns \true if the node has the given parameter.
98
99\membersection{wxRichTextXMLHandler::ImportXML}\label{wxrichtextxmlhandlerimportxml}
100
101\func{bool}{ImportXML}{\param{wxRichTextBuffer* }{buffer}, \param{wxXmlNode* }{node}}
102
103Recursively imports an object.
104