git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	\section{\class{wxSashLayoutWindow}}\label{wxsashlayoutwindow}
	2
	3	wxSashLayoutWindow responds to OnCalculateLayout events generated
	4	by \helpref{wxLayoutAlgorithm}{wxlayoutalgorithm}. It allows the
	5	application to use simple accessors to specify how the window should be
	6	laid out, rather than having to respond to events. The fact that
	7	the class derives from wxSashWindow allows sashes to be used if required,
	8	to allow the windows to be user-resizable.
	9
	10	The documentation for \helpref{wxLayoutAlgorithm}{wxlayoutalgorithm} explains
	11	the purpose of this class in more detail.
	12
	13	\wxheading{Derived from}
	14
	15	\helpref{wxSashWindow}{wxsashwindow}\\
	16	\helpref{wxWindow}{wxwindow}\\
	17	\helpref{wxEvtHandler}{wxevthandler}\\
	18	\helpref{wxObject}{wxobject}
	19
	20	\wxheading{Include files}
	21
	22	<wx/laywin.h>
	23
	24	\wxheading{Window styles}
	25
	26	See \helpref{wxSashWindow}{wxsashwindow}.
	27
	28	\wxheading{Event handling}
	29
	30	This class handles the EVT\_QUERY\_LAYOUT\_INFO and EVT\_CALCULATE\_LAYOUT events
	31	for you. However, if you use sashes, see \helpref{wxSashWindow}{wxsashwindow} for
	32	relevant event information.
	33
	34	See also \helpref{wxLayoutAlgorithm}{wxlayoutalgorithm} for information
	35	about the layout events.
	36
	37	\wxheading{See also}
	38
	39	\helpref{wxLayoutAlgorithm}{wxlayoutalgorithm}, \helpref{wxSashWindow}{wxsashwindow}, \helpref{Event handling overview}{eventhandlingoverview}
	40
	41	\latexignore{\rtfignore{\wxheading{Members}}}
	42
	43	\membersection{wxSashLayoutWindow::wxSashLayoutWindow}\label{wxsashlayoutwindowctor}
	44
	45	\func{}{wxSashLayoutWindow}{\void}
	46
	47	Default constructor.
	48
	49	\func{}{wxSashLayoutWindow}{\param{wxSashLayoutWindow*}{ parent}, \param{wxSashLayoutWindowID }{id},
	50	\param{const wxPoint\& }{pos = wxDefaultPosition},
	51	\param{const wxSize\& }{size = wxDefaultSize},
	52	\param{long }{style = wxCLIP\_CHILDREN \pipe wxSW\_3D},
	53	\param{const wxString\& }{name = "layoutWindow"}}
	54
	55	Constructs a sash layout window, which can be a child of a frame, dialog or any other non-control window.
	56
	57	\wxheading{Parameters}
	58
	59	\docparam{parent}{Pointer to a parent window.}
	60
	61	\docparam{id}{Window identifier. If -1, will automatically create an identifier.}
	62
	63	\docparam{pos}{Window position. wxDefaultPosition is (-1, -1) which indicates that wxSashLayoutWindows
	64	should generate a default position for the window. If using the wxSashLayoutWindow class directly, supply
	65	an actual position.}
	66
	67	\docparam{size}{Window size. wxDefaultSize is (-1, -1) which indicates that wxSashLayoutWindows
	68	should generate a default size for the window.}
	69
	70	\docparam{style}{Window style. For window styles, please see \helpref{wxSashLayoutWindow}{wxsashlayoutwindow}.}
	71
	72	\docparam{name}{Window name.}
	73
	74	\membersection{wxSashLayoutWindow::\destruct{wxSashLayoutWindow}}\label{wxsashlayoutwindowdtor}
	75
	76	\func{}{\destruct{wxSashLayoutWindow}}{\void}
	77
	78	Destructor.
	79
	80	\membersection{wxSashLayoutWindow::GetAlignment}\label{wxsashlayoutwindowgetalignment}
	81
	82	\constfunc{wxLayoutAlignment}{GetAlignment}{\void}
	83
	84	Returns the alignment of the window: one of wxLAYOUT\_TOP, wxLAYOUT\_LEFT, wxLAYOUT\_RIGHT, wxLAYOUT\_BOTTOM.
	85
	86	\membersection{wxSashLayoutWindow::GetOrientation}\label{wxsashlayoutwindowgetorientation}
	87
	88	\constfunc{wxLayoutOrientation}{GetOrientation}{\void}
	89
	90	Returns the orientation of the window: one of wxLAYOUT\_HORIZONTAL, wxLAYOUT\_VERTICAL.
	91
	92	\membersection{wxSashLayoutWindow::OnCalculateLayout}\label{wxsashlayoutwindowoncalculatelayout}
	93
	94	\func{void}{OnCalculateLayout}{\param{wxCalculateLayoutEvent\&}{ event}}
	95
	96	The default handler for the event that is generated by wxLayoutAlgorithm. The implementation
	97	of this function calls wxCalculateLayoutEvent::SetRect to shrink the provided size according to
	98	how much space this window takes up. For further details,
	99	see \helpref{wxLayoutAlgorithm}{wxlayoutalgorithm} and \helpref{wxCalculateLayoutEvent}{wxcalculatelayoutevent}.
	100
	101	\membersection{wxSashLayoutWindow::OnQueryLayoutInfo}\label{wxsashlayoutwindowonquerylayoutinfo}
	102
	103	\func{void}{OnQueryLayoutInfo}{\param{wxQueryLayoutInfoEvent\&}{ event}}
	104
	105	The default handler for the event that is generated by OnCalculateLayout to get
	106	size, alignment and orientation information for the window. The implementation
	107	of this function uses member variables as set by accessors called by the application.
	108	For further details, see \helpref{wxLayoutAlgorithm}{wxlayoutalgorithm} and \helpref{wxQueryLayoutInfoEvent}{wxquerylayoutinfoevent}.
	109
	110	\membersection{wxSashLayoutWindow::SetAlignment}\label{wxsashlayoutwindowsetalignment}
	111
	112	\func{void}{SetAlignment}{\param{wxLayoutAlignment}{ alignment}}
	113
	114	Sets the alignment of the window (which edge of the available parent client area the window
	115	is attached to). {\it alignment} is one of wxLAYOUT\_TOP, wxLAYOUT\_LEFT, wxLAYOUT\_RIGHT, wxLAYOUT\_BOTTOM.
	116
	117	\membersection{wxSashLayoutWindow::SetDefaultSize}\label{wxsashlayoutwindowsetdefaultsize}
	118
	119	\func{void}{SetDefaultSize}{\param{const wxSize\& }{size}}
	120
	121	Sets the default dimensions of the window. The dimension other than the orientation will be fixed to this
	122	value, and the orientation dimension will be ignored and the window stretched to fit the available space.
	123
	124	\membersection{wxSashLayoutWindow::SetOrientation}\label{wxsashlayoutwindowsetorientation}
	125
	126	\func{void}{SetOrientation}{\param{wxLayoutOrientation}{ orientation}}
	127
	128	Sets the orientation of the window (the direction the window will stretch in, to fill the available
	129	parent client area). {\it orientation} is one of wxLAYOUT\_HORIZONTAL, wxLAYOUT\_VERTICAL.
	130
	131
	132