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