wxVector<T> is header-based, use @nolibrary

[wxWidgets.git] / docs / doxygen / overviews / splitterwindow.h

diff --git a/docs/doxygen/overviews/splitterwindow.h b/docs/doxygen/overviews/splitterwindow.h
index 0888ed9a59b5caa5c541c23c1b955efc15a162f3..014b6c0cee80b5d79a8ded343967c00e080b9dd4 100644 (file)
--- 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
+@page overview_splitterwindow wxSplitterWindow Overview
 
- Classes: #wxSplitterWindow
- The following screenshot shows the appearance of a splitter window with a horizontal split.
+Classes: wxSplitterWindow
 
- The style wxSP_3D has been used to show a 3D border and 3D sash.
- #Example
+@li @ref overview_splitterwindow_appearance
+@li @ref overview_splitterwindow_example
 
+<hr>
 
- @section wxsplitterwindowexample Example
 
- The following fragment shows how to create a splitter window, creating two
- subwindows and hiding one of them.
+@section overview_splitterwindow_appearance Appearance
 
+The following screenshot shows the appearance of a splitter window with a
+horizontal split.
 
- @code
- splitter = new wxSplitterWindow(this, -1, wxPoint(0, 0), wxSize(400, 400), wxSP_3D);
+The style wxSP_3D has been used to show a 3D border and 3D sash.
 
-   leftWindow = new MyWindow(splitter);
-   leftWindow-SetScrollbars(20, 20, 50, 50);
+@image html overview_splitter_3d.png
 
-   rightWindow = new MyWindow(splitter);
-   rightWindow-SetScrollbars(20, 20, 50, 50);
-   rightWindow-Show(@false);
 
-   splitter-Initialize(leftWindow);
+@section overview_splitterwindow_example Example
 
-   // Set this to prevent unsplitting
- //    splitter-SetMinimumPaneSize(20);
- @endcode
+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);
 
- The next fragment shows how the splitter window can be manipulated after creation.
+leftWindow = new MyWindow(splitter);
+leftWindow->SetScrollbars(20, 20, 50, 50);
 
+rightWindow = new MyWindow(splitter);
+rightWindow->SetScrollbars(20, 20, 50, 50);
+rightWindow->Show(false);
 
- @code
- void MyFrame::OnSplitVertical(wxCommandEvent& event)
-   {
-         if ( splitter-IsSplit() )
-             splitter-Unsplit();
-         leftWindow-Show(@true);
-         rightWindow-Show(@true);
-         splitter-SplitVertically( leftWindow, rightWindow );
-   }
+splitter->Initialize(leftWindow);
 
-   void MyFrame::OnSplitHorizontal(wxCommandEvent& event)
-   {
-         if ( splitter-IsSplit() )
-             splitter-Unsplit();
-         leftWindow-Show(@true);
-         rightWindow-Show(@true);
-         splitter-SplitHorizontally( leftWindow, rightWindow );
-   }
+// Set this to prevent unsplitting
+// splitter->SetMinimumPaneSize(20);
+@endcode
 
-   void MyFrame::OnUnsplit(wxCommandEvent& event)
-   {
-         if ( splitter-IsSplit() )
-             splitter-Unsplit();
-   }
- @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
+
+*/