[wxWidgets.git] / interface / wx / persist / treebook.h

/////////////////////////////////////////////////////////////////////////////
// Name:        wx/persist/treebook.h
// Purpose:     interface of wxPersistentTreeBook
// Author:      Vadim Zeitlin
// Copyright:   (c) 2009 Vadim Zeitlin <vadim@wxwidgets.org>
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

/**
    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.
 */
class wxPersistentTreeBookCtrl : public wxPersistentBookCtrl
{
public:
    /**
        Constructor.

        @param book
            The associated tree book control.
     */
    wxPersistentTreeBookCtrl(wxTreebook *book);

    /**
        Save the currently opened branches.
     */
    virtual void Save() const;

    /**
        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.
     */
    virtual bool Restore();
};

/// Overload allowing persistence adapter creation for wxTreebook objects.
wxPersistentObject *wxCreatePersistentObject(wxTreebook *book);
Commit	Line	Data
0fa541e8 VZ	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: wx/persist/treebook.h
	3	// Purpose: interface of wxPersistentTreeBook
	4	// Author: Vadim Zeitlin
0fa541e8	5	// Copyright: (c) 2009 Vadim Zeitlin <vadim@wxwidgets.org>
526954c5	6	// Licence: wxWindows licence
0fa541e8 VZ	7	/////////////////////////////////////////////////////////////////////////////
	8
	9	/**
	10	Persistence adapter for wxTreebook.
	11
	12	This adapter saves and restores the expanded branches of the wxTreeCtrl
	13	used by wxTreebook, in addition to saving and restoring the selection as
	14	implemented by the base wxPersistentBookCtrl class.
	15	*/
ee094b63	16	class wxPersistentTreeBookCtrl : public wxPersistentBookCtrl
0fa541e8 VZ	17	{
	18	public:
	19	/**
	20	Constructor.
	21
	22	@param book
	23	The associated tree book control.
	24	*/
ee094b63	25	wxPersistentTreeBookCtrl(wxTreebook *book);
0fa541e8 VZ	26
	27	/**
	28	Save the currently opened branches.
	29	*/
	30	virtual void Save() const;
	31
	32	/**
	33	Restore the opened branches.
	34
	35	The book control must be initialized before calling this function, i.e.
	36	all of its pages should be already added to it.
	37	*/
	38	virtual bool Restore();
	39	};
	40
	41	/// Overload allowing persistence adapter creation for wxTreebook objects.
	42	wxPersistentObject wxCreatePersistentObject(wxTreebook book);