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