docs/doxygen/overviews/splitterwindow.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        splitterwindow.h
   3 // Purpose:     topic overview
   4 // Author:      wxWidgets team
   5 // Licence:     wxWindows licence
   6 /////////////////////////////////////////////////////////////////////////////
   7
   8 /**
   9
  10 @page overview_splitterwindow wxSplitterWindow Overview
  11
  12 @tableofcontents
  13
  14 @see wxSplitterWindow
  15
  16
  17
  18 @section overview_splitterwindow_appearance Appearance
  19
  20 The following screenshot shows the appearance of a splitter window with a
  21 horizontal split.
  22
  23 The style wxSP_3D has been used to show a 3D border and 3D sash.
  24
  25 @image html overview_splitter_3d.png
  26
  27
  28 @section overview_splitterwindow_example Example
  29
  30 The following fragment shows how to create a splitter window, creating two
  31 subwindows and hiding one of them.
  32
  33 @code
  34 splitter = new wxSplitterWindow(this, -1, wxPoint(0, 0),
  35                                 wxSize(400, 400), wxSP_3D);
  36
  37 leftWindow = new MyWindow(splitter);
  38 leftWindow->SetScrollbars(20, 20, 50, 50);
  39
  40 rightWindow = new MyWindow(splitter);
  41 rightWindow->SetScrollbars(20, 20, 50, 50);
  42 rightWindow->Show(false);
  43
  44 splitter->Initialize(leftWindow);
  45
  46 // Set this to prevent unsplitting
  47 // splitter->SetMinimumPaneSize(20);
  48 @endcode
  49
  50 The next fragment shows how the splitter window can be manipulated after
  51 creation.
  52
  53 @code
  54 void MyFrame::OnSplitVertical(wxCommandEvent& event)
  55 {
  56     if ( splitter->IsSplit() )
  57         splitter->Unsplit();
  58     leftWindow->Show(true);
  59     rightWindow->Show(true);
  60     splitter->SplitVertically( leftWindow, rightWindow );
  61 }
  62
  63 void MyFrame::OnSplitHorizontal(wxCommandEvent& event)
  64 {
  65     if ( splitter->IsSplit() )
  66         splitter->Unsplit();
  67     leftWindow->Show(true);
  68     rightWindow->Show(true);
  69     splitter->SplitHorizontally( leftWindow, rightWindow );
  70 }
  71
  72 void MyFrame::OnUnsplit(wxCommandEvent& event)
  73 {
  74     if ( splitter->IsSplit() )
  75         splitter->Unsplit();
  76 }
  77 @endcode
  78
  79 */