Version: 3.2.5
wxPersistentTreeBookCtrl Class Reference

#include <wx/persist/treebook.h>

+ Inheritance diagram for wxPersistentTreeBookCtrl:

Detailed Description

Persistence adapter for wxTreebook.

This adapter saves and restores the expanded branches of the wxTreeCtrl used by wxTreebook, in addition to saving and restoring the selection as implemented by the base wxPersistentBookCtrl class.

Public Member Functions

 wxPersistentTreeBookCtrl (wxTreebook *book)
 Constructor. More...
virtual void Save () const
 Save the currently opened branches. More...
virtual bool Restore ()
 Restore the opened branches. More...
- Public Member Functions inherited from wxPersistentBookCtrl
 wxPersistentBookCtrl (wxBookCtrlBase *book)
 Constructor. More...
- Public Member Functions inherited from wxPersistentWindow< wxBookCtrlBase >
 wxPersistentWindow (WindowType *win)
 Constructor for a persistent window object. More...
WindowTypeGet () const
virtual wxString GetName () const
 Implements the base class pure virtual method using wxWindow::GetName(). More...
- Public Member Functions inherited from wxPersistentObject
 wxPersistentObject (void *obj)
 Constructor takes the object which we're associated with. More...
virtual ~wxPersistentObject ()
 Trivial but virtual destructor. More...
void * GetObject () const
 Return the associated object. More...
virtual wxString GetKind () const =0
 Returns the string uniquely identifying the objects supported by this adapter. More...

Additional Inherited Members

- Public Types inherited from wxPersistentWindow< wxBookCtrlBase >
typedef wxBookCtrlBase WindowType
 The type of the associated window. More...
- Protected Member Functions inherited from wxPersistentObject
template<typename T >
bool SaveValue (const wxString &name, T value) const
 Save the specified value using the given name. More...
template<typename T >
bool RestoreValue (const wxString &name, T *value)
 Restore a value saved by SaveValue(). More...

Constructor & Destructor Documentation

◆ wxPersistentTreeBookCtrl()

wxPersistentTreeBookCtrl::wxPersistentTreeBookCtrl ( wxTreebook book)


bookThe associated tree book control.

Member Function Documentation

◆ Restore()

virtual bool wxPersistentTreeBookCtrl::Restore ( )

Restore the opened branches.

The book control must be initialized before calling this function, i.e. all of its pages should be already added to it.

Reimplemented from wxPersistentBookCtrl.

◆ Save()

virtual void wxPersistentTreeBookCtrl::Save ( ) const

Save the currently opened branches.

Reimplemented from wxPersistentBookCtrl.