Added missing description for wxNO_BORDER

[wxWidgets.git] / docs / latex / wx / splitter.tex

diff --git a/docs/latex/wx/splitter.tex b/docs/latex/wx/splitter.tex
index 879dc1271402b8ce6532e2b57836f1bb23d95670..a76b73188b4bcba8248ec1f2f2ab2ba8dc62338b 100644 (file)
--- a/docs/latex/wx/splitter.tex
+++ b/docs/latex/wx/splitter.tex
@@ -6,15 +6,18 @@ This class manages up to two subwindows. The current view can be
 split into two programmatically (perhaps from a menu command), and unsplit
 either programmatically or via the wxSplitterWindow user interface.
 
 split into two programmatically (perhaps from a menu command), and unsplit
 either programmatically or via the wxSplitterWindow user interface.
 

-Appropriate 3D shading for the Windows 95 user interface is an option.
-This is also recommended for GTK.
+Appropriate 3D shading for the Windows 95 user interface is an option -
+this is also recommended for GTK. Optionally, the sash can be made to
+look more like the native control under MacOS X.

 
 \wxheading{Window styles}
 
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\windowstyle{wxSP\_3D}}{Draws a 3D effect border and sash.}
 
 \wxheading{Window styles}
 
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\windowstyle{wxSP\_3D}}{Draws a 3D effect border and sash.}

-\twocolitem{\windowstyle{wxSP\_BORDER}}{Draws a thin black border around the window, and a black sash.}
-\twocolitem{\windowstyle{wxSP\_NOBORDER}}{No border, and a black sash.}
+\twocolitem{\windowstyle{wxSP\_3DSASH}}{Draws a 3D effect sash.}
+\twocolitem{\windowstyle{wxSP\_3DBORDER}}{Synonym for wxSP\_BORDER.}
+\twocolitem{\windowstyle{wxSP\_BORDER}}{Draws a standard border.}
+\twocolitem{\windowstyle{wxSP\_NOBORDER}}{No border (default).}

 \twocolitem{\windowstyle{wxSP\_PERMIT\_UNSPLIT}}{Always allow to
 unsplit, even with the minimum pane size other than zero.}
 \twocolitem{\windowstyle{wxSP\_LIVE\_UPDATE}}{Don't draw XOR line but resize the child windows immediately.}
 \twocolitem{\windowstyle{wxSP\_PERMIT\_UNSPLIT}}{Always allow to
 unsplit, even with the minimum pane size other than zero.}
 \twocolitem{\windowstyle{wxSP\_LIVE\_UPDATE}}{Don't draw XOR line but resize the child windows immediately.}


@@ -51,7 +54,7 @@ it is set, or to prevent the change from taking place.
 Processes a wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED event.}
 \twocolitem{{\bf EVT\_SPLITTER\_UNSPLIT(id, func)}}{The splitter has been just
 unsplit. Processes a wxEVT\_COMMAND\_SPLITTER\_UNSPLIT event.}
 Processes a wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED event.}
 \twocolitem{{\bf EVT\_SPLITTER\_UNSPLIT(id, func)}}{The splitter has been just
 unsplit. Processes a wxEVT\_COMMAND\_SPLITTER\_UNSPLIT event.}

-\twocolitem{{\bf EVT\_SPLITTER\_DOUBLECLICKED(id, func)}}{The sash was double
+\twocolitem{{\bf EVT\_SPLITTER\_DCLICK(id, func)}}{The sash was double

 clicked. The default behaviour is to unsplit the window when this happens
 (unless the minimum pane size has been set to a value greater than zero).
 Processes a wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED event.}
 clicked. The default behaviour is to unsplit the window when this happens
 (unless the minimum pane size has been set to a value greater than zero).
 Processes a wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED event.}


@@ -186,7 +189,7 @@ This should be called if you wish to initially view only a single pane in the sp
 
 \constfunc{bool}{IsSplit}{\void}
 
 
 \constfunc{bool}{IsSplit}{\void}
 

-Returns TRUE if the window is split, FALSE otherwise.
+Returns true if the window is split, false otherwise.

 
 \membersection{wxSplitterWindow::OnDoubleClickSash}\label{wxsplitterwindowondoubleclicksash}
 
 
 \membersection{wxSplitterWindow::OnDoubleClickSash}\label{wxsplitterwindowondoubleclicksash}
 


@@ -231,7 +234,7 @@ may wish to delete the window.
 \func{virtual bool}{OnSashPositionChange}{\param{int }{newSashPosition}}
 
 Application-overridable function called when the sash position is changed by 
 \func{virtual bool}{OnSashPositionChange}{\param{int }{newSashPosition}}
 
 Application-overridable function called when the sash position is changed by 

-user. It may return FALSE to prevent the change or TRUE to allow it.
+user. It may return false to prevent the change or true to allow it.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -252,10 +255,10 @@ and then resplitting the window back because it will provoke much less flicker
 (if any). It is valid to call this function whether the splitter has two
 windows or only one.
 
 (if any). It is valid to call this function whether the splitter has two
 windows or only one.
 

-Both parameters should be non NULL and {\it winOld} must specify one of the
+Both parameters should be non-NULL and {\it winOld} must specify one of the

 windows managed by the splitter. If the parameters are incorrect or the window
 windows managed by the splitter. If the parameters are incorrect or the window

-couldn't be replaced, FALSE is returned. Otherwise the function will return
-TRUE, but please notice that it will not delete the replaced window and you
+couldn't be replaced, false is returned. Otherwise the function will return
+true, but please notice that it will not delete the replaced window and you

 may wish to do it yourself.
 
 \wxheading{See also}
 may wish to do it yourself.
 
 \wxheading{See also}


@@ -270,7 +273,7 @@ may wish to do it yourself.
 
 \membersection{wxSplitterWindow::SetSashPosition}\label{wxsplitterwindowsetsashposition}
 
 
 \membersection{wxSplitterWindow::SetSashPosition}\label{wxsplitterwindowsetsashposition}
 

-\func{void}{SetSashPosition}{\param{int }{position}, \param{const bool}{ redraw = TRUE}}
+\func{void}{SetSashPosition}{\param{int }{position}, \param{const bool}{ redraw = true}}

 
 Sets the sash position.
 
 
 Sets the sash position.
 


@@ -278,7 +281,7 @@ Sets the sash position.
 
 \docparam{position}{The sash position in pixels.}
 
 
 \docparam{position}{The sash position in pixels.}
 

-\docparam{redraw}{If TRUE, resizes the panes and redraws the sash and border.}
+\docparam{redraw}{If true, resizes the panes and redraws the sash and border.}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -343,13 +346,13 @@ Initializes the top and bottom panes of the splitter window.
 \docparam{window2}{The bottom pane.}
 
 \docparam{sashPosition}{The initial position of the sash. If this value is
 \docparam{window2}{The bottom pane.}
 
 \docparam{sashPosition}{The initial position of the sash. If this value is

-positive, it specifies the size of the upper pane. If it's negative, it's
+positive, it specifies the size of the upper pane. If it is negative, it is

 absolute value gives the size of the lower pane. Finally, specify 0 (default)
 to choose the default position (half of the total window height).}
 
 \wxheading{Return value}
 
 absolute value gives the size of the lower pane. Finally, specify 0 (default)
 to choose the default position (half of the total window height).}
 
 \wxheading{Return value}
 

-TRUE if successful, FALSE otherwise (the window was already split).
+true if successful, false otherwise (the window was already split).

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -376,13 +379,13 @@ Initializes the left and right panes of the splitter window.
 \docparam{window2}{The right pane.}
 
 \docparam{sashPosition}{The initial position of the sash. If this value is
 \docparam{window2}{The right pane.}
 
 \docparam{sashPosition}{The initial position of the sash. If this value is

-positive, it specifies the size of the left pane. If it's negative, it's
+positive, it specifies the size of the left pane. If it is negative, it is

 absolute value gives the size of the right pane. Finally, specify 0 (default)
 to choose the default position (half of the total window width).}
 
 \wxheading{Return value}
 
 absolute value gives the size of the right pane. Finally, specify 0 (default)
 to choose the default position (half of the total window width).}
 
 \wxheading{Return value}
 

-TRUE if successful, FALSE otherwise (the window was already split).
+true if successful, false otherwise (the window was already split).

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -406,7 +409,7 @@ Unsplits the window.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE if successful, FALSE otherwise (the window was not split).
+true if successful, false otherwise (the window was not split).

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}