Itasca C++ Interface
Loading...
Searching...
No Matches
Public Member Functions | List of all members
itascaxd::ILabelList Class Referenceabstract

Interface to the list of all labels in the system. More...

#include <ilabellist.h>

Public Member Functions

virtual const IContainergetIContainer () const =0
 returns a constant pointer to the IContainer class representing a list of labels.
 
virtual IContainergetIContainer ()=0
 returns a pointer to the IContainer class representing a list of labels.
 
virtual const ILabellookupWithName (QString name) const =0
 Returns a const pointer to a ITable() with id given, or 0 if no match is found.
 
virtual ILabellookupWithName (QString name)=0
 Returns a pointer to a ITable() with id given, or 0 if no match is found.
 
virtual const ILabelgetFirst () const =0
 Returns a const pointer to the first ILabel in the list. Use ILabel::getNext() to iterate through the entire list.
 
virtual ILabelgetFirst ()=0
 Returns a pointer to the first ILabel in the list. Use ILabel::getNext() to iterate through the entire list.
 
virtual uint32 getNotice () const =0
 
virtual uint32 getLabelGeneralType () const =0
 Returns the general type of an ILabel.
 
virtual ILabelfindOrCreateWithName (QString name)=0
 
virtual ILabelcreate (const DVect &pos, QString name=QString())=0
 Creates the label and adds it to the label list. Sets the position of the label.
 
virtual TType getType () const =0
 Return the type of a label.
 

Detailed Description

Interface to the list of all labels in the system.

Member Function Documentation

◆ findOrCreateWithName()

virtual ILabel * itascaxd::ILabelList::findOrCreateWithName ( QString name)
pure virtual

Look for a label with a given id. Returns the interface pointer is the label exists in the list. If the label does not exists, creates the label and adds it to the list.

◆ getNotice()

virtual uint32 itascaxd::ILabelList::getNotice ( ) const
pure virtual

Returns the ID assigned by the NoticeManager for changes to the list of labels. Indicates when labels are added or removed from the list.


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