X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/23324ae1c7938ba904770fc456d3c07764b9c5e9..b02f1c862d1a3fcd714aef37e67decaa9d67b611:/interface/stattext.h

diff --git a/interface/stattext.h b/interface/stattext.h
index 058335e278..0f813f904b 100644
--- a/interface/stattext.h
+++ b/interface/stattext.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        stattext.h
-// Purpose:     documentation for wxStaticText class
+// Purpose:     interface of wxStaticText
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,9 +9,9 @@
 /**
     @class wxStaticText
     @wxheader{stattext.h}
-    
+
     A static text control displays one or more lines of read-only text.
-    
+
     @beginStyleTable
     @style{wxALIGN_LEFT}:
            Align the text to the left
@@ -37,13 +37,12 @@
     @style{wxST_MARKUP}:
            Support markup in the label; see SetLabel for more information
     @endStyleTable
-    
+
     @library{wxcore}
     @category{ctrl}
     @appearance{statictext.png}
-    
-    @seealso
-    wxStaticBitmap, wxStaticBox
+
+    @see wxStaticBitmap, wxStaticBox
 */
 class wxStaticText : public wxControl
 {
@@ -51,37 +50,31 @@ public:
     //@{
     /**
         Constructor, creating and showing a text control.
-        
-        @param parent 
-        Parent window. Should not be @NULL.
-        
-        @param id 
-        Control identifier. A value of -1 denotes a default value.
-        
-        @param label 
-        Text label.
-        
-        @param pos 
-        Window position.
-        
-        @param size 
-        Window size.
-        
-        @param style 
-        Window style. See wxStaticText.
-        
-        @param name 
-        Window name.
-        
-        @sa Create()
+
+        @param parent
+            Parent window. Should not be @NULL.
+        @param id
+            Control identifier. A value of -1 denotes a default value.
+        @param label
+            Text label.
+        @param pos
+            Window position.
+        @param size
+            Window size.
+        @param style
+            Window style. See wxStaticText.
+        @param name
+            Window name.
+
+        @see Create()
     */
     wxStaticText();
-        wxStaticText(wxWindow* parent, wxWindowID id,
-                     const wxString& label,
-                     const wxPoint& pos = wxDefaultPosition,
-                     const wxSize& size = wxDefaultSize,
-                     long style = 0,
-                     const wxString& name = "staticText");
+    wxStaticText(wxWindow* parent, wxWindowID id,
+                 const wxString& label,
+                 const wxPoint& pos = wxDefaultPosition,
+                 const wxSize& size = wxDefaultSize,
+                 long style = 0,
+                 const wxString& name = "staticText");
     //@}
 
     /**
@@ -96,144 +89,122 @@ public:
 
     /**
         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.
     */
-    wxString GetLabel();
+    wxString GetLabel() const;
 
     //@{
     /**
         The first form returns the control's label without the mnemonics characters (if
-        any) 
+        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
-        mnemonics 
+        The second (static) version returns the given @a label string without the
+        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.
-        
         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
-        
+
         u
-        
-        
+
         underlined text
-        
+
         span
-        
-        
+
         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.
-        
         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 amp; or as @c
+
         @c '
-        
-        
+
         @c apos;
-        
+
         @c "
-        
-        
+
         @c quot;
-        
-        @c 
-        
-        
+
+        @c
+
         @c lt;
-        
-        @c 
-        
-        
+
+        @c
+
         @c gt;
-        
+
         The non-escaped ampersand @c  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
+
+        @param label
+            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 @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
         is negative, no wrapping is done.
-        
-        This function is new since wxWidgets version 2.6.2
+
+        @wxsince{2.6.2}
     */
     void Wrap(int width);
 };
+