ScummVM
GUI::GuiObject Class Referenceabstract

#include <object.h>

Inheritance diagram for GUI::GuiObject:
Collaboration diagram for GUI::GuiObject:

Public Member Functions

 GuiObject (int x, int y, int w, int h)
 
 GuiObject (const Common::String &name)
 
 ~GuiObject ()
 
virtual void setTextDrawableArea (const Common::Rect &r)
 
virtual int16 getRelX () const
 
virtual int16 getRelY () const
 
virtual int16 getAbsX () const
 
virtual int16 getAbsY () const
 
virtual int16 getChildX () const
 
virtual int16 getChildY () const
 
virtual uint16 getWidth () const
 
virtual uint16 getHeight () const
 
virtual bool isVisible () const =0
 
virtual void reflowLayout ()
 
virtual void removeWidget (Widget *widget)
 
virtual bool isPointIn (int x, int y)
 
virtual Common::Rect getClipRect () const
 Returns the clipping rect to be used when drawing the children widgets of this object. More...
 

Protected Member Functions

virtual void releaseFocus ()=0
 
- Protected Member Functions inherited from GUI::CommandReceiver
virtual ~CommandReceiver ()
 
virtual void handleCommand (CommandSender *sender, uint32 cmd, uint32 data)
 

Protected Attributes

Common::Rect _textDrawableArea
 
int16 _x
 
int16 _y
 
uint16 _w
 
uint16 _h
 
const Common::String _name
 
Widget_firstWidget
 

Friends

class Widget
 

Detailed Description

Definition at line 61 of file object.h.

Constructor & Destructor Documentation

◆ GuiObject() [1/2]

GUI::GuiObject::GuiObject ( int  x,
int  y,
int  w,
int  h 
)
inline

Definition at line 73 of file object.h.

◆ GuiObject() [2/2]

GUI::GuiObject::GuiObject ( const Common::String name)

Definition at line 32 of file object.cpp.

◆ ~GuiObject()

GUI::GuiObject::~GuiObject ( )

Definition at line 37 of file object.cpp.

Member Function Documentation

◆ getAbsX()

virtual int16 GUI::GuiObject::getAbsX ( ) const
inlinevirtual

Reimplemented in GUI::Widget.

Definition at line 81 of file object.h.

◆ getAbsY()

virtual int16 GUI::GuiObject::getAbsY ( ) const
inlinevirtual

Reimplemented in GUI::Widget.

Definition at line 82 of file object.h.

◆ getChildX()

virtual int16 GUI::GuiObject::getChildX ( ) const
inlinevirtual

Reimplemented in GUI::ScrollContainerWidget.

Definition at line 83 of file object.h.

◆ getChildY()

virtual int16 GUI::GuiObject::getChildY ( ) const
inlinevirtual

Reimplemented in GUI::TabWidget, and GUI::ScrollContainerWidget.

Definition at line 84 of file object.h.

◆ getClipRect()

Common::Rect GUI::GuiObject::getClipRect ( ) const
virtual

Returns the clipping rect to be used when drawing the children widgets of this object.

Reimplemented in GUI::ScrollContainerWidget.

Definition at line 70 of file object.cpp.

◆ getHeight()

virtual uint16 GUI::GuiObject::getHeight ( void  ) const
inlinevirtual

Reimplemented in GUI::TabWidget, and GUI::ScrollContainerWidget.

Definition at line 86 of file object.h.

◆ getRelX()

virtual int16 GUI::GuiObject::getRelX ( ) const
inlinevirtual

Definition at line 79 of file object.h.

◆ getRelY()

virtual int16 GUI::GuiObject::getRelY ( ) const
inlinevirtual

Definition at line 80 of file object.h.

◆ getWidth()

virtual uint16 GUI::GuiObject::getWidth ( void  ) const
inlinevirtual

Reimplemented in GUI::ScrollContainerWidget.

Definition at line 85 of file object.h.

◆ isPointIn()

virtual bool GUI::GuiObject::isPointIn ( int  x,
int  y 
)
inlinevirtual

Definition at line 94 of file object.h.

◆ isVisible()

virtual bool GUI::GuiObject::isVisible ( ) const
pure virtual

◆ reflowLayout()

◆ releaseFocus()

virtual void GUI::GuiObject::releaseFocus ( )
protectedpure virtual

◆ removeWidget()

void GUI::GuiObject::removeWidget ( Widget widget)
virtual

Reimplemented in GUI::ContainerWidget, and GUI::Dialog.

Definition at line 50 of file object.cpp.

◆ setTextDrawableArea()

virtual void GUI::GuiObject::setTextDrawableArea ( const Common::Rect r)
inlinevirtual

Definition at line 77 of file object.h.

Friends And Related Function Documentation

◆ Widget

friend class Widget
friend

Definition at line 62 of file object.h.

Member Data Documentation

◆ _firstWidget

Widget* GUI::GuiObject::_firstWidget
protected

Definition at line 70 of file object.h.

◆ _h

uint16 GUI::GuiObject::_h
protected

Definition at line 67 of file object.h.

◆ _name

const Common::String GUI::GuiObject::_name
protected

Definition at line 68 of file object.h.

◆ _textDrawableArea

Common::Rect GUI::GuiObject::_textDrawableArea
protected

Definition at line 64 of file object.h.

◆ _w

uint16 GUI::GuiObject::_w
protected

Definition at line 67 of file object.h.

◆ _x

int16 GUI::GuiObject::_x
protected

Definition at line 66 of file object.h.

◆ _y

int16 GUI::GuiObject::_y
protected

Definition at line 66 of file object.h.


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