Class: Wx::AUI::AuiBookSerializer

Inherits:
Object
  • Object
show all
Defined in:
lib/wx/doc/gen/aui/aui_manager.rb

Overview

Note:

This class is untracked and should not be derived from nor instances extended!

AuiBookSerializer is used for serializing AuiNotebook layout.

This includes the tab controls layout and the order of pages in them. It can be used standalone with Wx::AUI::AuiNotebook#save_layout or as base class of AuiSerializer for saving and restoring the entire layout.

Category: Window Docking (wxAUI)

Requires:

  • USE_AUI

Direct Known Subclasses

AuiSerializer

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Wx::AUI::AuiBookSerializer

Trivial default ctor.



424
 
# File 'lib/wx/doc/gen/aui/aui_manager.rb', line 424

def initialize; end

Instance Method Details

#after_save_notebook ⇒ void

This method returns an undefined value.

Called after saving information about all the pages of the notebook in the AUI pane with the given name.

Does nothing by default.



447
 
# File 'lib/wx/doc/gen/aui/aui_manager.rb', line 447

def after_save_notebook; end

#before_save_notebook(name) ⇒ void

This method returns an undefined value.

Called before starting to save information about the tabs in the notebook in the AUI pane with the given name.

This function needs to be overridden to keep record of the notebook for which #save_notebook_tab_control will be called next. If this class is used as a base class of Wx::AUI::AuiSerializer, saving notebook layout may be unnecessary, e.g. because the program doesn’t use Wx::AUI::AuiNotebook at all, and the implementation can be trivial and just do nothing because it is not going to be called at all if there are no notebooks in the full layout. When using Wx::AUI::AuiNotebook#save_layout directly, this function is always called and is the first function of this class to be called.

Parameters:

  • name (String) 


433
 
# File 'lib/wx/doc/gen/aui/aui_manager.rb', line 433

def before_save_notebook(name) end

#save_notebook_tab_control(tab) ⇒ void

This method returns an undefined value.

Called to save information about a single tab control in the given notebook.

This function will be called for all tab controls in the notebook after #before_save_notebook. As with that function, it has to be implemented, but can simply do nothing if saving notebook layout is not necessary.

Parameters:



441
 
# File 'lib/wx/doc/gen/aui/aui_manager.rb', line 441

def save_notebook_tab_control(tab) end