Class: Wx::AUI::AuiSerializer

Inherits:
AuiBookSerializer 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!

AuiSerializer is used by Wx::AUI::AuiManager#save_layout to store layout information.

This is an abstract base class, you need to inherit from it and override its pure virtual functions, including those inherited from its base AuiBookSerializer class, in your derived class. In particular, #save_pane must be overridden and will be called by AuiManager for each pane and dock present in the layout. Most of the other functions don’t need to be overridden, but it is often convenient to perform some actions before or after starting to save the objects of the given type or at the beginning or end of the whole saving process, so this class provides hooks for doing it. If any of the functions of the derived class throw an exception, it is propagated out of Wx::AUI::AuiManager#save_layout and it’s callers responsibility to handle it.

Category: Window Docking (wxAUI)

Requires:

  • USE_AUI

Instance Method Summary collapse

Methods inherited from AuiBookSerializer

#after_save_notebook, #before_save_notebook, #save_notebook_tab_control

Constructor Details

#initialize ⇒ Wx::AUI::AuiSerializer

Trivial default ctor.



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

def initialize; end

Instance Method Details

#after_save ⇒ void

This method returns an undefined value.

Called after saving everything.

Does nothing by default.



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

def after_save; end

#after_save_notebooks ⇒ void

This method returns an undefined value.

Called after the last call to SaveNotebook().

Does nothing by default. This function is called after all Wx::AUI::AuiBookSerializer member functions



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

def after_save_notebooks; end

#after_save_panes ⇒ void

This method returns an undefined value.

Called after the last call to #save_pane.

Does nothing by default.



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

def after_save_panes; end

#before_save ⇒ void

This method returns an undefined value.

Called before doing anything else.

Does nothing by default.



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

def before_save; end

#before_save_notebooks ⇒ void

This method returns an undefined value.

Called before starting to save information about the notebooks.

Does nothing by default. Note that this function is called after #after_save_panes but may not be called at all if there are no panes containing Wx::AUI::AuiNotebook. Wx::AUI::AuiBookSerializer member functions will be called after this function if it is called at all.



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

def before_save_notebooks; end

#before_save_panes ⇒ void

This method returns an undefined value.

Called before starting to save information about the panes.

Does nothing by default.



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

def before_save_panes; end

#save_pane(pane) ⇒ void

This method returns an undefined value.

Save information about the given pane.

This function will be called for all panes and must be implemented to save their data in a format from which it can be restored later using a matching Wx::AUI::AuiDeserializer implementation. Note that all sizes and positions in pane are using DIPs, i.e. resolution-independent pixels, when it is passed to this function, so it does not need to perform any scaling itself to ensure that the stored values are restored correctly if the resolution changes.

Parameters:



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

def save_pane(pane) end