Nemiver: nemiver::Layout Class Reference

Nemiver 0.3

The base class for Layouts. More...

#include <nmv-layout.h>

Inheritance diagram for nemiver::Layout:

Public Member Functions
virtual void	do_lay_out (IPerspective &a_perspective)=0
	initialize the layout More...

virtual void	do_cleanup_layout ()=0
	clean-up the layout More...

virtual const UString &	identifier () const =0
	gets the layout unique identifier More...

virtual const UString &	name () const =0
	gets the layout name More...

virtual const UString &	description () const =0
	gets the layout description More...

virtual Gtk::Widget *	widget () const =0
	gets the layout container widget More...

virtual void	do_init ()=0
	Initialize the layout. More...

virtual void	save_configuration ()=0
	save the configuration of the layout More...

virtual void	activate_view (int a_view_identifier)=0
	activate a view More...

virtual void	append_view (Gtk::Widget &a_widget, const UString &a_title, int a_index)=0
	appends a view to the layout More...

virtual void	remove_view (int a_index)=0
	remove a view from the layout More...

virtual	~Layout ()

Public Member Functions inherited from nemiver::common::Object
	Object ()

	Object (Object const &)

Object &	operator= (Object const &)

virtual	~Object ()

void	ref ()

void	unref ()

void	enable_refcount (bool a_enabled=true)

bool	is_refcount_enabled () const

long	get_refcount () const

void	attach_object (const UString &a_key, const Object *a_object)

bool	get_attached_object (const UString &a_key, const Object *&a_object)

Protected Member Functions
	Layout ()

Additional Inherited Members
Protected Attributes inherited from nemiver::common::Object
SafePtr< ObjectPriv >	m_priv

Detailed Description

The base class for Layouts.

Perspectives can use the LayoutManager to manage different Layouts. The LayoutManager handle object that inherit from the class Layout.

Constructor & Destructor Documentation

◆ Layout()

nemiver::Layout::Layout ( )

inlineprotected

◆ ~Layout()

virtual nemiver::Layout::~Layout ( )

inlinevirtual

Member Function Documentation

◆ activate_view()

virtual void nemiver::Layout::activate_view ( int a_view_identifier )

pure virtual

activate a view

Parameters

a_view_identifier The view to activate

Implemented in nemiver::DBGPerspectiveDefaultLayout, nemiver::DBGPerspectiveDynamicLayout, nemiver::DBGPerspectiveTwoPaneLayout, and nemiver::DBGPerspectiveWideLayout.

◆ append_view()

virtual void nemiver::Layout::append_view	(	Gtk::Widget &	a_widget,
		const UString &	a_title,
		int	a_index
	)

pure virtual

appends a view to the layout

The view is added to the end of the existing list of views contained in the layout.

Parameters

a_widget	Widget of the view to add to the layout
a_title	Title of the view (will appears in notebook label, ...)
a_index	Unique identifier of the view to add to the layout

Implemented in nemiver::DBGPerspectiveDefaultLayout, nemiver::DBGPerspectiveDynamicLayout, nemiver::DBGPerspectiveTwoPaneLayout, and nemiver::DBGPerspectiveWideLayout.

◆ description()

virtual const UString& nemiver::Layout::description ( ) const

pure virtual

gets the layout description

Returns: layout description

Implemented in nemiver::DBGPerspectiveDefaultLayout, nemiver::DBGPerspectiveDynamicLayout, nemiver::DBGPerspectiveTwoPaneLayout, and nemiver::DBGPerspectiveWideLayout.

◆ do_cleanup_layout()

virtual void nemiver::Layout::do_cleanup_layout ( )

pure virtual

clean-up the layout

Must be called before initializing a new layout for a perspective.

Implemented in nemiver::DBGPerspectiveDefaultLayout, nemiver::DBGPerspectiveDynamicLayout, nemiver::DBGPerspectiveTwoPaneLayout, and nemiver::DBGPerspectiveWideLayout.

◆ do_init()

virtual void nemiver::Layout::do_init ( )

pure virtual

Initialize the layout.

Implemented in nemiver::DBGPerspectiveDynamicLayout, nemiver::DBGPerspectiveTwoPaneLayout, nemiver::DBGPerspectiveWideLayout, and nemiver::DBGPerspectiveDefaultLayout.

◆ do_lay_out()

virtual void nemiver::Layout::do_lay_out ( IPerspective & a_perspective )

pure virtual

initialize the layout

Parameters

a_perspective The associated perspective.

Implemented in nemiver::DBGPerspectiveDefaultLayout, nemiver::DBGPerspectiveDynamicLayout, nemiver::DBGPerspectiveTwoPaneLayout, and nemiver::DBGPerspectiveWideLayout.

◆ identifier()

virtual const UString& nemiver::Layout::identifier ( ) const

pure virtual

gets the layout unique identifier

Returns: layout unique identifier

Implemented in nemiver::DBGPerspectiveDefaultLayout, nemiver::DBGPerspectiveDynamicLayout, nemiver::DBGPerspectiveTwoPaneLayout, and nemiver::DBGPerspectiveWideLayout.

◆ name()

virtual const UString& nemiver::Layout::name ( ) const

pure virtual

gets the layout name

Returns: layout name

Implemented in nemiver::DBGPerspectiveDefaultLayout, nemiver::DBGPerspectiveDynamicLayout, nemiver::DBGPerspectiveTwoPaneLayout, and nemiver::DBGPerspectiveWideLayout.

◆ remove_view()

virtual void nemiver::Layout::remove_view ( int a_index )

pure virtual

remove a view from the layout

Parameters

a_index Unique identifier of the view to remove from the layout

Implemented in nemiver::DBGPerspectiveDefaultLayout, nemiver::DBGPerspectiveDynamicLayout, nemiver::DBGPerspectiveTwoPaneLayout, and nemiver::DBGPerspectiveWideLayout.

◆ save_configuration()

virtual void nemiver::Layout::save_configuration ( )

pure virtual

save the configuration of the layout

Implemented in nemiver::DBGPerspectiveDefaultLayout, nemiver::DBGPerspectiveDynamicLayout, nemiver::DBGPerspectiveTwoPaneLayout, and nemiver::DBGPerspectiveWideLayout.

◆ widget()

virtual Gtk::Widget* nemiver::Layout::widget ( ) const

pure virtual

gets the layout container widget

Returns: layout container widget

Implemented in nemiver::DBGPerspectiveDefaultLayout, nemiver::DBGPerspectiveDynamicLayout, nemiver::DBGPerspectiveTwoPaneLayout, and nemiver::DBGPerspectiveWideLayout.

The documentation for this class was generated from the following file:

nmv-layout.h