renamed HasFocus() to IsActive() to avoid confusion with FindFocus(); documented...

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

diff --git a/docs/latex/wx/splitter.tex b/docs/latex/wx/splitter.tex
index 135fbe299e232b70e9d0f592ba80c146547c87b7..06c117d8047fac186554c438caeebdebfcd13d58 100644 (file)
--- a/docs/latex/wx/splitter.tex
+++ b/docs/latex/wx/splitter.tex
@@ -6,14 +6,19 @@ 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.
-

 \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\_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.}

 \end{twocollist}
 
 See also \helpref{window styles overview}{windowstyles}.
 \end{twocollist}
 
 See also \helpref{window styles overview}{windowstyles}.


@@ -28,15 +33,44 @@ See also \helpref{window styles overview}{windowstyles}.
 
 <wx/splitter.h>
 
 
 <wx/splitter.h>
 

+\wxheading{Event handling}
+
+To process input from a splitter control, use the following event handler
+macros to direct input to member functions that take a 
+\helpref{wxSplitterEvent}{wxsplitterevent} argument.
+
+\twocolwidtha{10cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf EVT\_SPLITTER\_SASH\_POS\_CHANGING(id, func)}}{The sash
+position is in the process of being changed. May be used to modify the
+position of the tracking bar to properly reflect the position that
+would be set if the drag were to be completed at this point. Processes
+a wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGING event.}
+\twocolitem{{\bf EVT\_SPLITTER\_SASH\_POS\_CHANGED(id, func)}}{The sash
+position was changed. May be used to modify the sash position before
+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\_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.}
+\end{twocollist}%
+
+\wxheading{See also}
+
+\helpref{wxSplitterEvent}{wxsplitterevent}
+

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxSplitterWindow::wxSplitterWindow}\label{wxsplitterwindowconstr}
+\membersection{wxSplitterWindow::wxSplitterWindow}\label{wxsplitterwindowctor}

 
 \func{}{wxSplitterWindow}{\void}
 
 Default constructor.
 
 
 \func{}{wxSplitterWindow}{\void}
 
 Default constructor.
 

-\func{}{wxSplitterWindow}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id}, \param{int }{x},\rtfsp
+\func{}{wxSplitterWindow}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp

 \param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
 \param{long }{style=wxSP\_3D}, \param{const wxString\&}{ name = "splitterWindow"}}
 
 \param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
 \param{long }{style=wxSP\_3D}, \param{const wxString\&}{ name = "splitterWindow"}}
 


@@ -72,7 +106,7 @@ create and delete the second pane on demand.
 \helpref{wxSplitterWindow::SplitHorizontally}{wxsplitterwindowsplithorizontally},\rtfsp
 \helpref{wxSplitterWindow::Create}{wxsplitterwindowcreate}
 
 \helpref{wxSplitterWindow::SplitHorizontally}{wxsplitterwindowsplithorizontally},\rtfsp
 \helpref{wxSplitterWindow::Create}{wxsplitterwindowcreate}
 

-\membersection{wxSplitterWindow::\destruct{wxSplitterWindow}}
+\membersection{wxSplitterWindow::\destruct{wxSplitterWindow}}\label{wxsplitterwindowdtor}

 
 \func{}{\destruct{wxSplitterWindow}}{\void}
 
 
 \func{}{\destruct{wxSplitterWindow}}{\void}
 


@@ -84,7 +118,7 @@ Destroys the wxSplitterWindow and its children.
 \param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
 \param{long }{style=wxSP\_3D}, \param{const wxString\&}{ name = "splitterWindow"}}
 
 \param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
 \param{long }{style=wxSP\_3D}, \param{const wxString\&}{ name = "splitterWindow"}}
 

-Creation function, for two-step construction. See \helpref{wxSplitterWindow::wxSplitterWindow}{wxsplitterwindowconstr} for
+Creation function, for two-step construction. See \helpref{wxSplitterWindow::wxSplitterWindow}{wxsplitterwindowctor} for

 details.
 
 \membersection{wxSplitterWindow::GetMinimumPaneSize}\label{wxsplitterwindowgetminimumpanesize}
 details.
 
 \membersection{wxSplitterWindow::GetMinimumPaneSize}\label{wxsplitterwindowgetminimumpanesize}


@@ -153,7 +187,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}
 


@@ -198,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 
 \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}
 


@@ -219,10 +253,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}


@@ -237,7 +271,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.
 


@@ -245,7 +279,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}
 


@@ -269,7 +303,9 @@ Sets the minimum pane size.
 
 The default minimum pane size is zero, which means that either pane can be reduced to zero by dragging
 the sash, thus removing one of the panes. To prevent this behaviour (and veto out-of-range sash dragging),
 
 The default minimum pane size is zero, which means that either pane can be reduced to zero by dragging
 the sash, thus removing one of the panes. To prevent this behaviour (and veto out-of-range sash dragging),

-set a minimum size, for example 20 pixels.
+set a minimum size, for example 20 pixels. If the wxSP\_PERMIT\_UNSPLIT style
+is used when a splitter window is created, the window may be unsplit even
+if minimum size is non-zero.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -308,13 +344,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}
 


@@ -341,13 +377,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}
 


@@ -371,7 +407,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}
 


@@ -383,5 +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}
 
 \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.