Data structure storing the contents of a grid cell. More...

#include <StructureGridView2D.hpp>

Inheritance diagram for CDPL::Vis::StructureGridView2D::Cell:

Public Types
typedef std::shared_ptr< Cell >	SharedPointer
	A reference-counted smart pointer [SHPTR] for dynamically allocated `Cell` instances. More...

Public Types inherited from CDPL::Base::ControlParameterContainer
typedef ParameterMap::value_type	ParameterEntry
	A Base::LookupKey / Base::Any pair used to store the control-parameter values and associated keys. More...

typedef ParameterMap::const_iterator	ConstParameterIterator
	A constant iterator used to iterate over the control-parameter entries. More...

typedef std::function< void(const LookupKey &, const Any &)>	ParameterChangedCallbackFunction
	A functor class that wraps callback target functions which get invoked when the value of a control-parameter has changed. More...

typedef std::function< void(const LookupKey &)>	ParameterRemovedCallbackFunction
	A functor class that wraps callback target functions which get invoked when a control-parameter entry has been removed. More...

typedef std::function< void()>	ParentChangedCallbackFunction
	A functor class that wraps callback target functions which get invoked when the parent container has been changed or was detached. More...

Public Member Functions
	Cell (const Cell &)=delete

void	setStructure (const Chem::MolecularGraph &molgraph)
	Specifies the molecular structure that shall be displayed in this cell. More...

const Chem::MolecularGraph &	getStructure () const
	Returns the stored data of the currently displayed molecular structure (if any). More...

void	clearStructure ()
	Hides the dcurrently displayed molecular structure (if any) and clears the stored data. More...

bool	hasStructure () const
	Tells whether this cell displays a molecular structure. More...

void	setText (const std::string &text, unsigned int pos=DEF_TEXT_POSITION, unsigned int line_almnt=Alignment::NONE)
	Specifies the text that shall be displayed at the given position. More...

const std::string &	getText (unsigned int pos=DEF_TEXT_POSITION) const
	Returns the text displayed at the specified position. More...

void	clearText (unsigned int pos=DEF_TEXT_POSITION)
	Clears the text displayed at the specified position. More...

bool	hasText (unsigned int pos=DEF_TEXT_POSITION) const
	Tells whether any text is displayed at the specified position. More...

void	clearAllText ()
	Clears all text blocks. More...

bool	hasAnyText () const
	Tells whether this cell displays any text. More...

Cell &	operator= (const Cell &cell)
	Performs a copy assignment of the specified `Cell` instance. More...

Public Member Functions inherited from CDPL::Base::ControlParameterContainer
std::size_t	getNumParameters () const
	Returns the number of container entries. More...

template<typename T >
void	setParameter (const LookupKey &key, T &&val)
	Sets the value of the control-parameter specified by key to val. More...

const Any &	getParameter (const LookupKey &key, bool throw_=false, bool local=false) const
	Returns the value of the control-parameter specified by key. More...

template<typename T >
const T &	getParameter (const LookupKey &key, bool local=false) const
	Returns the value of the control-parameter specified by key as a `const` reference to an object of type T. More...

template<typename T >
const T &	getParameterOrDefault (const LookupKey &key, const T &def_val, bool local=false) const
	Returns the value of the control-parameter specified by key as a `const` reference to an object of type T, or the default value def_val if a stored value does not exist. More...

bool	removeParameter (const LookupKey &key)
	Removes the entry for the control-parameter specified by key. More...

void	clearParameters ()
	Erases all container entries. More...

bool	isParameterSet (const LookupKey &key, bool local=false) const
	Tells whether or not a value has been assigned to the control-parameter specified by key. More...

void	addParameters (const ControlParameterContainer &cntnr)
	Adds the control-parameter value entries in the `ControlParameterContainer` instance cntnr. More...

void	copyParameters (const ControlParameterContainer &cntnr)
	Replaces the current set of properties by a copy of the entries in cntnr. More...

ConstParameterIterator	getParametersBegin () const
	Returns a constant iterator pointing to the beginning of the entries. More...

ConstParameterIterator	getParametersEnd () const
	Returns a constant iterator pointing to the end of the entries. More...

ConstParameterIterator	begin () const
	Returns a constant iterator pointing to the beginning of the entries. More...

ConstParameterIterator	end () const
	Returns a constant iterator pointing to the end of the entries. More...

void	setParent (const ControlParameterContainer *cntnr)
	Sets or removes the parent control-parameter container used to resolve requests for missing entries. More...

const ControlParameterContainer *	getParent () const
	Returns a pointer to the parent control-parameter container. More...

std::size_t	registerParameterChangedCallback (const ParameterChangedCallbackFunction &func)
	Registers a callback target function that gets invoked when the value of a control-parameter has changed. More...

void	unregisterParameterChangedCallback (std::size_t id)
	Unregisters the callback specified by id. More...

std::size_t	registerParameterRemovedCallback (const ParameterRemovedCallbackFunction &func)
	Registers a callback target function that gets invoked when a control-parameter entry has been removed. More...

void	unregisterParameterRemovedCallback (std::size_t id)
	Unregisters the callback specified by id. More...

std::size_t	registerParentChangedCallback (const ParentChangedCallbackFunction &func)
	Registers a callback target function that gets invoked when the parent container has been changed or was detached. More...

void	unregisterParentChangedCallback (std::size_t id)
	Unregisters the callback specified by id. More...

const ControlParameterContainer &	getParameters () const
	Returns a `const` reference to itself. More...

Static Public Attributes
static constexpr unsigned int	DEF_TEXT_POSITION = Alignment::BOTTOM \| Alignment::H_CENTER
	The default position of text blocks. More...

Friends
class	StructureGridView2D

Additional Inherited Members
Protected Member Functions inherited from CDPL::Base::ControlParameterContainer
	ControlParameterContainer ()
	Constructs an empty `ControlParameterContainer` instance. More...

	ControlParameterContainer (const ControlParameterContainer &cntnr)
	Constructs a copy of the `ControlParameterContainer` instance cntnr. More...

virtual	~ControlParameterContainer ()
	Destructor. More...

ControlParameterContainer &	operator= (const ControlParameterContainer &cntnr)
	Assignment operator. More...

Detailed Description

Data structure storing the contents of a grid cell.

Member Typedef Documentation

◆ SharedPointer

typedef std::shared_ptr<Cell> CDPL::Vis::StructureGridView2D::Cell::SharedPointer

A reference-counted smart pointer [SHPTR] for dynamically allocated Cell instances.

Constructor & Destructor Documentation

◆ Cell()

CDPL::Vis::StructureGridView2D::Cell::Cell ( const Cell & )

delete

Member Function Documentation

◆ setStructure()

void CDPL::Vis::StructureGridView2D::Cell::setStructure ( const Chem::MolecularGraph & molgraph )

Specifies the molecular structure that shall be displayed in this cell.

The cell will store a deep copy of the specified Chem::MolecularGraph instance which can then be safely modified or destroyed after the method call.

Parameters

molgraph A Chem::MolecularGraph instance specifying the molecular structure to display.

◆ getStructure()

const Chem::MolecularGraph& CDPL::Vis::StructureGridView2D::Cell::getStructure ( ) const

Returns the stored data of the currently displayed molecular structure (if any).

Parameters

A	reference to the stored Chem::MolecularGraph instance.

◆ clearStructure()

void CDPL::Vis::StructureGridView2D::Cell::clearStructure ( )

Hides the dcurrently displayed molecular structure (if any) and clears the stored data.

◆ hasStructure()

bool CDPL::Vis::StructureGridView2D::Cell::hasStructure ( ) const

Tells whether this cell displays a molecular structure.

Returns: true if a molecular structure is shown and false otherwise.

◆ setText()

void CDPL::Vis::StructureGridView2D::Cell::setText	(	const std::string &	text,
		unsigned int	pos = `DEF_TEXT_POSITION`,
		unsigned int	line_almnt = `Alignment::NONE`
	)

Specifies the text that shall be displayed at the given position.

The position pos of the text block is specified as a combination of horizontal and vertical alignment flags defined in namespace Vis::Alignment. If the text spans multiple lines, the horizontal alignment of the lines within the text block can be controlled by specifying horizontal algnment flags via the line_almnt argument. By default, lines of text blocks located on the left side of the cell will be left-aligned, horizontal center positioned text blocks have the lines center-aligned and text blocks on the right side have the lines right-aligned.

Parameters

text	The text to display.
pos	The position of the text block within this cell.
line_almnt	The horizontal alignment of the lines within the text block.

◆ getText()

const std::string& CDPL::Vis::StructureGridView2D::Cell::getText ( unsigned int pos = DEF_TEXT_POSITION ) const

Returns the text displayed at the specified position.

Parameters

pos	The position of the text block (see setText()).

Returns: A reference to the string storing the displayed text.

◆ clearText()

void CDPL::Vis::StructureGridView2D::Cell::clearText ( unsigned int pos = DEF_TEXT_POSITION )

Clears the text displayed at the specified position.

Parameters

pos	The position of the text block (see setText()).

◆ hasText()

bool CDPL::Vis::StructureGridView2D::Cell::hasText ( unsigned int pos = DEF_TEXT_POSITION ) const

Tells whether any text is displayed at the specified position.

Parameters

pos	The position of the text block (see setText()).

◆ clearAllText()

void CDPL::Vis::StructureGridView2D::Cell::clearAllText ( )

Clears all text blocks.

◆ hasAnyText()

bool CDPL::Vis::StructureGridView2D::Cell::hasAnyText ( ) const

Tells whether this cell displays any text.

Returns: true if any text is shown and false otherwise.

◆ operator=()

Cell& CDPL::Vis::StructureGridView2D::Cell::operator= ( const Cell & cell )

Performs a copy assignment of the specified Cell instance.

Parameters

cell	The `Cell` instance to copy.

Returns: A reference to itslef.

Friends And Related Function Documentation

◆ StructureGridView2D

friend class StructureGridView2D

friend

Member Data Documentation

◆ DEF_TEXT_POSITION

constexpr unsigned int CDPL::Vis::StructureGridView2D::Cell::DEF_TEXT_POSITION = Alignment::BOTTOM | Alignment::H_CENTER

staticconstexpr

The default position of text blocks.

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

StructureGridView2D.hpp

Public Types

Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ SharedPointer

Constructor & Destructor Documentation

◆ Cell()

Member Function Documentation

◆ setStructure()

◆ getStructure()

◆ clearStructure()

◆ hasStructure()

◆ setText()

◆ getText()

◆ clearText()

◆ hasText()

◆ clearAllText()

◆ hasAnyText()

◆ operator=()

Friends And Related Function Documentation

◆ StructureGridView2D

Member Data Documentation

◆ DEF_TEXT_POSITION