Document that message box with wxYES_NO but without wxCANCEL can't be closed.

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

diff --git a/interface/wx/stattext.h b/interface/wx/stattext.h
index 456c0dc2857021b471707bdeddcd3e2714cf0c05..4e297aabc5495df8ae716b278bc475f9fea1603b 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
 */


@@ -76,17 +79,27 @@ 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);
+
+    // 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.
+    /**
+        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);

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


@@ -109,6 +122,20 @@ public:
     */
     static wxString GetLabelText(const wxString& label);
 
     */
     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.
+    */
+    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.


@@ -169,12 +196,12 @@ public:
 
         <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>