Fix scrolling to the bottom in wxTextCtrl::AppendText().

[wxWidgets.git] / interface / wx / stattext.h

diff --git a/interface/wx/stattext.h b/interface/wx/stattext.h
index 88c8d955ada752dc5fad6bf2c00f96c0d4fb5949..e163c2ba48803b4f87a06c15e8d7ea34060b16d3 100644 (file)
--- a/interface/wx/stattext.h
+++ b/interface/wx/stattext.h
@@ -10,36 +10,39 @@
     @class wxStaticText
 
     A static text control displays one or more lines of read-only text.
     @class wxStaticText
 
     A static text control displays one or more lines of read-only text.

+    wxStaticText supports the three classic text alignments, label ellipsization
+    and formatting markup.

 
     @beginStyleTable
     @style{wxALIGN_LEFT}
 
     @beginStyleTable
     @style{wxALIGN_LEFT}

-           Align the text to the left
+           Align the text to the left.

     @style{wxALIGN_RIGHT}
     @style{wxALIGN_RIGHT}

-           Align the text to the right
+           Align the text to the right.

     @style{wxALIGN_CENTRE}
     @style{wxALIGN_CENTRE}

-           Center the text (horizontally)
+           Center the text (horizontally).

     @style{wxST_NO_AUTORESIZE}
            By default, the control will adjust its size to exactly fit to the
     @style{wxST_NO_AUTORESIZE}
            By default, the control will adjust its size to exactly fit to the

-           size of the text when  SetLabel is called. If this style flag is
+           size of the text when SetLabel() is called. If this style flag is

            given, the control will not change its size (this style is
            given, the control will not change its size (this style is

-           especially useful with controls which also have wxALIGN_RIGHT or
-           CENTER style because otherwise they won't make sense any longer
-           after a call to SetLabel)
+           especially useful with controls which also have the @c wxALIGN_RIGHT or
+           the @c wxALIGN_CENTRE style because otherwise they won't make sense any 
+           longer after a call to SetLabel()).

     @style{wxST_ELLIPSIZE_START}
     @style{wxST_ELLIPSIZE_START}

-           If the text width exceeds the control width, replace the beginning
-           of the text with an ellipsis
+           If the labeltext width exceeds the control width, replace the beginning
+           of the label with an ellipsis; uses wxControl::Ellipsize.

     @style{wxST_ELLIPSIZE_MIDDLE}
     @style{wxST_ELLIPSIZE_MIDDLE}

-           Same as above, but replace the text in the middle of the control
-           with an ellipsis
+           If the label text width exceeds the control width, replace the middle
+           of the label with an ellipsis; uses wxControl::Ellipsize.

     @style{wxST_ELLIPSIZE_END}
     @style{wxST_ELLIPSIZE_END}

-           Same as above, but replace the end of the text with an ellipsis
+           If the label text width exceeds the control width, replace the end
+           of the label with an ellipsis; uses wxControl::Ellipsize.

     @style{wxST_MARKUP}
     @style{wxST_MARKUP}

-           Support markup in the label; see SetLabel for more information
+           Support markup in the label; see SetLabel() for more information.

     @endStyleTable
 
     @library{wxcore}
     @category{ctrl}
     @endStyleTable
 
     @library{wxcore}
     @category{ctrl}

-    <!-- @appearance{statictext.png} -->
+    @appearance{statictext.png}

 
     @see wxStaticBitmap, wxStaticBox
 */
 
     @see wxStaticBitmap, wxStaticBox
 */


@@ -50,7 +53,7 @@ public:
         Default constructor.
     */
     wxStaticText();
         Default constructor.
     */
     wxStaticText();

-    
+

     /**
         Constructor, creating and showing a text control.
 
     /**
         Constructor, creating and showing a text control.
 


@@ -76,138 +79,204 @@ public:
                  const wxPoint& pos = wxDefaultPosition,
                  const wxSize& size = wxDefaultSize,
                  long style = 0,
                  const wxPoint& pos = wxDefaultPosition,
                  const wxSize& size = wxDefaultSize,
                  long style = 0,

-                 const wxString& name = "staticText");
+                 const wxString& name = wxStaticTextNameStr);

 
     /**
         Creation function, for two-step construction. For details see wxStaticText().
     */
 
     /**
         Creation function, for two-step construction. For details see wxStaticText().
     */

-    bool Create(wxWindow* parent, wxWindowID id,
-                const wxString& label,
+    bool Create(wxWindow* parent, wxWindowID id, const wxString& label,

                 const wxPoint& pos = wxDefaultPosition,
                 const wxPoint& pos = wxDefaultPosition,

-                const wxSize& size = wxDefaultSize,
-                long style = 0,
-                const wxString& name = "staticText");
+                const wxSize& size = wxDefaultSize, long style = 0,
+                const wxString& name = wxStaticTextNameStr);

 
     /**
         Returns the contents of the control.
 
     /**
         Returns the contents of the control.

-        Note that the returned string contains both the mnemonics (@c  characters),
-        if any, and markup tags, if any.
-        Use GetLabelText() if only the
-        label text is needed.
+
+        Note that the returned string may contain both mnemonics (@& characters),
+        and markup tags, if they were passed to the SetLabel() function.
+
+        Use GetLabelText() if only the label text, without mnemonics and without 
+        markup if the @c wxST_MARKUP style is set, is needed.
+        
+        Also note that the returned string is always the string which was passed to
+        SetLabel() but may be different from the string passed to SetLabelText()
+        (since this last one escapes mnemonic characters and eventually markup).

     */
     wxString GetLabel() const;
 
     */
     wxString GetLabel() const;
 

-    //@{

     /**
     /**

-        The first form returns the control's label without the mnemonics characters (if
-        any)
-        and without the markup (if the control has @c wxST_MARKUP style).
-        The second (static) version returns the given @a label string without the
-        mnemonics
-        characters (if any) and without the markup.
+        This method returns the control's label without the mnemonics characters
+        (if any) and without the markup (if the control has the @c wxST_MARKUP style).
+        
+        Note that because of the stripping of the mnemonics and markup the returned 
+        string may differ from the string which was passed to SetLabel() but should 
+        always be the same which was passed to SetLabelText().

     */
     */

-    wxString GetLabelText();
-    const static wxString  GetLabelText(const wxString& label);
-    //@}
+    wxString GetLabelText() const;

 
     /**
 
     /**

-        Sets the static text label and updates the controls size to exactly fit the
-        label unless the control has wxST_NO_AUTORESIZE flag.
-        This function allows to set decorated static label text on platforms which
-        support it (currently only GTK+ 2). For the other platforms, the markup is
-        ignored.
-        The supported tags are:
-
-        b
-
-        bold text
-
-        big
-
-        bigger text
-
-        i
-
-        italic text
-
-        s
-
-        strike-through text
-
-        sub
-
-        subscript text
-
-        sup
-
-        superscript text
-
-        small
-
-        smaller text
-
-        tt
-
-        monospaced text
+        Returns @true if the window styles for this control contains one of the
+        @c wxST_ELLIPSIZE_START, @c wxST_ELLIPSIZE_MIDDLE or @c wxST_ELLIPSIZE_END styles.
+    */
+    bool IsEllipsized() const;

 
 

-        u
+    // NB: when writing docs for the following function remember that Doxygen
+    //     will always expand HTML entities (e.g. &quot;) and thus we need to
+    //     write e.g. "&amp;lt;" to have in the output the "&lt;" string.

 
 

-        underlined text
+    /**
+        Sets the static text label and updates the controls size to exactly fit the
+        label unless the control has @c wxST_NO_AUTORESIZE flag.

 
 

-        span
+        This function allows to set decorated static label text, when the @c wxST_MARKUP 
+        style is used, on those platforms which support it (currently only GTK+ 2). 
+        For the other platforms or when @c wxST_MARKUP is not used, the markup is ignored.

 
 

-        generic formatter tag; see Pango Markup for more information.
+        The supported tags are:
+        <TABLE>
+            <TR>
+                <TD><b>Tag</b></TD>
+                <TD><b>Description</b></TD>
+            </TR>
+            <TR>
+                <TD>&lt;b&gt;</TD>
+                <TD>bold text</TD>
+            </TR>
+            <TR>
+                <TD>&lt;big&gt;</TD>
+                <TD>bigger text</TD>
+            </TR>
+            <TR>
+                <TD>&lt;i&gt;</TD>
+                <TD>italic text</TD>
+            </TR>
+            <TR>
+                <TD>&lt;s&gt;</TD>
+                <TD>strike-through text</TD>
+            </TR>
+            <TR>
+                <TD>&lt;sub&gt;</TD>
+                <TD>subscript text</TD>
+            </TR>
+            <TR>
+                <TD>&lt;sup&gt;</TD>
+                <TD>superscript text</TD>
+            </TR>
+            <TR>
+                <TD>&lt;small&gt;</TD>
+                <TD>smaller text</TD>
+            </TR>
+            <TR>
+                <TD>&lt;tt&gt;</TD>
+                <TD>monospaced text</TD>
+            </TR>
+            <TR>
+                <TD>&lt;u&gt;</TD>
+                <TD>underlined text</TD>
+            </TR>
+            <TR>
+                <TD>&lt;span&gt;</TD>
+                <TD>generic formatter tag; see Pango Markup
+                    (http://library.gnome.org/devel/pango/unstable/PangoMarkupFormat.html)
+                    for more information.</TD>
+            </TR>
+        </TABLE>

 
         Note that the string must be well-formed (e.g. all tags must be correctly
 
         Note that the string must be well-formed (e.g. all tags must be correctly

-        closed)
-        otherwise it can be not shown correctly or at all.
+        closed) otherwise it can be not shown correctly or at all.

         Also note that you need to escape the following special characters:
 
         Also note that you need to escape the following special characters:
 

-        @b Special character
-
-        @b Escape as
-
-        @c
-
-        @c amp; or as @c
-
-        @c '
-
-        @c apos;
-
-        @c "
-
-        @c quot;
-
-        @c
-
-        @c lt;
-
-        @c
-
-        @c gt;
-
-        The non-escaped ampersand @c  characters are interpreted as
+        <TABLE>
+            <TR>
+                <TD><b>Special character</b></TD>
+                <TD><b>Escape as</b></TD>
+            </TR>
+            <TR>
+                <TD>@c &amp;</TD>
+                <TD>@c &amp;amp; or as @c &amp;&amp;</TD>
+            </TR>
+            <TR>
+                <TD>@c &apos;</TD>
+                <TD>@c &amp;apos;</TD>
+            </TR>
+            <TR>
+                <TD>@c &quot;</TD>
+                <TD>@c &amp;quot;</TD>
+            </TR>
+            <TR>
+                <TD>@c &lt;</TD>
+                <TD>@c &amp;lt;</TD>
+            </TR>
+            <TR>
+                <TD>@c &gt;</TD>
+                <TD>@c &amp;gt;</TD>
+            </TR>
+        </TABLE>
+
+        The non-escaped ampersand @c &amp; characters are interpreted as

         mnemonics; see wxControl::SetLabel.
 
         Example:
 
         @param label
         mnemonics; see wxControl::SetLabel.
 
         Example:
 
         @param label

-            The new label to set. It may contain newline characters and the markup tags
-        described above.
+            The new label to set.
+            It may contain newline characters and the markup tags described above.

     */
     virtual void SetLabel(const wxString& label);
     */
     virtual void SetLabel(const wxString& label);

+    
+    /**
+        Sets the control's label to exactly the given string.
+
+        Unlike SetLabel(), this function shows exactly the @a text passed to it
+        in the control, without interpreting ampersands in it in any way and,
+        if @c wxST_MARKUP is used, without interpreting markup tags.
+        Notice that it means that the control can't have any mnemonic nor markup defined
+        for it using this function.
+
+        @see EscapeMarkup()
+    */
+    virtual void SetLabelText(const wxString& text);

 
     /**
         This functions wraps the controls label so that each of its lines becomes at
         most @a width pixels wide if possible (the lines are broken at words
 
     /**
         This functions wraps the controls label so that each of its lines becomes at
         most @a width pixels wide if possible (the lines are broken at words

-        boundaries so it might not be the case if words are too long). If @e width
-        is negative, no wrapping is done. Note that this width is not
+        boundaries so it might not be the case if words are too long).
+
+        If @a width is negative, no wrapping is done. Note that this width is not

         necessarily the total width of the control, since a few pixels for the
         border (depending on the controls border style) may be added.
 
         @since 2.6.2
     */
     void Wrap(int width);
         necessarily the total width of the control, since a few pixels for the
         border (depending on the controls border style) may be added.
 
         @since 2.6.2
     */
     void Wrap(int width);

+
+
+public:     // static functions
+    
+    /**
+        Returns the given @a label string without the mnemonics characters (if any) 
+        and without the markup.
+
+        Note that since this function is static it will always remove markup
+        (since it cannot check @c wxST_MARKUP presence/absence!).
+    */
+    static wxString GetLabelText(const wxString& label);
+
+    /**
+        Escapes all the symbols of @a str that have a special meaning (<tt><>&quot;'&</tt>) for
+        wxStaticText objects with the @c wxST_MARKUP style.
+        
+        Those symbols are replaced the corresponding entities 
+        (&amp;lt; &amp;gt; &amp;quot; &amp;apos; &amp;amp;).
+    */
+    static wxString EscapeMarkup(const wxString& str);
+
+    /**
+        Removes the markup accepted by wxStaticText when the @c wxST_MARKUP style is used,
+        and then returns the cleaned string.
+
+        See SetLabel() for more info about the markup.
+    */
+    static wxString RemoveMarkup(const wxString& str);

 };
 
 };