MAK Data Logger API Documentation for HLA
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes | Private Member Functions
MAKLogger::DtLgrAnnotationComponent Class Reference

Creates View and Slots, and implements standard Logger GUI Component methods. More...

+ Inheritance diagram for MAKLogger::DtLgrAnnotationComponent:
+ Collaboration diagram for MAKLogger::DtLgrAnnotationComponent:

Public Member Functions

 DtLgrAnnotationComponent (DtLoggerApplication &application)
 
virtual ~DtLgrAnnotationComponent ()
 
virtual void showComponent ()
 This method will cause the component to be shown. More...
 
virtual void hideComponent ()
 This method will cause the component to be hidden. More...
 
virtual QWidgetinitialize (QWidget *parent)
 Creates View and Slots (after the GUI has been initialized). More...
 
virtual void activate ()
 This method is called when the component is shown. More...
 
virtual void deactivate ()
 This method is called when the component is hidden. More...
 
virtual bool canExit () const
 This method provides a way for components to control whether the application can quit. More...
 
virtual bool canCloseFile () const
 This method provides a way for components to control whether the application can close a file. More...
 
virtual double updateTime ()
 Returns the desired times between updates in seconds. More...
 
virtual void update ()
 Called repeatedly by the host application in the GUI thread. More...
 
const DtLgrAnnotationViewview () const
 Get view, if widget has not been called this will return null. More...
 
virtual DtLgrZoomableWidgetzoomComponent ()
 Access component as zoom component. More...
 
virtual DtLoggerApplicationapplication ()
 Get the logger application in use. More...
 
virtual const DtLoggerApplicationapplication () const
 
DtLgrAnnotationManagermanager ()
 Provide access to high level annotation related functionality. More...
 
virtual DtLgrGuiModelmodel ()
 Get the gui model, this pointer will be null, until initialize has been called. More...
 
virtual const DtLgrGuiModelmodel () const
 Get the gui model, this pointer will be null, until initialize has been called. More...
 
- Public Member Functions inherited from MAKLogger::DtLgrGuiComponent
virtual ~DtLgrGuiComponent ()
 Default Destructor. More...
 
virtual void startTimer (QObject *parent)
 Called to start the update timer. More...
 
virtual void stopTimer ()
 Called to stop the update timer. More...
 
virtual void release (QWidget *parent)
 The component is being removed. More...
 
virtual QWidgetcontainer ()
 Get the container widget. More...
 
virtual void setContainer (QWidget *widget)
 Sets the container. More...
 
virtual const QIcon & iconSet () const
 Get an optional icon set. By default returns null QIconSet. More...
 
virtual void setIconSet (const QIcon &iconSet)
 
virtual QString name () const
 Get the component name. More...
 
virtual QKeySequence shortcut () const
 Get the component's accelerator. More...
 
virtual void setKeySequence (const QKeySequence &sequence)
 Set the key sequence of the view component menu item. More...
 

Protected Attributes

DtLoggerApplicationmyApplication
 
DtLgrGuiModelmyModel
 
DtLgrAnnotationViewmyAnnotationView
 
DtLgrAnnotationManagermyManager
 
DtLgrAnnotationSlotsmySlots
 
bool myActivatedFlag
 
- Protected Attributes inherited from MAKLogger::DtLgrGuiComponent
QWidgetmyContainer
 
QTimer * myTimer
 
QString myName
 
QIcon myIconSet
 
QKeySequence mySequence
 

Private Member Functions

 DtLgrAnnotationComponent (const DtLgrAnnotationComponent &)
 Not Implemented. More...
 
DtLgrAnnotationComponentoperator= (const DtLgrAnnotationComponent &)
 Not Implemented. More...
 

Additional Inherited Members

- Public Slots inherited from MAKLogger::DtLgrGuiComponent
- Protected Member Functions inherited from MAKLogger::DtLgrGuiComponent
 DtLgrGuiComponent (QString name)
 

Detailed Description

Creates View and Slots, and implements standard Logger GUI Component methods.

Constructor & Destructor Documentation

MAKLogger::DtLgrAnnotationComponent::DtLgrAnnotationComponent ( DtLoggerApplication application)
virtual MAKLogger::DtLgrAnnotationComponent::~DtLgrAnnotationComponent ( )
virtual
MAKLogger::DtLgrAnnotationComponent::DtLgrAnnotationComponent ( const DtLgrAnnotationComponent )
private

Not Implemented.

Member Function Documentation

virtual void MAKLogger::DtLgrAnnotationComponent::activate ( )
virtual

This method is called when the component is shown.

Implements MAKLogger::DtLgrGuiComponent.

virtual DtLoggerApplication& MAKLogger::DtLgrAnnotationComponent::application ( )
virtual

Get the logger application in use.

virtual const DtLoggerApplication& MAKLogger::DtLgrAnnotationComponent::application ( ) const
virtual
virtual bool MAKLogger::DtLgrAnnotationComponent::canCloseFile ( ) const
virtual

This method provides a way for components to control whether the application can close a file.

The component which check to see if the annotation file is saved or not.

Return values
trueThe component allows the file to be closed.
falseThe component does not want the file closed.

Reimplemented from MAKLogger::DtLgrGuiComponent.

virtual bool MAKLogger::DtLgrAnnotationComponent::canExit ( ) const
virtual

This method provides a way for components to control whether the application can quit.

The component which check to see if the annotation file is saved or not.

Return values
trueThe component can quit.
falseThe component does not want to quit.

Reimplemented from MAKLogger::DtLgrGuiComponent.

virtual void MAKLogger::DtLgrAnnotationComponent::deactivate ( )
virtual

This method is called when the component is hidden.

Implements MAKLogger::DtLgrGuiComponent.

virtual void MAKLogger::DtLgrAnnotationComponent::hideComponent ( )
virtual

This method will cause the component to be hidden.

virtual QWidget* MAKLogger::DtLgrAnnotationComponent::initialize ( QWidget parent)
virtual

Creates View and Slots (after the GUI has been initialized).

Adds View to Manager. Adds View->menu to menubar. Connects EventHandler signals to View and Slots.

Implements MAKLogger::DtLgrGuiComponent.

DtLgrAnnotationManager* MAKLogger::DtLgrAnnotationComponent::manager ( )

Provide access to high level annotation related functionality.

virtual DtLgrGuiModel* MAKLogger::DtLgrAnnotationComponent::model ( )
virtual

Get the gui model, this pointer will be null, until initialize has been called.

virtual const DtLgrGuiModel* MAKLogger::DtLgrAnnotationComponent::model ( ) const
virtual

Get the gui model, this pointer will be null, until initialize has been called.

DtLgrAnnotationComponent& MAKLogger::DtLgrAnnotationComponent::operator= ( const DtLgrAnnotationComponent )
private

Not Implemented.

virtual void MAKLogger::DtLgrAnnotationComponent::showComponent ( )
virtual

This method will cause the component to be shown.

virtual void MAKLogger::DtLgrAnnotationComponent::update ( )
virtual

Called repeatedly by the host application in the GUI thread.

The time between calls is controlled by updateTime.

Implements MAKLogger::DtLgrGuiComponent.

virtual double MAKLogger::DtLgrAnnotationComponent::updateTime ( )
virtual

Returns the desired times between updates in seconds.

If updateTime returns 1.0 the component will be updated every second, if it is 0.5 the component will be updated every 30 seconds. Return -1 if update should not be called.

Implements MAKLogger::DtLgrGuiComponent.

const DtLgrAnnotationView* MAKLogger::DtLgrAnnotationComponent::view ( ) const

Get view, if widget has not been called this will return null.

virtual DtLgrZoomableWidget* MAKLogger::DtLgrAnnotationComponent::zoomComponent ( )
virtual

Access component as zoom component.

Return NULL if component is not a zoom component. This interface will be used to automatically connect and disconnect the zoom component slots.

Implements MAKLogger::DtLgrGuiComponent.

Member Data Documentation

bool MAKLogger::DtLgrAnnotationComponent::myActivatedFlag
protected
DtLgrAnnotationView* MAKLogger::DtLgrAnnotationComponent::myAnnotationView
protected
DtLoggerApplication& MAKLogger::DtLgrAnnotationComponent::myApplication
protected
DtLgrAnnotationManager* MAKLogger::DtLgrAnnotationComponent::myManager
protected
DtLgrGuiModel* MAKLogger::DtLgrAnnotationComponent::myModel
protected
DtLgrAnnotationSlots* MAKLogger::DtLgrAnnotationComponent::mySlots
protected

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

Document ID: Generated on Thu Dec 18 15:35:09 EST 2025 from SVN revision 282494
Copyright © 2024 MAK Technologies. All Rights Reserved (www.mak.com)