X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/15b6757b26a0277472a4f6b071b52050abd922da..a25a17732c2d4d34d5d35a5318053dd8c6e29722:/docs/doxygen/overviews/splitterwindow.h diff --git a/docs/doxygen/overviews/splitterwindow.h b/docs/doxygen/overviews/splitterwindow.h index 9b403b902d..014b6c0cee 100644 --- a/docs/doxygen/overviews/splitterwindow.h +++ b/docs/doxygen/overviews/splitterwindow.h @@ -1,74 +1,83 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: splitterwindow +// Name: splitterwindow.h // Purpose: topic overview // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// -/*! - - @page splitterwindow_overview wxSplitterWindow overview - - Classes: #wxSplitterWindow - The following screenshot shows the appearance of a splitter window with a horizontal split. - - The style wxSP_3D has been used to show a 3D border and 3D sash. - #Example - - - @section wxsplitterwindowexample Example - - The following fragment shows how to create a splitter window, creating two - subwindows and hiding one of them. - - - @code - 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); - @endcode - - - The next fragment shows how the splitter window can be manipulated after creation. - - - @code - 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(); - } - @endcode - - */ - - +/** + +@page overview_splitterwindow wxSplitterWindow Overview + +Classes: wxSplitterWindow + +@li @ref overview_splitterwindow_appearance +@li @ref overview_splitterwindow_example + +
+ + +@section overview_splitterwindow_appearance Appearance + +The following screenshot shows the appearance of a splitter window with a +horizontal split. + +The style wxSP_3D has been used to show a 3D border and 3D sash. + +@image html overview_splitter_3d.png + + +@section overview_splitterwindow_example Example + +The following fragment shows how to create a splitter window, creating two +subwindows and hiding one of them. + +@code +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); +@endcode + +The next fragment shows how the splitter window can be manipulated after +creation. + +@code +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(); +} +@endcode + +*/ +