]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/statline.h
fixing file paths after renaming
[wxWidgets.git] / interface / statline.h
index dc763a4bef0f43d3ab71b59152ae9790252c2059..226f28a70a55f29921610eb33146d6c716985f42 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
@@ -9,59 +9,55 @@
 /**
     @class wxStaticLine
     @wxheader{statline.h}
-    
+
     A static line is just a line which may be used in a dialog to separate the
     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
 {
 public:
-    //@{
     /**
-        Constructor, creating and showing a static line.
-        
-        @param parent 
-        Parent window. Must not be @NULL.
-        
-        @param id 
-        Window identifier. The value wxID_ANY indicates a default value.
-        
-        @param pos 
-        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.
-        
-        @param style 
-        Window style (either wxLI_HORIZONTAL or wxLI_VERTICAL).
-        
-        @param name 
-        Window name.
-        
-        @sa Create()
+      Default constructor
     */
     wxStaticLine();
-        wxStaticLine(wxWindow* parent, wxWindowID id = wxID_ANY,
-                     const wxPoint& pos = wxDefaultPosition,
-                     const wxSize& size = wxDefaultSize,
-                     long style = wxLI_HORIZONTAL,
-                     const wxString& name = "staticLine");
-    //@}
+    
+    /**
+        Constructor, creating and showing a static line.
+
+        @param parent
+            Parent window. Must not be @NULL.
+        @param id
+            Window identifier. The value wxID_ANY indicates a default value.
+        @param pos
+            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.
+        @param style
+            Window style (either wxLI_HORIZONTAL or wxLI_VERTICAL).
+        @param name
+            Window name.
+
+        @see Create()
+    */
+    wxStaticLine(wxWindow* parent, wxWindowID id = wxID_ANY,
+                 const wxPoint& pos = wxDefaultPosition,
+                 const wxSize& size = wxDefaultSize,
+                 long style = wxLI_HORIZONTAL,
+                 const wxString& name = "staticLine");
 
     /**
         Creates the static line for two-step construction. See wxStaticLine()
@@ -83,5 +79,6 @@ public:
     /**
         Returns @true if the line is vertical, @false if horizontal.
     */
-    bool IsVertical();
+    bool IsVertical() const;
 };
+