AuroraMiddleware/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated splitter docs to describe new wxSP_PERMIT_UNSPLIT style and

Browse Source 
wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED splitter event type.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@2553 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Unknown (BV) 1999-05-24 17:51:44 +00:00
parent 370938d99c
commit 255d88eb5d
2 changed files with 40 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/latex/wx/splitevt.tex
View File

@ -4,8 +4,8 @@ This class represents the events generated by a splitter control. Also there is
only one event class, the data associated to the different events is not the
same and so not all accessor functions may be called for each event. The
documentation mentions the kind of event(s) for which the given acessor
function makes sense - calling it for other types of events will result in
assert failure (in debug mode) and will return meaningless results.
function makes sense: calling it for other types of events will result
in assert failure (in debug mode) and will return meaningless results.
\wxheading{Derived from}
@ -24,15 +24,21 @@ functions that take a 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 prevent the change from taking place.
Processes wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED event.}
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 wxEVT\_COMMAND\_SPLITTER\_UNSPLIT event.}
unsplit. Processes a wxEVT\_COMMAND\_SPLITTER\_UNSPLIT event.}
\twocolitem{{\bf EVT\_SPLITTER\_DOUBLECLICKED(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 wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED event}
Processes a wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED event.}
\end{twocollist}%
\wxheading{See also}
@ -40,8 +46,10 @@ Processes wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED event}
\helpref{wxSplitterWindow}{wxsplitterwindow},\rtfsp
\helpref{Event handling overview}{eventhandlingoverview}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxSplitterEvent::wxSplitterEvent}\label{wxsplittereventconstr}
\func{}{wxSplitterEvent}{\param{wxEventType}{ eventType = wxEVT\_NULL},
@ -49,6 +57,7 @@ Processes wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED event}
Constructor. Used internally by wxWindows only.
\membersection{wxSplitterEvent::GetSashPosition}\label{wxsplittereventgetsashposition}
\constfunc{int}{GetSashPosition}{\void}
@ -56,6 +65,7 @@ Constructor. Used internally by wxWindows only.
Returns the new sash position.
May only be called while processing
wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGING and
wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events.
@ -93,12 +103,18 @@ wxEVT\_COMMAND\_SPLITTER\_UNSPLIT events.
\func{void}{SetSashPosition}{\param{int}{pos}}
Sets the new sash position. Set to -1 from the event handler code to prevent
the sash from repositioning.
In the case of wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events,
sets the the new sash position. In the case of
wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGING events, sets the new
tracking bar position so visual feedback during dragging will
represent that change that will actually take place. Set to -1 from
the event handler code to prevent repositioning.
May only be called while processing
wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGING and
wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED events.
\wxheading{Paramters}
\docparam{pos}{New sash position.}

24
docs/latex/wx/splitter.tex
View File

@ -14,6 +14,8 @@ Appropriate 3D shading for the Windows 95 user interface is an option.
\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\_PERMIT\_UNSPLIT}}{The can always be
unsplit, even if the minimum pane size is set to something other than zero.}
\end{twocollist}
See also \helpref{window styles overview}{windowstyles}.
@ -36,15 +38,21 @@ macros to direct input to member functions that take a
\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 prevent the change from taking place.
Processes wxEVT\_COMMAND\_SPLITTER\_SASH\_POS\_CHANGED event.}
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 wxEVT\_COMMAND\_SPLITTER\_UNSPLIT event.}
unsplit. Processes a wxEVT\_COMMAND\_SPLITTER\_UNSPLIT event.}
\twocolitem{{\bf EVT\_SPLITTER\_DOUBLECLICKED(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 wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED event}
Processes a wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED event.}
\end{twocollist}%
\wxheading{See also}
@ -59,7 +67,7 @@ Processes wxEVT\_COMMAND\_SPLITTER\_DOUBLECLICKED event}
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"}}
@ -292,7 +300,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),
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}
@ -406,5 +416,3 @@ 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}