ScummVM API documentation
Public Types | Public Member Functions | List of all members
Bagel::CBagButtonObject Class Reference

#include <button_object.h>

Inheritance diagram for Bagel::CBagButtonObject:
Bagel::CBagSpriteObject Bagel::CBagObject Bagel::CBagParseObject Bagel::CBofObject Bagel::CBofError Bagel::SpaceBar::SBarVidBut

Public Types

enum  BUTTON_TYPE {
  BTN_PUSH = 0, BTN_CHECKBOX = 1, BTN_HLEVER = 2, BTN_VLEVER = 3,
  BTN_DIAL = 4, BTN_SLIDER = 5
}
 
- Public Types inherited from Bagel::CBagParseObject
enum  KEYWORDS {
  UNKNOWN = 0, STORAGEDEV, START_WLD, VARIABLE,
  REMARK, DISKID, CURSOR, SHAREDPAL,
  DISKAUDIO, PDASTATE, SYSSCREEN, WIELDCURSOR
}
 

Public Member Functions

ErrorCode attach () override
 
ErrorCode detach () override
 
BUTTON_TYPE getButtonType () const
 
ParseCodes setInfo (CBagIfstream &istr) override
 
bool runObject () override
 
void setCallBack (BagFuncPtr func, void *funcInfo)
 
BagFuncPtr getCallBack () override
 
void * getCallBackInfo () const
 
bool runCallBack () override
 
void onLButtonDown (uint32, CBofPoint *point, void *) override
 
void onLButtonUp (uint32 flags, CBofPoint *point, void *extraInfo) override
 
bool onMouseMove (uint32, CBofPoint point, void *extraInfo) override
 
ErrorCode update (CBofBitmap *bmp, CBofPoint pt, CBofRect *srcRect=nullptr, int maskColor=-1) override
 
void setSize (const CBofSize &size) override
 
void setProperty (const CBofString &prop, int val) override
 
int getProperty (const CBofString &prop) override
 
- Public Member Functions inherited from Bagel::CBagSpriteObject
ErrorCode attach () override
 
ErrorCode detach () override
 
bool isAttached () override
 
ParseCodes setInfo (CBagIfstream &istr) override
 
bool isInside (const CBofPoint &xPoint) override
 
int getWieldCursor () const
 
void setWieldCursor (int n)
 
CBofSprite * getSprite () const
 
CBofRect getRect () override
 
int getCels () const
 
bool isAnimated () const
 
void setAnimated (bool b=true)
 
void setCels (int nCels)
 
void setPosition (const CBofPoint &pos) override
 
ErrorCode update (CBofBitmap *pBmp, CBofPoint pt, CBofRect *pSrcRect=nullptr, int=-1) override
 
void setProperty (const CBofString &sProp, int nVal) override
 
int getProperty (const CBofString &sProp) override
 
int getFrameRate () const
 
void setFrameRate (int nFR)
 
- Public Member Functions inherited from Bagel::CBagObject
bool isInteractive ()
 
void setInteractive (bool b)
 
void setExpression (CBagExpression *pExpr)
 
CBagExpression * getExpression () const
 
BagObjectType getType ()
 
void setType (BagObjectType nType)
 
bool isMovable ()
 
void setMovable (bool b=true)
 
bool isStretchable ()
 
void setStretchable (bool b=true)
 
bool isModal ()
 
void setModal (bool b=true)
 
virtual bool isModalDone ()
 
bool isVisible ()
 
void setVisible (bool b=true)
 
bool isHighlight ()
 
void setHighlight (bool b=true)
 
bool isActive ()
 
void setActive (bool b=true)
 
bool isTransparent ()
 
virtual void setTransparent (bool b=true)
 
bool isHideOnClick ()
 
void setHideOnClick (bool b=true)
 
bool isImmediateRun ()
 
void setImmediateRun (bool b=true)
 
bool isLocal ()
 
void setLocal (bool b=true)
 
bool isNegative ()
 
void setNegative (bool b=true)
 
bool isConstantUpdate ()
 
void setConstantUpdate (bool b=true)
 
bool isTimeless ()
 
void setTimeless (bool b=true)
 
bool isFloating ()
 
void setFloating (bool b=true)
 
bool isPreload ()
 
void setPreload (bool b=true)
 
bool isForeGround ()
 
void setForeGround (bool b=true)
 
int getProperties ()
 
void setProperties (int nProperties)
 
virtual const CBofString * getInitInfo () const
 
virtual void setInitInfo (const CBofString &)
 
bool isDirty ()
 
void setDirty (bool b=true)
 
bool isMsgWaiting ()
 
void setMsgWaiting (bool b=true)
 
bool isAlwaysUpdate ()
 
void setAlwaysUpdate (bool b=true)
 
bool isNoMenu ()
 
void setNoMenu (bool b=true)
 
virtual CBofPoint getPosition ()
 
virtual int getRefId ()
 
virtual int getOverCursor ()
 
virtual int getState ()
 
virtual const CBofString & getFileName ()
 
CBagMenu * getMenuPtr ()
 
virtual const CBofString & getRefName ()
 
virtual void setRefName (const CBofString &s)
 
virtual void setFileName (const CBofString &s)
 
virtual void setRefId (int id)
 
virtual void setOverCursor (int curs)
 
virtual void setState (int state)
 
virtual void setMenuPtr (CBagMenu *pm)
 
virtual bool onObjInteraction (CBagObject *, CBagStorageDev *)
 
virtual bool onMouseOver (uint32, CBofPoint, void *=nullptr)
 
- Public Member Functions inherited from Bagel::CBagParseObject
int getStringFromStream (CBagIfstream &istr, CBofString &sStr, const CBofString &sEndChars, bool bPutBack=false)
 
int getAlphaNumFromStream (CBagIfstream &istr, CBofString &sStr)
 
int getOperStrFromStream (CBagIfstream &istr, CBofString &sStr)
 
int getIntFromStream (CBagIfstream &istr, int &nNum)
 
int getRectFromStream (CBagIfstream &istr, CBofRect &rect)
 
int getKeywordFromStream (CBagIfstream &istr, KEYWORDS &keyword)
 
int putbackStringOnStream (CBagIfstream &istr, const CBofString &sStr)
 
int parseAlertBox (CBagIfstream &istr, const char *sTitle, const char *sFile, int nLine)
 
- Public Member Functions inherited from Bagel::CBofError
void reportError (ErrorCode errCode, const char *format,...)
 
bool errorOccurred () const
 
ErrorCode getErrorCode () const
 
void clearError ()
 

Additional Inherited Members

- Static Public Member Functions inherited from Bagel::CBagParseObject
static void initialize ()
 
- Static Public Member Functions inherited from Bagel::CBofObject
static bool isValidObject (const CBofObject *pObject)
 
- Static Public Member Functions inherited from Bagel::CBofError
static void fatalError (ErrorCode errCode, const char *format,...)
 
static void initialize ()
 
static int getErrorCount ()
 
- Public Attributes inherited from Bagel::CBagSpriteObject
uint32 _nLastUpdate
 
- Protected Member Functions inherited from Bagel::CBagObject
bool isProperty (BAG_OBJECT_PROPERTIES xProp)
 
void setProperty (BAG_OBJECT_PROPERTIES xProp, bool bVal)
 
- Protected Member Functions inherited from Bagel::CBofError
virtual void bofMessageBox (const Common::String &content, const Common::String &title)
 
- Protected Attributes inherited from Bagel::CBagObject
uint16 _xObjType = AREA_OBJ
 
byte _bInteractive = 0
 
- Protected Attributes inherited from Bagel::CBofError
ErrorCode _errCode
 
- Static Protected Attributes inherited from Bagel::CBofError
static int _count
 

Detailed Description

CBagButtonObject is an object that can be place within the slide window.

Member Function Documentation

◆ setInfo()

ParseCodes Bagel::CBagButtonObject::setInfo ( CBagIfstream &  istr)
overridevirtual

Takes in info and then removes the relative information and returns the info without the relevant info.

Reimplemented from Bagel::CBagParseObject.

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