libetonyek::IWORKOutputManager Class Reference

A manager for output elements. More...

#include <IWORKOutputManager.h>

Public Member Functions

 IWORKOutputManager ()
 
 ~IWORKOutputManager ()
 
void push ()
 Push a new output element onto the stack.
 
void pop ()
 Pop a output element from the stack.
 
IWORKOutputID_t save ()
 Save the current output element.
 
IWORKOutputElementsget (IWORKOutputID_t id)
 Get output element with ID id.
 
const IWORKOutputElementsget (IWORKOutputID_t id) const
 Get output element with ID id.
 
IWORKOutputElementsgetCurrent ()
 Get the current output element.
 
const IWORKOutputElementsgetCurrent () const
 Get the current output element.
 

Private Types

typedef std::deque< IWORKOutputElementsOutputList_t
 
typedef std::stack< IWORKOutputElementsOutputStack_t
 

Private Member Functions

 IWORKOutputManager (const IWORKOutputManager &)
 
IWORKOutputManageroperator= (const IWORKOutputManager &)
 

Private Attributes

OutputStack_t m_active
 
OutputList_t m_saved
 

Detailed Description

A manager for output elements.

It keeps a stack of currently opened output elements and a list of saved output elements.

There is always at least one output element on the stack.

Member Typedef Documentation

◆ OutputList_t

◆ OutputStack_t

Constructor & Destructor Documentation

◆ IWORKOutputManager() [1/2]

libetonyek::IWORKOutputManager::IWORKOutputManager ( const IWORKOutputManager & )
private

◆ IWORKOutputManager() [2/2]

libetonyek::IWORKOutputManager::IWORKOutputManager ( )

◆ ~IWORKOutputManager()

libetonyek::IWORKOutputManager::~IWORKOutputManager ( )

Member Function Documentation

◆ get() [1/2]

IWORKOutputElements & libetonyek::IWORKOutputManager::get ( IWORKOutputID_t id)

Get output element with ID id.

  • [in] id ID of the output element to get.

Referenced by get(), and libetonyek::PAGCollector::writePageGroupsObjects().

◆ get() [2/2]

const IWORKOutputElements & libetonyek::IWORKOutputManager::get ( IWORKOutputID_t id) const

Get output element with ID id.

  • [in] id ID of the output element to get.

◆ getCurrent() [1/2]

◆ getCurrent() [2/2]

const IWORKOutputElements & libetonyek::IWORKOutputManager::getCurrent ( ) const

Get the current output element.

◆ operator=()

IWORKOutputManager & libetonyek::IWORKOutputManager::operator= ( const IWORKOutputManager & )
private

◆ pop()

void libetonyek::IWORKOutputManager::pop ( )

◆ push()

void libetonyek::IWORKOutputManager::push ( )

◆ save()

IWORKOutputID_t libetonyek::IWORKOutputManager::save ( )

Save the current output element.

It remains on the stack.

Returns
The ID of the saved output element.

Referenced by libetonyek::PAGCollector::closePageGroup(), and libetonyek::KEYCollector::collectLayer().

Member Data Documentation

◆ m_active

OutputStack_t libetonyek::IWORKOutputManager::m_active
private

◆ m_saved

OutputList_t libetonyek::IWORKOutputManager::m_saved
private

Referenced by get(), and save().


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

Generated for libetonyek by doxygen 1.12.0