]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/sashwin.tex
Don't use const bool.
[wxWidgets.git] / docs / latex / wx / sashwin.tex
index 9094aeb7295961353ba315d67f980b3cb731b702..2dea05e9b67e4fb405fe0676d0c94cdc0373ff85 100644 (file)
@@ -11,13 +11,20 @@ via a \helpref{wxSashEvent}{wxsashevent} notification.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/sashwin.h>
+
 \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,7 +184,7 @@ 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}
 
@@ -187,14 +195,15 @@ Call this function to make a sash visible or invisible on a particular edge.
 \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}