]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/stattext.h
projects / wxWidgets.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Correct wxString:Append docs
[wxWidgets.git] / interface / stattext.h
diff --git a/interface/stattext.h b/interface/stattext.h
index 3ada9ff8285120299dc4d21f3b3f11a4574b221e..9e16e68e741b74408653f0902ed4558dee77f3ea 100644 (file)
--- a/interface/stattext.h
+++ b/interface/stattext.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        stattext.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        stattext.h
-// Purpose:     documentation for wxStaticText class
+// Purpose:     interface of wxStaticText
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -13,37 +13,36 @@
     A static text control displays one or more lines of read-only text.
 
     @beginStyleTable
     A static text control displays one or more lines of read-only text.
 
     @beginStyleTable
-    @style{wxALIGN_LEFT}:
+    @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}:
+    @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)
            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)
-    @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 text width exceeds the control width, replace the beginning
            of the text with an ellipsis
-    @style{wxST_ELLIPSIZE_MIDDLE}:
+    @style{wxST_ELLIPSIZE_MIDDLE}
            Same as above, but replace the text in the middle of the control
            with an ellipsis
            Same as above, but replace the text in the middle of the control
            with an ellipsis
-    @style{wxST_ELLIPSIZE_END}:
+    @style{wxST_ELLIPSIZE_END}
            Same as above, but replace the end of the text with an ellipsis
            Same as above, but replace the end of the text with an ellipsis
-    @style{wxST_MARKUP}:
+    @style{wxST_MARKUP}
            Support markup in the label; see SetLabel for more information
     @endStyleTable
 
     @library{wxcore}
     @category{ctrl}
            Support markup in the label; see SetLabel for more information
     @endStyleTable
 
     @library{wxcore}
     @category{ctrl}
-    @appearance{statictext.png}
+    <!-- @appearance{statictext.png} -->
 
 
-    @seealso
-    wxStaticBitmap, wxStaticBox
+    @see wxStaticBitmap, wxStaticBox
 */
 class wxStaticText : public wxControl
 {
 */
 class wxStaticText : public wxControl
 {
@@ -51,29 +50,23 @@ public:
     //@{
     /**
         Constructor, creating and showing a text control.
     //@{
     /**
         Constructor, creating and showing a text control.
-        
+
         @param parent
         @param parent
-        Parent window. Should not be @NULL.
-        
+            Parent window. Should not be @NULL.
         @param id
         @param id
-        Control identifier. A value of -1 denotes a default value.
-        
+            Control identifier. A value of -1 denotes a default value.
         @param label
         @param label
-        Text label.
-        
+            Text label.
         @param pos
         @param pos
-        Window position.
-        
+            Window position.
         @param size
         @param size
-        Window size.
-        
+            Window size.
         @param style
         @param style
-        Window style. See wxStaticText.
-        
+            Window style. See wxStaticText.
         @param name
         @param name
-        Window name.
-        
-        @sa Create()
+            Window name.
+
+        @see Create()
     */
     wxStaticText();
     wxStaticText(wxWindow* parent, wxWindowID id,
     */
     wxStaticText();
     wxStaticText(wxWindow* parent, wxWindowID id,
@@ -96,144 +89,124 @@ public:
 
     /**
         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.
         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.
     */
         Use GetLabelText() if only the
         label text is needed.
     */
-    wxString GetLabel();
+    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 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 @e label string without the
+        The second (static) version returns the given @a label string without the
         mnemonics
         characters (if any) and without the markup.
     */
     wxString GetLabelText();
         mnemonics
         characters (if any) and without the markup.
     */
     wxString GetLabelText();
-    static wxString GetLabelText(const wxString& label);
+    const static wxString  GetLabelText(const wxString& label);
     //@}
 
     /**
         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:
         The supported tags are:
-        
-        
+
         b
         b
-        
-        
+
         bold text
         bold text
-        
+
         big
         big
-        
-        
+
         bigger text
         bigger text
-        
+
         i
         i
-        
-        
+
         italic text
         italic text
-        
+
         s
         s
-        
-        
+
         strike-through text
         strike-through text
-        
+
         sub
         sub
-        
-        
+
         subscript text
         subscript text
-        
+
         sup
         sup
-        
-        
+
         superscript text
         superscript text
-        
+
         small
         small
-        
-        
+
         smaller text
         smaller text
-        
+
         tt
         tt
-        
-        
+
         monospaced text
         monospaced text
-        
+
         u
         u
-        
-        
+
         underlined text
         underlined text
-        
+
         span
         span
-        
-        
+
         generic formatter tag; see Pango Markup for more information.
         generic formatter tag; see Pango Markup for more information.
-        
+
         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.
         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.
-        
         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 Special character
-        
-        
+
         @b Escape as
         @b Escape as
-        
+
         @c
         @c
-        
-        
+
         @c amp; or as @c
         @c amp; or as @c
-        
+
         @c '
         @c '
-        
-        
+
         @c apos;
         @c apos;
-        
+
         @c "
         @c "
-        
-        
+
         @c quot;
         @c quot;
-        
+
         @c
         @c
-        
-        
+
         @c lt;
         @c lt;
-        
+
         @c
         @c
-        
-        
+
         @c gt;
         @c gt;
-        
+
         The non-escaped ampersand @c  characters are interpreted as
         mnemonics; see wxControl::SetLabel.
         The non-escaped ampersand @c  characters are interpreted as
         mnemonics; see wxControl::SetLabel.
+
         Example:
         Example:
-        
+
         @param label
         @param label
-        The new label to set. It may contain newline characters and the markup tags
+            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
         described above.
     */
     virtual void SetLabel(const wxString& label);
 
     /**
         This functions wraps the controls label so that each of its lines becomes at
-        most @e width pixels wide if possible (the lines are broken at words
+        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
         boundaries so it might not be the case if words are too long). If @e width
-        is negative, no wrapping is done.
-        
-        This function is new since wxWidgets version 2.6.2
+        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);
 };
     */
     void Wrap(int width);
 };
+
wxWidgets (Impactor)