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
	24	\wxheading{Include files}
	25
	26	<wx/richtext/richtextxml.h>
	27
	28	\wxheading{Data structures}
	29
	30	\latexignore{\rtfignore{\wxheading{Members}}}
	31
	32	\membersection{wxRichTextXMLHandler::wxRichTextXMLHandler}\label{wxrichtextxmlhandlerwxrichtextxmlhandler}
	33
	34	\func{}{wxRichTextXMLHandler}{\param{const wxString\& }{name = wxT("XML")}, \param{const wxString\& }{ext = wxT("xml")}, \param{int }{type = wxRICHTEXT\_TYPE\_XML}}
	35
	36	Constructor.
	37
	38	\membersection{wxRichTextXMLHandler::CanLoad}\label{wxrichtextxmlhandlercanload}
	39
	40	\constfunc{bool}{CanLoad}{\void}
	41
	42	Returns \true.
	43
	44	\membersection{wxRichTextXMLHandler::CanSave}\label{wxrichtextxmlhandlercansave}
	45
	46	\constfunc{bool}{CanSave}{\void}
	47
	48	Returns \true.
	49
	50	\membersection{wxRichTextXMLHandler::CreateStyle}\label{wxrichtextxmlhandlercreatestyle}
	51
	52	\func{wxString}{CreateStyle}{\param{const wxTextAttrEx\& }{attr}, \param{bool }{isPara = false}}
	53
	54	Creates XML code for a given character or paragraph style.
	55
	56	\membersection{wxRichTextXMLHandler::DoLoadFile}\label{wxrichtextxmlhandlerdoloadfile}
	57
	58	\func{bool}{DoLoadFile}{\param{wxRichTextBuffer* }{buffer}, \param{wxInputStream\& }{stream}}
	59
	60	Loads buffer context from the given stream.
	61
	62	\membersection{wxRichTextXMLHandler::DoSaveFile}\label{wxrichtextxmlhandlerdosavefile}
	63
	64	\func{bool}{DoSaveFile}{\param{wxRichTextBuffer* }{buffer}, \param{wxOutputStream\& }{stream}}
	65
	66	Saves buffer context to the given stream.
	67
	68	\membersection{wxRichTextXMLHandler::ExportXML}\label{wxrichtextxmlhandlerexportxml}
	69
	70	\func{bool}{ExportXML}{\param{wxOutputStream\& }{stream}, \param{wxMBConv* }{convMem}, \param{wxMBConv* }{convFile}, \param{wxRichTextObject\& }{obj}, \param{int }{level}}
	71
	72	Recursively exports an object to the stream.
	73
	74	\membersection{wxRichTextXMLHandler::GetNodeContent}\label{wxrichtextxmlhandlergetnodecontent}
	75
	76	\func{wxString}{GetNodeContent}{\param{wxXmlNode* }{node}}
	77
	78	Helper function: gets node context.
	79
	80	\membersection{wxRichTextXMLHandler::GetParamNode}\label{wxrichtextxmlhandlergetparamnode}
	81
	82	\func{wxXmlNode}{GetParamNode}{\param{wxXmlNode }{node}, \param{const wxString\& }{param}}
	83
	84	Helper function: gets a named parameter from the XML node.
	85
	86	\membersection{wxRichTextXMLHandler::GetParamValue}\label{wxrichtextxmlhandlergetparamvalue}
	87
	88	\func{wxString}{GetParamValue}{\param{wxXmlNode* }{node}, \param{const wxString\& }{param}}
	89
	90	Helper function: gets a named parameter from the XML node.
	91
	92	\membersection{wxRichTextXMLHandler::GetStyle}\label{wxrichtextxmlhandlergetstyle}
	93
	94	\func{bool}{GetStyle}{\param{wxTextAttrEx\& }{attr}, \param{wxXmlNode* }{node}, \param{bool }{isPara = false}}
	95
	96	Helper function: gets style parameters from the given XML node.
	97
	98	\membersection{wxRichTextXMLHandler::GetText}\label{wxrichtextxmlhandlergettext}
	99
	100	\func{wxString}{GetText}{\param{wxXmlNode* }{node}, \param{const wxString\& }{param = wxEmptyString}, \param{bool }{translate = false}}
	101
	102	Helper function: gets text from the node.
	103
	104	\membersection{wxRichTextXMLHandler::HasParam}\label{wxrichtextxmlhandlerhasparam}
	105
	106	\func{bool}{HasParam}{\param{wxXmlNode* }{node}, \param{const wxString\& }{param}}
	107
	108	Helper function: returns \true if the node has the given parameter.
	109
	110	\membersection{wxRichTextXMLHandler::ImportXML}\label{wxrichtextxmlhandlerimportxml}
	111
	112	\func{bool}{ImportXML}{\param{wxRichTextBuffer* }{buffer}, \param{wxXmlNode* }{node}}
	113
	114	Recursively imports an object.
	115