allow handling events in a function taking the base class of the event class correspo...

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

/////////////////////////////////////////////////////////////////////////////
// Name:        splitterwindow.h
// Purpose:     topic overview
// Author:      wxWidgets team
// RCS-ID:      $Id$
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////

/**

@page overview_splitterwindow wxSplitterWindow Overview

Classes: wxSplitterWindow

@li @ref overview_splitterwindow_appearance
@li @ref overview_splitterwindow_example

<hr>


@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

*/