update for bakefile 0.2.6

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

diff --git a/interface/wx/stattext.h b/interface/wx/stattext.h
index 686ecaf4d4e6bf2a40017e17d65f0f8ca97d0746..613d99661a3e7d342148ebde71dc3159cf846c95 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
            size of the text when  SetLabel is called. If this style flag 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
     @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
            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)
+           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,46 +79,66 @@ 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);
+
+    /**
+        Escapes all the symbols of @a str that have a special meaning (<tt><>"'&</tt>) for
+        wxStaticText objects with the @c wxST_MARKUP style.
+        Those symbols are replaced the corresponding entities (&lt; &gt; &quot; &apos; &amp;).
+    */
+    static wxString EscapeMarkup(const wxString& str);

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

-        Note that the returned string contains both the mnemonics (@c  characters),
+
+        Note that the returned string contains both the mnemonics (@& characters),

         if any, and markup tags, if any.
         if any, and markup tags, if any.

-        Use GetLabelText() if only the
-        label text is needed.
+        Use GetLabelText() if only the label text is needed.

     */
     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 @c wxST_MARKUP style).
+    */
+    wxString GetLabelText() const;
+
+    /**
+        This overload returns the given @a label string without the
+        mnemonics characters (if any) and without the markup.
+    */
+    static wxString GetLabelText(const wxString& label);
+
+    /**
+        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;
+
+    /**
+        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.

     */
     */

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

 
     /**
         Sets the static text label and updates the controls size to exactly fit the
         label unless the control has wxST_NO_AUTORESIZE flag.
 
     /**
         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.
         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:
         <TABLE>
             <TR>
         The supported tags are:
         <TABLE>
             <TR>


@@ -156,22 +179,24 @@ public:
             </TR>
             <TR>
                 <TD>&lt;span&gt;</TD>
             </TR>
             <TR>
                 <TD>&lt;span&gt;</TD>

-                <TD>generic formatter tag; see Pango Markup for more information.</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
             </TR>
         </TABLE>
 
         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:

+

         <TABLE>
             <TR>
         <TABLE>
             <TR>

-                <TD>@b Special character</TD>
-                <TD>@b Escape as</TD>
+                <TD><b>Special character</b></TD>
+                <TD><b>Escape as</b></TD>

             </TR>
             <TR>
                 <TD>@c &amp;</TD>
             </TR>
             <TR>
                 <TD>@c &amp;</TD>

-                <TD>@c &amp;amp; or as &amp;&amp;</TD>
+                <TD>@c &amp;amp; or as @c &amp;&amp;</TD>

             </TR>
             <TR>
                 <TD>@c &apos;</TD>
             </TR>
             <TR>
                 <TD>@c &apos;</TD>


@@ -190,23 +215,24 @@ public:
                 <TD>@c &amp;gt;</TD>
             </TR>
         </TABLE>
                 <TD>@c &amp;gt;</TD>
             </TR>
         </TABLE>

-        
+

         The non-escaped ampersand @c &amp; characters are interpreted as
         mnemonics; see wxControl::SetLabel.
 
         Example:
 
         @param label
         The non-escaped ampersand @c &amp; characters are interpreted as
         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);
 
     /**
         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
     */
     virtual void SetLabel(const wxString& label);
 
     /**
         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.
 
         necessarily the total width of the control, since a few pixels for the
         border (depending on the controls border style) may be added.