Class: Wx::PersistentTreeBookCtrl

Inherits:

PersistentBookCtrl

• Object
• PersistentBookCtrl
• Wx::PersistentTreeBookCtrl

Defined in:

lib/wx/doc/gen/persistent_window.rb

Overview

Persistence adapter for Treebook.

This adapter saves and restores the expanded branches of the TreeCtrl used by Treebook, in addition to saving and restoring the selection as implemented by the base PersistentBookCtrl class.

Requires:

• USE_CONFIG

Instance Method Summary

• #initialize(book) ⇒ Wx::PersistentTreeBookCtrl constructor

  Constructor.

• #restore ⇒ Boolean

  Restore the opened branches.

• #save ⇒ void

  Save the currently opened branches.

Constructor Details

#initialize(book) ⇒ Wx::PersistentTreeBookCtrl

Constructor.

Parameters:

• book (Wx::Treebook) —

  The associated tree book control.

# File 'lib/wx/doc/gen/persistent_window.rb', line 101

def initialize(book) end

Instance Method Details

#restore ⇒ Boolean

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.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/persistent_window.rb', line 111

def restore; end

#save ⇒ void

This method returns an undefined value.

Save the currently opened branches.

# File 'lib/wx/doc/gen/persistent_window.rb', line 105

def save; end