X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6fb26ea3b3784922bd0613a5e96fda78fac684ac..75d9e502238df95fa53c0030b1fac0d4f43e4025:/docs/latex/wx/sashwin.tex diff --git a/docs/latex/wx/sashwin.tex b/docs/latex/wx/sashwin.tex index 0956e0ea11..2dea05e9b6 100644 --- a/docs/latex/wx/sashwin.tex +++ b/docs/latex/wx/sashwin.tex @@ -11,13 +11,20 @@ via a \helpref{wxSashEvent}{wxsashevent} notification. \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{Window styles} The following styles apply in addition to the normal wxWindow styles. \twocolwidtha{5cm}% \begin{twocollist}\itemsep=0pt -\twocolitem{\windowstyle{wxSW\_3D}}{Draws the sashes in 3D.} +\twocolitem{\windowstyle{wxSW\_3D}}{Draws a 3D effect sash and border.} +\twocolitem{\windowstyle{wxSW\_3DSASH}}{Draws a 3D effect sash.} +\twocolitem{\windowstyle{wxSW\_3DBORDER}}{Draws a 3D effect border.} +\twocolitem{\windowstyle{wxSW\_BORDER}}{Draws a thin black border.} \end{twocollist} See also \helpref{window styles overview}{windowstyles}. @@ -53,13 +60,13 @@ enum wxSashEdgePosition { \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxSashWindow::wxSashWindow} +\membersection{wxSashWindow::wxSashWindow}\label{wxsashwindowctor} \func{}{wxSashWindow}{\void} Default constructor. -\func{}{wxSashWindow}{\param{wxSashWindow*}{ parent}, \param{wxSashWindowID }{id}, +\func{}{wxSashWindow}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxCLIP\_CHILDREN \pipe wxSW\_3D}, @@ -84,7 +91,7 @@ should generate a default size for the window.} \docparam{name}{Window name.} -\membersection{wxSashWindow::\destruct{wxSashWindow}} +\membersection{wxSashWindow::\destruct{wxSashWindow}}\label{wxsashwindowdtor} \func{}{\destruct{wxSashWindow}}{\void} @@ -94,7 +101,7 @@ Destructor. \constfunc{bool}{GetSashVisible}{\param{wxSashEdgePosition }{edge}} -Returns TRUE if a sash is visible on the given edge, FALSE otherwise. +Returns true if a sash is visible on the given edge, false otherwise. \wxheading{Parameters} @@ -124,7 +131,7 @@ Gets the minimum window size in the x direction. \membersection{wxSashWindow::GetMinimumSizeY}\label{wxsashwindowgetminimumsizey} -\constfunc{int}{GetMinimumSizeY}{\param{int}{ min}} +\constfunc{int}{GetMinimumSizeY}{\void} Gets the minimum window size in the y direction. @@ -132,7 +139,8 @@ Gets the minimum window size in the y direction. \constfunc{bool}{HasBorder}{\param{wxSashEdgePosition }{edge}} -Returns TRUE if the sash has a border, FALSE otherwise. +Returns true if the sash has a border, false otherwise. +This function is obsolete since the sash border property is unused. \wxheading{Parameters} @@ -176,28 +184,26 @@ Call this function to make a sash visible or invisible on a particular edge. \docparam{edge}{Edge to change. One of wxSASH\_TOP, wxSASH\_RIGHT, wxSASH\_BOTTOM, wxSASH\_LEFT.} -\docparam{visible}{TRUE to make the sash visible, FALSE to make it invisible.} +\docparam{visible}{true to make the sash visible, false to make it invisible.} \wxheading{See also} \helpref{wxSashWindow::GetSashVisible}{wxsashwindowgetsashvisible} - // Set whether there's a border in this position - inline void SetSashBorder(wxSashEdgePosition edge, bool border) { m_sashes[edge].m_border = border; } - \membersection{wxSashWindow::SetSashBorder}\label{wxsashwindowsetsashborder} \func{void}{SetSashBorder}{\param{wxSashEdgePosition }{edge}, \param{bool}{ hasBorder}} Call this function to give the sash a border, or remove the border. +This function is obsolete since the sash border property is unused. \wxheading{Parameters} \docparam{edge}{Edge to change. One of wxSASH\_TOP, wxSASH\_RIGHT, wxSASH\_BOTTOM, wxSASH\_LEFT.} -\docparam{hasBorder}{TRUE to give the sash a border visible, FALSE to remove it.} +\docparam{hasBorder}{true to give the sash a border visible, false to remove it.} \wxheading{See also} -\helpref{wxSashWindow::HashBorder}{wxsashwindowhasborder} +\helpref{wxSashWindow::HasBorder}{wxsashwindowhasborder}