526954c596
Use "wxWindows licence" and not "wxWidgets licence" (the latter doesn't exist) and consistently spell "licence" using British spelling. See #12165. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64940 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
48 lines
1.4 KiB
C++
48 lines
1.4 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/persist/bookctrl.h
|
|
// Purpose: interface of wxPersistentBookCtrl
|
|
// Author: Vadim Zeitlin
|
|
// RCS-ID: $Id$
|
|
// Copyright: (c) 2009 Vadim Zeitlin <vadim@wxwidgets.org>
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
/**
|
|
Persistence adapter for wxBookCtrlBase.
|
|
|
|
This adapter handles the selected page of wxBookCtrlBase, i.e. it saves its
|
|
value when the associated book control is destroyed and restores it when it
|
|
is recreated.
|
|
|
|
@see wxPersistentTreeBookCtrl
|
|
*/
|
|
class wxPersistentBookCtrl : public wxPersistentWindow<wxBookCtrlBase>
|
|
{
|
|
public:
|
|
/**
|
|
Constructor.
|
|
|
|
@param book
|
|
The associated book control.
|
|
*/
|
|
wxPersistentBookCtrl(wxBookCtrlBase *book);
|
|
|
|
/**
|
|
Save the currently selected page index.
|
|
*/
|
|
virtual void Save() const;
|
|
|
|
/**
|
|
Restore the selected page index.
|
|
|
|
The book control must be initialized before calling this function, i.e.
|
|
all of its pages should be already added to it -- otherwise restoring
|
|
the selection has no effect.
|
|
*/
|
|
virtual bool Restore();
|
|
};
|
|
|
|
/// Overload allowing persistence adapter creation for wxBookCtrlBase-derived
|
|
/// objects.
|
|
wxPersistentObject *wxCreatePersistentObject(wxBookCtrlBase *book);
|