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         @param id
  39             Window identifier. The value wxID_ANY indicates a default value.
  40         @param pos
  41             Window position. If wxDefaultPosition is specified then a default
  42         position is chosen.
  43         @param size
  44             Size. Note that either the height or the width (depending on
  45             whether the line if horizontal or vertical) is ignored.
  46         @param style
  47             Window style (either wxLI_HORIZONTAL or wxLI_VERTICAL).
  48         @param name
  49             Window name.
  50
  51         @see Create()
  52     */
  53     wxStaticLine();
  54     wxStaticLine(wxWindow* parent, wxWindowID id = wxID_ANY,
  55                  const wxPoint& pos = wxDefaultPosition,
  56                  const wxSize& size = wxDefaultSize,
  57                  long style = wxLI_HORIZONTAL,
  58                  const wxString& name = "staticLine");
  59     //@}
  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 };