interface/statline.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        statline.h
   3 // Purpose:     documentation for wxStaticLine class
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxStaticLine
  11     @wxheader{statline.h}
  12
  13     A static line is just a line which may be used in a dialog to separate the
  14     groups of controls. The line may be only vertical or horizontal.
  15
  16     @beginStyleTable
  17     @style{wxLI_HORIZONTAL}:
  18            Creates a horizontal line.
  19     @style{wxLI_VERTICAL}:
  20            Creates a vertical line.
  21     @endStyleTable
  22
  23     @library{wxcore}
  24     @category{FIXME}
  25
  26     @seealso
  27     wxStaticBox
  28 */
  29 class wxStaticLine : public wxControl
  30 {
  31 public:
  32     //@{
  33     /**
  34         Constructor, creating and showing a static line.
  35
  36         @param parent
  37         Parent window. Must not be @NULL.
  38
  39         @param id
  40         Window identifier. The value wxID_ANY indicates a default value.
  41
  42         @param pos
  43         Window position. If wxDefaultPosition is specified then a default position
  44         is chosen.
  45
  46         @param size
  47         Size. Note that either the height or the width (depending on
  48         whether the line if horizontal or vertical) is ignored.
  49
  50         @param style
  51         Window style (either wxLI_HORIZONTAL or wxLI_VERTICAL).
  52
  53         @param name
  54         Window name.
  55
  56         @sa Create()
  57     */
  58     wxStaticLine();
  59         wxStaticLine(wxWindow* parent, wxWindowID id = wxID_ANY,
  60                      const wxPoint& pos = wxDefaultPosition,
  61                      const wxSize& size = wxDefaultSize,
  62                      long style = wxLI_HORIZONTAL,
  63                      const wxString& name = "staticLine");
  64     //@}
  65
  66     /**
  67         Creates the static line for two-step construction. See wxStaticLine()
  68         for further details.
  69     */
  70     bool Create(wxWindow* parent, wxWindowID id = wxID_ANY,
  71                 const wxPoint& pos = wxDefaultPosition,
  72                 const wxSize& size = wxDefaultSize,
  73                 long style = 0,
  74                 const wxString& name = "staticLine");
  75
  76     /**
  77         This static function returns the size which will be given to the smaller
  78         dimension of the static line, i.e. its height for a horizontal line or its
  79         width for a vertical one.
  80     */
  81     int GetDefaultSize();
  82
  83     /**
  84         Returns @true if the line is vertical, @false if horizontal.
  85     */
  86     bool IsVertical();
  87 };