]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/statline.h
More initial reviews of d* interface headers.
[wxWidgets.git] / interface / statline.h
index f5304a7e894bdf2eb90dd6ed6f055c4fdd999eb0..df71adf528e086a97b435fc1fc9210b4de70cb55 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        statline.h
-// Purpose:     documentation for wxStaticLine class
+// Purpose:     interface of wxStaticLine
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
     groups of controls. The line may be only vertical or horizontal.
 
     @beginStyleTable
-    @style{wxLI_HORIZONTAL}:
+    @style{wxLI_HORIZONTAL}
            Creates a horizontal line.
-    @style{wxLI_VERTICAL}:
+    @style{wxLI_VERTICAL}
            Creates a vertical line.
     @endStyleTable
 
     @library{wxcore}
     @category{FIXME}
 
-    @seealso
-    wxStaticBox
+    @see wxStaticBox
 */
 class wxStaticLine : public wxControl
 {
@@ -32,28 +31,23 @@ public:
     //@{
     /**
         Constructor, creating and showing a static line.
-        
+
         @param parent
-        Parent window. Must not be @NULL.
-        
+            Parent window. Must not be @NULL.
         @param id
-        Window identifier. The value wxID_ANY indicates a default value.
-        
+            Window identifier. The value wxID_ANY indicates a default value.
         @param pos
-        Window position. If wxDefaultPosition is specified then a default position
-        is chosen.
-        
+            Window position. If wxDefaultPosition is specified then a default
+        position is chosen.
         @param size
-        Size. Note that either the height or the width (depending on
-        whether the line if horizontal or vertical) is ignored.
-        
+            Size. Note that either the height or the width (depending on
+            whether the line if horizontal or vertical) is ignored.
         @param style
-        Window style (either wxLI_HORIZONTAL or wxLI_VERTICAL).
-        
+            Window style (either wxLI_HORIZONTAL or wxLI_VERTICAL).
         @param name
-        Window name.
-        
-        @sa Create()
+            Window name.
+
+        @see Create()
     */
     wxStaticLine();
     wxStaticLine(wxWindow* parent, wxWindowID id = wxID_ANY,
@@ -83,5 +77,6 @@ public:
     /**
         Returns @true if the line is vertical, @false if horizontal.
     */
-    bool IsVertical();
+    bool IsVertical() const;
 };
+