correct idle tag type; remove unneeded includes

[wxWidgets.git] / include / wx / html / htmlpars.h

diff --git a/include/wx/html/htmlpars.h b/include/wx/html/htmlpars.h
index d102b6c8dd782661edf2a51ce22533c455d4f5d2..96c357639f8b6f7826441070b53bad98c728e77a 100644 (file)
--- a/include/wx/html/htmlpars.h
+++ b/include/wx/html/htmlpars.h
@@ -35,7 +35,7 @@ enum wxHtmlURLType
 };
 
 // This class handles generic parsing of HTML document : it scans
 };
 
 // This class handles generic parsing of HTML document : it scans

-// the document and divide it into blocks of tags (where one block
+// the document and divides it into blocks of tags (where one block

 // consists of starting and ending tag and of text between these
 // 2 tags.
 class WXDLLIMPEXP_HTML wxHtmlParser : public wxObject
 // consists of starting and ending tag and of text between these
 // 2 tags.
 class WXDLLIMPEXP_HTML wxHtmlParser : public wxObject


@@ -59,7 +59,7 @@ public:
     // This method does these things:
     // 1. call InitParser(source);
     // 2. call DoParsing();
     // This method does these things:
     // 1. call InitParser(source);
     // 2. call DoParsing();

-    // 3. call GetProduct(); (it's return value is then returned)
+    // 3. call GetProduct(); (its return value is then returned)

     // 4. call DoneParser();
     wxObject* Parse(const wxString& source);
 
     // 4. call DoneParser();
     wxObject* Parse(const wxString& source);
 


@@ -96,7 +96,7 @@ public:
     //     <it name="two" value="2">
     //   </myitems>
     //   <it> This last it has different meaning, we don't want it to be parsed by myitems handler!
     //     <it name="two" value="2">
     //   </myitems>
     //   <it> This last it has different meaning, we don't want it to be parsed by myitems handler!

-    // handler can handle only 'myitems' (e.g. it's GetSupportedTags returns "MYITEMS")
+    // handler can handle only 'myitems' (e.g. its GetSupportedTags returns "MYITEMS")

     // you can call PushTagHandler(handler, "IT") when you find <myitems>
     // and call PopTagHandler() when you find </myitems>
     void PushTagHandler(wxHtmlTagHandler *handler, const wxString& tags);
     // you can call PushTagHandler(handler, "IT") when you find <myitems>
     // and call PopTagHandler() when you find </myitems>
     void PushTagHandler(wxHtmlTagHandler *handler, const wxString& tags);


@@ -107,7 +107,7 @@ public:
     wxString* GetSource() {return &m_Source;}
     void SetSource(const wxString& src);
 
     wxString* GetSource() {return &m_Source;}
     void SetSource(const wxString& src);
 

-    // Sets HTML source and remebers current parser's state so that it can
+    // Sets HTML source and remembers current parser's state so that it can

     // later be restored. This is useful for on-line modifications of
     // HTML source (for example, <pre> handler replaces spaces with &nbsp;
     // and newlines with <br>)
     // later be restored. This is useful for on-line modifications of
     // HTML source (for example, <pre> handler replaces spaces with &nbsp;
     // and newlines with <br>)


@@ -116,6 +116,10 @@ public:
     // empty
     virtual bool RestoreState();
 
     // empty
     virtual bool RestoreState();
 

+    // Returns HTML source inside the element (i.e. between the starting
+    // and ending tag)
+    wxString GetInnerSource(const wxHtmlTag& tag);
+

     // Parses HTML string 'markup' and extracts charset info from <meta> tag
     // if present. Returns empty string if the tag is missing.
     // For wxHTML's internal use.
     // Parses HTML string 'markup' and extracts charset info from <meta> tag
     // if present. Returns empty string if the tag is missing.
     // For wxHTML's internal use.


@@ -189,7 +193,7 @@ protected:
 // Each recognized tag is passed to handler which is capable
 // of handling it. Each tag is handled in 3 steps:
 // 1. Handler will modifies state of parser
 // Each recognized tag is passed to handler which is capable
 // of handling it. Each tag is handled in 3 steps:
 // 1. Handler will modifies state of parser

-//    (using it's public methods)
+//    (using its public methods)

 // 2. Parser parses source between starting and ending tag
 // 3. Handler restores original state of the parser
 class WXDLLIMPEXP_HTML wxHtmlTagHandler : public wxObject
 // 2. Parser parses source between starting and ending tag
 // 3. Handler restores original state of the parser
 class WXDLLIMPEXP_HTML wxHtmlTagHandler : public wxObject


@@ -224,6 +228,12 @@ protected:
     void ParseInner(const wxHtmlTag& tag)
         { m_Parser->DoParsing(tag.GetBeginPos(), tag.GetEndPos1()); }
 
     void ParseInner(const wxHtmlTag& tag)
         { m_Parser->DoParsing(tag.GetBeginPos(), tag.GetEndPos1()); }
 

+    // Parses given source as if it was tag's inner code (see
+    // wxHtmlParser::GetInnerSource).  Unlike ParseInner(), this method lets
+    // you specify the source code to parse. This is useful when you need to
+    // modify the inner text before parsing.
+    void ParseInnerSource(const wxString& source);
+

     wxHtmlParser *m_Parser;
 
     DECLARE_NO_COPY_CLASS(wxHtmlTagHandler)
     wxHtmlParser *m_Parser;
 
     DECLARE_NO_COPY_CLASS(wxHtmlTagHandler)