eq::server::Layout Class Reference

The layout. More...

#include <layout.h>

Inheritance diagram for eq::server::Layout:

[legend]

Collaboration diagram for eq::server::Layout:

[legend]

List of all members.

Public Member Functions
	Layout ()
	Constructs a new Layout.
	Layout (const Layout &from, Config *config)
	Creates a new, deep copy of a layout.
virtual	~Layout ()
	Destruct this layout.
Data Access
void	addView (View *view)
	Add a new view to this layout.
bool	removeView (View *view)
	remove the view from this layout.
const ViewVector &	getViews () const
	Get the list of views.
View *	findView (const std::string &name)
	Find the first view of a given name.
Config *	getConfig ()
const Config *	getConfig () const
View *	getView (const ViewPath &path)
LayoutPath	getPath () const
Operations
VisitorResult	accept (LayoutVisitor &visitor)
	Traverse this layout and all children using a layout visitor.
VisitorResult	accept (ConstLayoutVisitor &visitor) const
void	unmap ()
	Unmap this layout and all its children.
Protected Member Functions
virtual void	serialize (net::DataOStream &os, const uint64_t dirtyBits)
Friends
class	Config

---

Detailed Description

The layout.

See also:

eq::Layout

Definition at line 39 of file server/layout.h.

---

Constructor & Destructor Documentation

eq::server::Layout::Layout	(	const Layout &	from,
		Config *	config
	)

Creates a new, deep copy of a layout.

Definition at line 40 of file server/layout.cpp.

References _views, eq::server::Config::addLayout(), and addView().

Here is the call graph for this function:

eq::server::Layout::~Layout

(

)

[virtual]

Destruct this layout.

Definition at line 54 of file server/layout.cpp.

References eq::server::View::_layout.

---

Member Function Documentation

void eq::server::Layout::addView

(

View *

view

)

Add a new view to this layout.

Definition at line 171 of file server/layout.cpp.

References eq::server::View::_layout.

Referenced by Layout().

Here is the caller graph for this function:

bool eq::server::Layout::removeView

(

View *

view

)

remove the view from this layout.

Definition at line 178 of file server/layout.cpp.

References eq::server::View::_layout.

const ViewVector& eq::server::Layout::getViews

(

)

const [inline]

Get the list of views.

Definition at line 64 of file server/layout.h.

Referenced by eq::server::Config::addCanvas(), and eq::server::View::getPath().

Here is the caller graph for this function:

View * eq::server::Layout::findView

(

const std::string &

name

)

Find the first view of a given name.

Parameters:

name

the name of the view to find

Returns:

the first view with the name, or 0 if no view with the name exists.

Definition at line 189 of file server/layout.cpp.

References accept().

Here is the call graph for this function:

View * eq::server::Layout::getView

(

const ViewPath &

path

)

Returns:

the view of the given path.

Definition at line 93 of file server/layout.cpp.

LayoutPath eq::server::Layout::getPath

(

)

const

Returns:

the index path to this layout.

Definition at line 104 of file server/layout.cpp.

References eq::server::Config::getLayouts().

Referenced by eq::server::Canvas::Canvas(), and eq::server::View::getPath().

Here is the call graph for this function:

Here is the caller graph for this function:

VisitorResult eq::server::Layout::accept

(

LayoutVisitor &

visitor

)

Traverse this layout and all children using a layout visitor.

Parameters:

visitor

the visitor.

Returns:

the result of the visitor traversal.

Definition at line 162 of file server/layout.cpp.

Referenced by findView().

Here is the caller graph for this function:

void eq::server::Layout::unmap

(

)

Unmap this layout and all its children.

Definition at line 196 of file server/layout.cpp.

References eq::net::Object::getID(), eq::net::Object::getSession(), and eq::net::Session::unmapObject().

Here is the call graph for this function:

void eq::server::Layout::serialize	(	net::DataOStream &	os,
		const uint64_t	dirtyBits
	)			[protected, virtual]

See also:

Object::serialize

Reimplemented from eq::Object.

Definition at line 76 of file server/layout.cpp.

References eq::net::Object::getID().

Here is the call graph for this function:

---

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

• server/layout.h
• server/layout.cpp