]> git.saurik.com Git - wxWidgets.git/blame - interface/wx/statline.h
Try native method first in LoadFile() and SaveFile()
[wxWidgets.git] / interface / wx / statline.h
CommitLineData
23324ae1
FM
1/////////////////////////////////////////////////////////////////////////////
2// Name: statline.h
e54c96f1 3// Purpose: interface of wxStaticLine
23324ae1 4// Author: wxWidgets team
526954c5 5// Licence: wxWindows licence
23324ae1
FM
6/////////////////////////////////////////////////////////////////////////////
7
8/**
9 @class wxStaticLine
7c913512 10
23324ae1 11 A static line is just a line which may be used in a dialog to separate the
98a66b61
VZ
12 groups of controls.
13
14 The line may be only vertical or horizontal. Moreover, not all ports
15 (notably not wxGTK) support specifying the transversal direction of the
d13b34d3 16 line (e.g. height for a horizontal line) so for maximal portability you
98a66b61 17 should specify it as wxDefaultCoord.
7c913512 18
23324ae1 19 @beginStyleTable
8c6791e4 20 @style{wxLI_HORIZONTAL}
23324ae1 21 Creates a horizontal line.
8c6791e4 22 @style{wxLI_VERTICAL}
23324ae1
FM
23 Creates a vertical line.
24 @endStyleTable
7c913512 25
23324ae1 26 @library{wxcore}
4701dc09 27 @category{ctrl}
7c913512 28
e54c96f1 29 @see wxStaticBox
23324ae1
FM
30*/
31class wxStaticLine : public wxControl
32{
33public:
671600d8
RR
34 /**
35 Default constructor
36 */
37 wxStaticLine();
4701dc09 38
23324ae1
FM
39 /**
40 Constructor, creating and showing a static line.
3c4f71cc 41
7c913512 42 @param parent
4cc4bfaf 43 Parent window. Must not be @NULL.
7c913512 44 @param id
4cc4bfaf 45 Window identifier. The value wxID_ANY indicates a default value.
7c913512 46 @param pos
4701dc09 47 Window position.
dc1b07fd 48 If ::wxDefaultPosition is specified then a default position is chosen.
7c913512 49 @param size
4cc4bfaf
FM
50 Size. Note that either the height or the width (depending on
51 whether the line if horizontal or vertical) is ignored.
7c913512 52 @param style
4cc4bfaf 53 Window style (either wxLI_HORIZONTAL or wxLI_VERTICAL).
7c913512 54 @param name
4cc4bfaf 55 Window name.
3c4f71cc 56
4cc4bfaf 57 @see Create()
23324ae1 58 */
7c913512
FM
59 wxStaticLine(wxWindow* parent, wxWindowID id = wxID_ANY,
60 const wxPoint& pos = wxDefaultPosition,
61 const wxSize& size = wxDefaultSize,
62 long style = wxLI_HORIZONTAL,
11e3af6e 63 const wxString& name = wxStaticLineNameStr);
23324ae1
FM
64
65 /**
4701dc09
FM
66 Creates the static line for two-step construction.
67 See wxStaticLine() for further details.
23324ae1
FM
68 */
69 bool Create(wxWindow* parent, wxWindowID id = wxID_ANY,
70 const wxPoint& pos = wxDefaultPosition,
5267aefd
FM
71 const wxSize& size = wxDefaultSize, long style = wxLI_HORIZONTAL,
72 const wxString& name = wxStaticLineNameStr);
23324ae1
FM
73
74 /**
75 This static function returns the size which will be given to the smaller
76 dimension of the static line, i.e. its height for a horizontal line or its
77 width for a vertical one.
78 */
adaaa686 79 static int GetDefaultSize();
23324ae1
FM
80
81 /**
82 Returns @true if the line is vertical, @false if horizontal.
83 */
328f5751 84 bool IsVertical() const;
23324ae1 85};
e54c96f1 86