clarify wxListCtrl::GetItem (fixes #9640)

[wxWidgets.git] / interface / wx / richtext / richtextxml.h

diff --git a/interface/wx/richtext/richtextxml.h b/interface/wx/richtext/richtextxml.h
index 69c812b3b39b35226d199f7289bd2226c432823d..74fc2a2bc4c30166c97982f4ea919e56c5f53964 100644 (file)
--- a/interface/wx/richtext/richtextxml.h
+++ b/interface/wx/richtext/richtextxml.h
@@ -10,10 +10,21 @@
     @class wxRichTextXMLHandler
 
     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.
+    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.
+
+
+    @section richtextxmlhandler_flags Handler flags
+
+    The following flags can be used with this handler, via the handler's SetFlags()
+    function or the buffer or control's SetHandlerFlags() function:
+
+    - wxRICHTEXT_HANDLER_INCLUDE_STYLESHEET
+      Include the style sheet in loading and saving operations.
+
 
     @library{wxrichtext}
     @category{richtext}
@@ -22,10 +33,11 @@ class wxRichTextXMLHandler : public wxRichTextFileHandler
 {
 public:
     /**
-        ,  wxString&@e ext = wxT("xml"), @b int@e type = wxRICHTEXT_TYPE_XML)
         Constructor.
     */
-    wxRichTextXMLHandler() const;
+    wxRichTextXMLHandler(const wxString& name = wxT("XML"),
+                         const wxString& ext = wxT("xml"),
+                         int type = wxRICHTEXT_TYPE_XML);
 
     /**
         Returns @true.
@@ -42,16 +54,6 @@ public:
     */
     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.
     */
@@ -97,5 +99,17 @@ public:
         Recursively imports an object.
     */
     bool ImportXML(wxRichTextBuffer* buffer, wxXmlNode* node);
+
+protected:
+
+    /**
+        Loads buffer context from the given stream.
+    */
+    virtual bool DoLoadFile(wxRichTextBuffer* buffer, wxInputStream& stream);
+
+    /**
+        Saves buffer context to the given stream.
+    */
+    virtual bool DoSaveFile(wxRichTextBuffer* buffer, wxOutputStream& stream);
 };