Avogadro::ToolGroup Class Reference

Manager for GLWidget Tools. More...

#include <toolgroup.h>

Inheritance diagram for Avogadro::ToolGroup:

List of all members.

Public Slots
void	setActiveTool (int i)
void	setActiveTool (const QString &name)
void	setActiveTool (Tool *tool)
void	setMolecule (Molecule *molecule)
void	writeSettings (QSettings &settings) const
void	readSettings (QSettings &settings)
void	removeAllTools ()
Signals
void	toolActivated (Tool *tool)
void	toolsDestroyed ()
Public Member Functions
	ToolGroup (QObject *parent=0)
	~ToolGroup ()
void	append (QList< Tool * > tools)
void	append (Tool *tool)
Tool *	activeTool () const
Tool *	tool (int i) const
const QList< Tool * > &	tools () const
const QActionGroup *	activateActions () const

---

Detailed Description

Manager for GLWidget Tools.

Author:

Donald Ephraim Curtis

This class is a collection of Tools which allow manipulation of the GLWidget area.

---

Constructor & Destructor Documentation

Avogadro::ToolGroup::ToolGroup

(

QObject *

parent = 0

)

Constructor

Avogadro::ToolGroup::~ToolGroup

(

)

Deconstructor

---

Member Function Documentation

const QActionGroup * Avogadro::ToolGroup::activateActions

(

)

const

Returns:

constant QActionGroup of all the tool select actions.

Tool * Avogadro::ToolGroup::activeTool

(

)

const

Returns:

The active tool.

Referenced by Avogadro::GLWidget::setToolGroup().

void Avogadro::ToolGroup::append

(

QList< Tool * >

tools

)

Append the tools to the toolgroup.

References Avogadro::Tool::activateAction(), QObject::connect(), QObject::destroyed(), setActiveTool(), tool(), and toolsDestroyed().

void Avogadro::ToolGroup::append

(

Tool *

tool

)

Append the tool to the toolgroup.

References Avogadro::Tool::activateAction(), QObject::connect(), and setActiveTool().

void Avogadro::ToolGroup::readSettings

(

QSettings &

settings

)

[slot]

Read the settings of the GLWidget and restore them.

References QSettings::beginGroup(), QSettings::endGroup(), Avogadro::Plugin::identifier(), and Avogadro::Tool::readSettings().

void Avogadro::ToolGroup::removeAllTools

(

)

[slot]

Reset the toolgroup to it's original state.

void Avogadro::ToolGroup::setActiveTool

(

int

i

)

[slot]

Parameters:

i	index of the tool to set active

References QList::size(), and tools().

Referenced by append(), and setActiveTool().

void Avogadro::ToolGroup::setActiveTool

(

const QString &

name

)

[slot]

Parameters:

name	the name of the tool to set active (if it's found)

References Avogadro::Plugin::identifier(), QObject::name(), and setActiveTool().

void Avogadro::ToolGroup::setActiveTool

(

Tool *

tool

)

[slot]

Parameters:

tool	pointer to the tool to set active

References Avogadro::Tool::activateAction(), QAction::setChecked(), tool(), and toolActivated().

void Avogadro::ToolGroup::setMolecule

(

Molecule *

molecule

)

[slot]

Parameters:

molecule

pointer to the molecule tools in this group should use

References Avogadro::Tool::setMolecule().

Tool * Avogadro::ToolGroup::tool

(

int

i

)

const

Parameters:

i	index of the tool to return

Returns:

The tool at index i.

References QList::size(), and tools().

Referenced by append(), and setActiveTool().

void Avogadro::ToolGroup::toolActivated

(

Tool *

tool

)

[signal]

Parameters:

tool	the activated tool

Referenced by setActiveTool().

const QList< Tool * > & Avogadro::ToolGroup::tools

(

)

const

Returns:

Constant list of the tools.

Referenced by setActiveTool(), and tool().

void Avogadro::ToolGroup::toolsDestroyed

(

)

[signal]

This signal is emitted when one or more tools are destoyed. (Happens when plugins are reloaded)

Referenced by append().

void Avogadro::ToolGroup::writeSettings

(

QSettings &

settings

)

const [slot]

Write the settings of the GLWidget in order to save them to disk.

References QSettings::beginGroup(), QSettings::endGroup(), Avogadro::Plugin::identifier(), and Avogadro::Tool::writeSettings().

---

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

• /home/kitware/dashboards/avogadro/libavogadro/src/toolgroup.h
• /home/kitware/dashboards/avogadro/libavogadro/src/toolgroup.cpp