X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f6bcfd974ef26faf6f91a62cac09827e09463fd1..733a25f0f454eefbb1392faad986d8dde7919230:/docs/latex/wx/splitter.tex diff --git a/docs/latex/wx/splitter.tex b/docs/latex/wx/splitter.tex index bd311fcabc..95e93eeb8f 100644 --- a/docs/latex/wx/splitter.tex +++ b/docs/latex/wx/splitter.tex @@ -6,18 +6,16 @@ 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. -Appropriate 3D shading for the Windows 95 user interface is an option. -This is also recommended for GTK. - \wxheading{Window styles} \begin{twocollist}\itemsep=0pt \twocolitem{\windowstyle{wxSP\_3D}}{Draws a 3D effect border and sash.} \twocolitem{\windowstyle{wxSP\_3DSASH}}{Draws a 3D effect sash.} -\twocolitem{\windowstyle{wxSP\_3DBORDER}}{Draws a 3D effect border.} -\twocolitem{\windowstyle{wxSP\_FULLSASH}}{Draws the ends of the sash (so the window can be used without a border).} -\twocolitem{\windowstyle{wxSP\_BORDER}}{Draws a thin black border around the window.} -\twocolitem{\windowstyle{wxSP\_NOBORDER}}{No border, and a black 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\_NO\_XP\_THEME}}{Under Windows XP, switches off the attempt to draw the +splitter using Windows XP theming, so the borders and sash will take on the pre-XP look.} \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.} @@ -54,7 +52,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.} -\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.} @@ -189,7 +187,7 @@ This should be called if you wish to initially view only a single pane in the sp \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} @@ -234,7 +232,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 -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} @@ -257,8 +255,8 @@ windows or only one. 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 -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} @@ -273,7 +271,7 @@ may wish to do it yourself. \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. @@ -281,7 +279,7 @@ Sets the sash position. \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} @@ -352,7 +350,7 @@ 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} @@ -385,7 +383,7 @@ 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} @@ -409,7 +407,7 @@ Unsplits the window. \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} @@ -421,3 +419,17 @@ which can be overridden for the desired behaviour. By default, the pane being re \helpref{wxSplitterWindow::SplitHorizontally}{wxsplitterwindowsplithorizontally}, \helpref{wxSplitterWindow::SplitVertically}{wxsplitterwindowsplitvertically},\rtfsp \helpref{wxSplitterWindow::IsSplit}{wxsplitterwindowissplit}, \helpref{wxSplitterWindow::OnUnsplit}{wxsplitterwindowonunsplit} +\membersection{wxSplitterWindow::UpdateSize}\label{wxsplitterwindowupdatesize} + +\func{void}{UpdateSize}{\void} + +Causes any pending sizing of the sash and child panes to take place +immediately. + +Such resizing normally takes place in idle time, in order +to wait for layout to be completed. However, this can cause +unacceptable flicker as the panes are resized after the window has been +shown. To work around this, you can perform window layout (for +example by sending a size event to the parent window), and then +call this function, before showing the top-level window. +