Class: Wx::PersistentBookCtrl

Inherits:

PersistentWindow

• Object
• Wx::PersistentBookCtrl

Defined in:

lib/wx/doc/gen/persistent_window.rb

Overview

Persistence adapter for BookCtrlBase.

This adapter handles the selected page of BookCtrlBase, i.e. it saves its value when the associated book control is destroyed and restores it when it is recreated.

See Also:

• PersistentTreeBookCtrl

Requires:

• USE_CONFIG

Direct Known Subclasses

PersistentTreeBookCtrl

Instance Method Summary

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

  Constructor.

• #restore ⇒ Boolean

  Restore the selected page index.

• #save ⇒ void

  Save the currently selected page index.

Constructor Details

#initialize(book) ⇒ Wx::PersistentBookCtrl

Constructor.

Parameters:

• book (Wx::BookCtrlBase) —

  The associated book control.

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

def initialize(book) end

Instance Method Details

#restore ⇒ Boolean

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.

Returns:

• (Boolean)

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

def restore; end

#save ⇒ void

This method returns an undefined value.

Save the currently selected page index.

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

def save; end