git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/richtextxmlhandler.tex

... / ...

Commit	Line	Data
	1	\section{\class{wxRichTextXMLHandler}}\label{wxrichtextxmlhandler}
	2
	3	A handler for loading and saving content in an XML format specific
	4	to wxRichTextBuffer. You can either add the handler to the buffer
	5	and load and save through the buffer or control API, or you can
	6	create an instance of the handler on the stack and call its
	7	functions directly.
	8
	9	\wxheading{Handler flags}
	10
	11	The following flags can be used with this handler, via
	12	the handler's SetFlags function or the buffer or control's
	13	SetHandlerFlags function:
	14
	15	\twocolwidtha{7cm}
	16	\begin{twocollist}\itemsep=0pt
	17	\twocolitem{\windowstyle{wxRICHTEXT\_HANDLER\_INCLUDE\_STYLESHEET}}{Include the style sheet in loading and saving operations.}
	18	\end{twocollist}
	19
	20	\wxheading{Derived from}
	21
	22	\helpref{wxRichTextFileHandler}{wxrichtextfilehandler}\\
	23	\helpref{wxObject}{wxobject}
	24
	25	\wxheading{Include files}
	26
	27	<wx/richtext/richtextxml.h>
	28
	29	\wxheading{Library}
	30
	31	\helpref{wxRichtext}{librarieslist}
	32
	33	\wxheading{Data structures}
	34
	35	\latexignore{\rtfignore{\wxheading{Members}}}
	36
	37	\membersection{wxRichTextXMLHandler::wxRichTextXMLHandler}\label{wxrichtextxmlhandlerwxrichtextxmlhandler}
	38
	39	\func{}{wxRichTextXMLHandler}{\param{const wxString\& }{name = wxT("XML")}, \param{const wxString\& }{ext = wxT("xml")}, \param{int }{type = wxRICHTEXT\_TYPE\_XML}}
	40
	41	Constructor.
	42
	43	\membersection{wxRichTextXMLHandler::CanLoad}\label{wxrichtextxmlhandlercanload}
	44
	45	\constfunc{bool}{CanLoad}{\void}
	46
	47	Returns \true.
	48
	49	\membersection{wxRichTextXMLHandler::CanSave}\label{wxrichtextxmlhandlercansave}
	50
	51	\constfunc{bool}{CanSave}{\void}
	52
	53	Returns \true.
	54
	55	\membersection{wxRichTextXMLHandler::CreateStyle}\label{wxrichtextxmlhandlercreatestyle}
	56
	57	\func{wxString}{CreateStyle}{\param{const wxTextAttr\& }{attr}, \param{bool }{isPara = false}}
	58
	59	Creates XML code for a given character or paragraph style.
	60
	61	\membersection{wxRichTextXMLHandler::DoLoadFile}\label{wxrichtextxmlhandlerdoloadfile}
	62
	63	\func{bool}{DoLoadFile}{\param{wxRichTextBuffer* }{buffer}, \param{wxInputStream\& }{stream}}
	64
	65	Loads buffer context from the given stream.
	66
	67	\membersection{wxRichTextXMLHandler::DoSaveFile}\label{wxrichtextxmlhandlerdosavefile}
	68
	69	\func{bool}{DoSaveFile}{\param{wxRichTextBuffer* }{buffer}, \param{wxOutputStream\& }{stream}}
	70
	71	Saves buffer context to the given stream.
	72
	73	\membersection{wxRichTextXMLHandler::ExportXML}\label{wxrichtextxmlhandlerexportxml}
	74
	75	\func{bool}{ExportXML}{\param{wxOutputStream\& }{stream}, \param{wxMBConv* }{convMem}, \param{wxMBConv* }{convFile}, \param{wxRichTextObject\& }{obj}, \param{int }{level}}
	76
	77	Recursively exports an object to the stream.
	78
	79	\membersection{wxRichTextXMLHandler::GetNodeContent}\label{wxrichtextxmlhandlergetnodecontent}
	80
	81	\func{wxString}{GetNodeContent}{\param{wxXmlNode* }{node}}
	82
	83	Helper function: gets node context.
	84
	85	\membersection{wxRichTextXMLHandler::GetParamNode}\label{wxrichtextxmlhandlergetparamnode}
	86
	87	\func{wxXmlNode}{GetParamNode}{\param{wxXmlNode }{node}, \param{const wxString\& }{param}}
	88
	89	Helper function: gets a named parameter from the XML node.
	90
	91	\membersection{wxRichTextXMLHandler::GetParamValue}\label{wxrichtextxmlhandlergetparamvalue}
	92
	93	\func{wxString}{GetParamValue}{\param{wxXmlNode* }{node}, \param{const wxString\& }{param}}
	94
	95	Helper function: gets a named parameter from the XML node.
	96
	97	\membersection{wxRichTextXMLHandler::GetStyle}\label{wxrichtextxmlhandlergetstyle}
	98
	99	\func{bool}{GetStyle}{\param{wxTextAttr\& }{attr}, \param{wxXmlNode* }{node}, \param{bool }{isPara = false}}
	100
	101	Helper function: gets style parameters from the given XML node.
	102
	103	\membersection{wxRichTextXMLHandler::GetText}\label{wxrichtextxmlhandlergettext}
	104
	105	\func{wxString}{GetText}{\param{wxXmlNode* }{node}, \param{const wxString\& }{param = wxEmptyString}, \param{bool }{translate = false}}
	106
	107	Helper function: gets text from the node.
	108
	109	\membersection{wxRichTextXMLHandler::HasParam}\label{wxrichtextxmlhandlerhasparam}
	110
	111	\func{bool}{HasParam}{\param{wxXmlNode* }{node}, \param{const wxString\& }{param}}
	112
	113	Helper function: returns \true if the node has the given parameter.
	114
	115	\membersection{wxRichTextXMLHandler::ImportXML}\label{wxrichtextxmlhandlerimportxml}
	116
	117	\func{bool}{ImportXML}{\param{wxRichTextBuffer* }{buffer}, \param{wxXmlNode* }{node}}
	118
	119	Recursively imports an object.
	120