interface/statline.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        statline.h
   3 // Purpose:     interface of wxStaticLine
   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     @see wxStaticBox
  27 */
  28 class wxStaticLine : public wxControl
  29 {
  30 public:
  31     /**
  32       Default constructor
  33     */
  34     wxStaticLine();
  35
  36     /**
  37         Constructor, creating and showing a static line.
  38
  39         @param parent
  40             Parent window. Must not be @NULL.
  41         @param id
  42             Window identifier. The value wxID_ANY indicates a default value.
  43         @param pos
  44             Window position. If wxDefaultPosition is specified then a default
  45         position is chosen.
  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         @param style
  50             Window style (either wxLI_HORIZONTAL or wxLI_VERTICAL).
  51         @param name
  52             Window name.
  53
  54         @see Create()
  55     */
  56     wxStaticLine(wxWindow* parent, wxWindowID id = wxID_ANY,
  57                  const wxPoint& pos = wxDefaultPosition,
  58                  const wxSize& size = wxDefaultSize,
  59                  long style = wxLI_HORIZONTAL,
  60                  const wxString& name = "staticLine");
  61
  62     /**
  63         Creates the static line for two-step construction. See wxStaticLine()
  64         for further details.
  65     */
  66     bool Create(wxWindow* parent, wxWindowID id = wxID_ANY,
  67                 const wxPoint& pos = wxDefaultPosition,
  68                 const wxSize& size = wxDefaultSize,
  69                 long style = 0,
  70                 const wxString& name = "staticLine");
  71
  72     /**
  73         This static function returns the size which will be given to the smaller
  74         dimension of the static line, i.e. its height for a horizontal line or its
  75         width for a vertical one.
  76     */
  77     int GetDefaultSize();
  78
  79     /**
  80         Returns @true if the line is vertical, @false if horizontal.
  81     */
  82     bool IsVertical() const;
  83 };
  84