v2.2.1 TAGGED copy ported over to main trunk of CVS

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

\section{wxSplitterWindow overview}\label{wxsplitterwindowoverview}

Classes: \helpref{wxSplitterWindow}{wxsplitterwindow}

The following screenshot shows the appearance of a splitter window with a vertical split.

$$\image{8cm;0cm}{splitter.eps}$$

The style wxSP\_3D has been used to show a 3D border and 3D sash.

\subsection{Example}

The following fragment shows how to create a splitter window, creating two
subwindows and hiding one of them.

{\small
\begin{verbatim}
  splitter = new wxSplitterWindow(this, -1, wxPoint(0, 0), wxSize(400, 400), wxSP_3D);

  leftWindow = new MyWindow(splitter);
  leftWindow->SetScrollbars(20, 20, 50, 50);

  rightWindow = new MyWindow(splitter);
  rightWindow->SetScrollbars(20, 20, 50, 50);
  rightWindow->Show(FALSE);

  splitter->Initialize(leftWindow);

  // Set this to prevent unsplitting
//    splitter->SetMinimumPaneSize(20);
\end{verbatim}
}

The next fragment shows how the splitter window can be manipulated after creation.

{\small
\begin{verbatim}
  void MyFrame::OnSplitVertical(wxCommandEvent& event)
  {
        if ( splitter->IsSplit() )
            splitter->Unsplit();
        leftWindow->Show(TRUE);
        rightWindow->Show(TRUE);
        splitter->SplitVertically( leftWindow, rightWindow );
  }

  void MyFrame::OnSplitHorizontal(wxCommandEvent& event)
  {
        if ( splitter->IsSplit() )
            splitter->Unsplit();
        leftWindow->Show(TRUE);
        rightWindow->Show(TRUE);
        splitter->SplitHorizontally( leftWindow, rightWindow );
  }

  void MyFrame::OnUnsplit(wxCommandEvent& event)
  {
        if ( splitter->IsSplit() )
            splitter->Unsplit();
  }
\end{verbatim}
}