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