added interface headers with latest discussed changes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52381 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/richtext/richtextxml.h

@@ -0,0 +1,102 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        richtext/richtextxml.h
+// Purpose:     documentation for wxRichTextXMLHandler class
+// Author:      wxWidgets team
+// RCS-ID:      $Id$
+// Licence:     wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/**
+    @class wxRichTextXMLHandler
+    @headerfile richtextxml.h wx/richtext/richtextxml.h
+    
+    A handler for loading and saving content in an XML format specific
+    to wxRichTextBuffer. You can either add the handler to the buffer
+    and load and save through the buffer or control API, or you can
+    create an instance of the handler on the stack and call its
+    functions directly.
+    
+    @library{wxrichtext}
+    @category{FIXME}
+*/
+class wxRichTextXMLHandler : public wxRichTextFileHandler
+{
+public:
+    /**
+        , @b const wxString&@e ext = wxT("xml"), @b int@e type = wxRICHTEXT_TYPE_XML)
+        
+        Constructor.
+    */
+    wxRichTextXMLHandler();
+
+    /**
+        Returns @true.
+    */
+    bool CanLoad();
+
+    /**
+        Returns @true.
+    */
+    bool CanSave();
+
+    /**
+        Creates XML code for a given character or paragraph style.
+    */
+    wxString CreateStyle(const wxTextAttr& attr, bool isPara = @false);
+
+    /**
+        Loads buffer context from the given stream.
+    */
+    bool DoLoadFile(wxRichTextBuffer* buffer, wxInputStream& stream);
+
+    /**
+        Saves buffer context to the given stream.
+    */
+    bool DoSaveFile(wxRichTextBuffer* buffer, wxOutputStream& stream);
+
+    /**
+        Recursively exports an object to the stream.
+    */
+    bool ExportXML(wxOutputStream& stream, wxMBConv* convMem,
+                   wxMBConv* convFile,
+                   wxRichTextObject& obj,
+                   int level);
+
+    /**
+        Helper function: gets node context.
+    */
+    wxString GetNodeContent(wxXmlNode* node);
+
+    /**
+        Helper function: gets a named parameter from the XML node.
+    */
+    wxXmlNode* GetParamNode(wxXmlNode* node, const wxString& param);
+
+    /**
+        Helper function: gets a named parameter from the XML node.
+    */
+    wxString GetParamValue(wxXmlNode* node, const wxString& param);
+
+    /**
+        Helper function: gets style parameters from the given XML node.
+    */
+    bool GetStyle(wxTextAttr& attr, wxXmlNode* node,
+                  bool isPara = @false);
+
+    /**
+        Helper function: gets text from the node.
+    */
+    wxString GetText(wxXmlNode* node,
+                     const wxString& param = wxEmptyString,
+                     bool translate = @false);
+
+    /**
+        Helper function: returns @true if the node has the given parameter.
+    */
+    bool HasParam(wxXmlNode* node, const wxString& param);
+
+    /**
+        Recursively imports an object.
+    */
+    bool ImportXML(wxRichTextBuffer* buffer, wxXmlNode* node);
+};