ScummVM API documentation
Titanic::CPetGlyphs Class Reference
Inheritance diagram for Titanic::CPetGlyphs:
Titanic::List< CPetGlyph > Titanic::CSaveableObject Common::List< CPetGlyph *> Titanic::CPetInventoryGlyphs Titanic::CPetRemoteGlyphs Titanic::CPetRoomsGlyphs Titanic::CPetSaveGlyphs

Public Member Functions

void setNumVisible (int total)
 
void clear ()
 
virtual void setup (int numVisible, CPetSection *owner)
 
virtual void reset ()
 
virtual void enter ()
 
virtual void leave ()
 
void setFlags (int flags)
 
void draw (CScreenManager *screenManager)
 
void highlight (int index)
 
void highlight (const CPetGlyph *glyph)
 
CPetSectiongetOwner () const
 
CPetControlgetPetControl () const
 
bool MouseButtonDownMsg (const Point &pt)
 
bool MouseButtonUpMsg (const Point &pt)
 
bool MouseDoubleClickMsg (const Point &pt)
 
bool MouseDragStartMsg (CMouseDragStartMsg *msg)
 
bool MouseDragMoveMsg (CMouseDragMoveMsg *msg)
 
bool MouseDragEndMsg (CMouseDragEndMsg *msg)
 
bool KeyCharMsg (int key)
 
bool VirtualKeyCharMsg (CVirtualKeyCharMsg *msg)
 
bool enterHighlighted ()
 
void leaveHighlighted ()
 
void startDragging (CPetGlyph *glyph, CMouseDragStartMsg *msg)
 
void endDragging ()
 
void resetHighlight ()
 
bool highlighted14 ()
 
int indexOf (const CPetGlyph *glyph) const
 
void scrollToStart ()
 
void scrollLeft ()
 
void scrollRight ()
 
void incSelection ()
 
void decSelection ()
 
CGameObjectgetObjectAt (const Point &pt) const
 
bool isGlyphHighlighted (const CPetGlyph *glyph) const
 
int getHighlightIndex () const
 
Point getHighlightedGlyphPos () const
 
void removeInvalid ()
 
- Public Member Functions inherited from Titanic::List< CPetGlyph >
void save (SimpleFile *file, int indent) override
 
void load (SimpleFile *file) override
 
void destroyContents ()
 
CPetGlyphadd ()
 
bool contains (const CPetGlyph *item) const
 
- Public Member Functions inherited from Titanic::CSaveableObject
virtual ClassDefgetType () const
 
bool isInstanceOf (const ClassDef *classDef) const
 
virtual void saveHeader (SimpleFile *file, int indent)
 
virtual void saveFooter (SimpleFile *file, int indent)
 
- Public Member Functions inherited from Common::List< CPetGlyph *>
constexpr List ()
 
 List (const List< CPetGlyph * > &list)
 
iterator insert (iterator pos, const CPetGlyph * &element)
 
void insert (iterator pos, iterator2 first, iterator2 last)
 
iterator erase (iterator pos)
 
iterator erase (iterator first, iterator last)
 
iterator reverse_erase (iterator pos)
 
void remove (const CPetGlyph * &val)
 
void push_front (const CPetGlyph * &element)
 
void push_back (const CPetGlyph * &element)
 
void pop_front ()
 
void pop_back ()
 
CPetGlyph * & front ()
 
const CPetGlyph * & front () const
 
CPetGlyph * & back ()
 
const CPetGlyph * & back () const
 
List< CPetGlyph * > & operator= (const List< CPetGlyph * > &list)
 
size_type size () const
 
void clear ()
 
bool empty () const
 
iterator begin ()
 
const_iterator begin () const
 
iterator reverse_begin ()
 
const_iterator reverse_begin () const
 
iterator end ()
 
const_iterator end () const
 

Protected Member Functions

void changeHighlight (int index)
 
- Protected Member Functions inherited from Common::List< CPetGlyph *>
void insert (NodeBase *pos, const CPetGlyph * &element)
 
NodeBase erase (NodeBase *pos)
 

Protected Attributes

int _firstVisibleIndex
 
int _totalGlyphs
 
int _numVisibleGlyphs
 
int _highlightIndex
 
int _field1C
 
int _flags
 
CPetGlyph_dragGlyph
 
CPetSection_owner
 
CPetGfxElement _selection
 
CPetGfxElement _scrollLeft
 
CPetGfxElement _scrollRight
 
- Protected Attributes inherited from Common::List< CPetGlyph *>
NodeBase _anchor
 

Additional Inherited Members

- Public Types inherited from Common::List< CPetGlyph *>
typedef ListInternal::Iterator< CPetGlyph * > iterator
 
typedef ListInternal::ConstIterator< CPetGlyph * > const_iterator
 
typedef CPetGlyph * value_type
 
typedef uint size_type
 
- Static Public Member Functions inherited from Titanic::CSaveableObject
static void initClassList ()
 
static void freeClassList ()
 
static CSaveableObjectcreateInstance (const Common::String &name)
 
- Static Public Attributes inherited from Titanic::CSaveableObject
static ClassDef_type
 
- Protected Types inherited from Common::List< CPetGlyph *>
typedef ListInternal::NodeBase NodeBase
 
typedef ListInternal::Node< CPetGlyph * > Node
 

Member Function Documentation

◆ changeHighlight()

void Titanic::CPetGlyphs::changeHighlight ( int  index)
protected

Change the currently selected glyph

◆ setNumVisible()

void Titanic::CPetGlyphs::setNumVisible ( int  total)

Set the number of visible glyphs

◆ clear()

void Titanic::CPetGlyphs::clear ( )

Clears the glyph list

◆ setup()

virtual void Titanic::CPetGlyphs::setup ( int  numVisible,
CPetSection owner 
)
virtual

The visual dimensions for the control and it's components

◆ reset()

virtual void Titanic::CPetGlyphs::reset ( )
virtual

Set up the control

◆ enter()

virtual void Titanic::CPetGlyphs::enter ( )
virtual

Called when PET area is entered

◆ leave()

virtual void Titanic::CPetGlyphs::leave ( )
virtual

Called when PET area is left

◆ draw()

void Titanic::CPetGlyphs::draw ( CScreenManager screenManager)

Draw the control

◆ highlight() [1/2]

void Titanic::CPetGlyphs::highlight ( int  index)

Highlight a specific glyph by indexe

◆ highlight() [2/2]

void Titanic::CPetGlyphs::highlight ( const CPetGlyph glyph)

Highlight a specific glyph

◆ getOwner()

CPetSection* Titanic::CPetGlyphs::getOwner ( ) const
inline

Get the owning section for the glyphs

◆ getPetControl()

CPetControl* Titanic::CPetGlyphs::getPetControl ( ) const

Get the PET control

◆ MouseButtonDownMsg()

bool Titanic::CPetGlyphs::MouseButtonDownMsg ( const Point pt)

Mouse button down message

◆ MouseButtonUpMsg()

bool Titanic::CPetGlyphs::MouseButtonUpMsg ( const Point pt)

Mouse button up message

◆ MouseDoubleClickMsg()

bool Titanic::CPetGlyphs::MouseDoubleClickMsg ( const Point pt)
inline

Mouse double click message

◆ MouseDragStartMsg()

bool Titanic::CPetGlyphs::MouseDragStartMsg ( CMouseDragStartMsg msg)

Mouse drag start messagge

◆ MouseDragMoveMsg()

bool Titanic::CPetGlyphs::MouseDragMoveMsg ( CMouseDragMoveMsg msg)

Mouse drag move message

◆ MouseDragEndMsg()

bool Titanic::CPetGlyphs::MouseDragEndMsg ( CMouseDragEndMsg msg)

Mouse drag end message

◆ KeyCharMsg()

bool Titanic::CPetGlyphs::KeyCharMsg ( int  key)

Key character message

◆ VirtualKeyCharMsg()

bool Titanic::CPetGlyphs::VirtualKeyCharMsg ( CVirtualKeyCharMsg msg)

Virtual key message

◆ enterHighlighted()

bool Titanic::CPetGlyphs::enterHighlighted ( )

When the PET section is entered, passes onto the highlighted glyph, if any

◆ leaveHighlighted()

void Titanic::CPetGlyphs::leaveHighlighted ( )

When the PET section is left, passes onto the highlighted glyph, if any

◆ startDragging()

void Titanic::CPetGlyphs::startDragging ( CPetGlyph glyph,
CMouseDragStartMsg msg 
)

Called when a dragging operation starts

◆ endDragging()

void Titanic::CPetGlyphs::endDragging ( )

Called when a dragging operation ends

◆ resetHighlight()

void Titanic::CPetGlyphs::resetHighlight ( )
inline

Reset the highlight

◆ indexOf()

int Titanic::CPetGlyphs::indexOf ( const CPetGlyph glyph) const

Returns the index of the specified glyph in the lsit

◆ scrollToStart()

void Titanic::CPetGlyphs::scrollToStart ( )
inline

Resets the scrolling of the glyphs list back to the start

◆ scrollLeft()

void Titanic::CPetGlyphs::scrollLeft ( )

Scrolls the glyphs to the left

◆ scrollRight()

void Titanic::CPetGlyphs::scrollRight ( )

Scrolls the glyphs to the right

◆ incSelection()

void Titanic::CPetGlyphs::incSelection ( )

Increment the currently selected index

◆ decSelection()

void Titanic::CPetGlyphs::decSelection ( )

Decrement the currently selected index

◆ getObjectAt()

CGameObject* Titanic::CPetGlyphs::getObjectAt ( const Point pt) const

Returns the object associated the glyph under the specified position

◆ isGlyphHighlighted()

bool Titanic::CPetGlyphs::isGlyphHighlighted ( const CPetGlyph glyph) const

Returns true if the specified glyph is the currently highlighted one

◆ getHighlightIndex()

int Titanic::CPetGlyphs::getHighlightIndex ( ) const
inline

Returns the highlighted index, if any

◆ getHighlightedGlyphPos()

Point Titanic::CPetGlyphs::getHighlightedGlyphPos ( ) const

Get the top-left position of the currently highlighted glyph

◆ removeInvalid()

void Titanic::CPetGlyphs::removeInvalid ( )

Removes any glyphs from the list that no longer have any images associated with them


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