ScummVM API documentation
Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
Bagel::CBagLog Class Reference
Inheritance diagram for Bagel::CBagLog:
Bagel::CBagStorageDevBmp Bagel::CBagBmpObject Bagel::CBagStorageDev Bagel::CBagObject Bagel::CBagParseObject Bagel::CBagParseObject Bagel::CBofObject Bagel::CBofError

Public Member Functions

CBagObject * onNewUserObject (const CBofString &initStr) override
 
ErrorCode activateLocalObject (CBagObject *bagObj) override
 
ErrorCode releaseMsg ()
 
ErrorCode playMsgQueue ()
 
bool removeFromMsgQueue (CBagObject *bagObj)
 
CBofPoint arrangeFloater (CBofPoint &pos, CBagObject *bagObj) override
 
int getCurFltPage ()
 
void setCurFltPage (int fltPage)
 
- Public Member Functions inherited from Bagel::CBagStorageDevBmp
 CBagStorageDevBmp (CBofWindow *pParent=nullptr, const CBofRect &xRect=CBofRect(), bool bTrans=true)
 
CBofBitmap * getWorkBmp () const
 
ErrorCode setWorkBmp ()
 
ErrorCode killWorkBmp ()
 
CBofRect getRect () override
 
void setRect (const CBofRect &xRect) override
 
CBofPoint getPosition () override
 
void setPosition (const CBofPoint &pos) override
 
bool getTransparent () const
 
void setTransparent (bool bTrans=true) override
 
ErrorCode setBackground (CBofBitmap *pBmp) override
 
CBofBitmap * getBackground () override
 
ErrorCode loadFileFromStream (CBagIfstream &fpInput, const CBofString &sWldName, bool bAttach=true) override
 
bool isAttached () override
 
virtual bool paintFGObjects (CBofBitmap *)
 
ErrorCode attach () override
 
ErrorCode detach () override
 
ErrorCode update (CBofBitmap *pBmp, CBofPoint pt, CBofRect *pSrcRect=nullptr, int nMaskColor=-1) override
 
void onLButtonUp (uint32 nFlags, CBofPoint *xPoint, void *info) override
 
void onLButtonDown (uint32 nFlags, CPoint *xPoint, void *info=nullptr) override
 
const CBofPoint devPtToViewPort (const CBofPoint &xPoint) override
 
- Public Member Functions inherited from Bagel::CBagBmpObject
ErrorCode attach (CBofPalette *palette)
 
bool isInside (const CBofPoint &pt) override
 
CBofBitmap * getBitmap () const
 
- Public Member Functions inherited from Bagel::CBagObject
bool isInteractive ()
 
void setInteractive (bool b)
 
virtual bool runCallBack ()
 
virtual BagFuncPtr getCallBack ()
 
virtual bool runObject ()
 
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 ()
 
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 &)
 
virtual int getProperty (const CBofString &sProp)
 
virtual void setProperty (const CBofString &, int nVal)
 
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 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 setSize (const CBofSize &)
 
virtual void setRefId (int id)
 
virtual void setOverCursor (int curs)
 
virtual void setState (int state)
 
virtual void setMenuPtr (CBagMenu *pm)
 
ParseCodes setInfo (CBagIfstream &istr) override
 
virtual bool onObjInteraction (CBagObject *, CBagStorageDev *)
 
virtual void onLButtonDown (uint32, CBofPoint *, void *=nullptr)
 
virtual bool onMouseMove (uint32, CBofPoint, void *=nullptr)
 
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 ()
 
- Public Member Functions inherited from Bagel::CBagStorageDev
virtual ErrorCode preFilter (CBofBitmap *pBmp, CBofRect *pRect, CBofList< CBagObject *> *pList=nullptr)
 
void makeListDirty (CBofList< CBagObject *> *pList)
 
void setDiskID (uint16 nDiskID)
 
uint16 getDiskID () const
 
virtual ErrorCode setloadFilePos (const CBofPoint)
 
bool isCloseup () const
 
void setCloseup (bool b=true)
 
bool isCIC ()
 
void setCIC (bool b=true)
 
bool isCustom () const
 
void setCustom (bool b=true)
 
int getDeviceType () const
 
int getObjectCount ()
 
CBagObject * getObjectByPos (int nIndex)
 
CBagObject * getObject (int nRefId, bool bActiveOnly=false)
 
CBagObject * getObject (const CBofPoint &xPoint, bool bActiveOnly=false)
 
CBagObject * getObject (const CBofString &sName, bool bActiveOnly=false)
 
CBagObject * getObjectByType (const CBofString &sType, bool bActiveOnly=false)
 
CBofList< CBagObject * > * getObjectList () const
 
void setObjectList (CBofList< CBagObject *> *pOList, CBofList< CBagExpression *> *pEList=nullptr)
 
bool contains (CBagObject *pObj, bool bActive=true)
 
virtual ErrorCode addObject (CBagObject *pObj, int nPos=0)
 
virtual ErrorCode activateLocalObject (const CBofString &sName)
 
virtual ErrorCode attachActiveObjects ()
 
virtual ErrorCode removeObject (CBagObject *pRObj)
 
virtual ErrorCode deactivateLocalObject (CBagObject *pObj)
 
virtual ErrorCode deactivateLocalObject (const CBofString &sName)
 
virtual ErrorCode detachActiveObjects ()
 
virtual void setHelpFilename (const CBofString &)
 
const CBofString & getName () const
 
void setName (const CBofString &str)
 
void setFilterId (uint16 nId)
 
uint16 getFilterId () const
 
void setFadeId (uint16 nId)
 
uint16 getFadeId () const
 
const CBofString & getPrevSDev () const
 
const CBofPoint getPrevLoc () const
 
void setPrevSDev (const CBofString &str)
 
bool getCloseOnOpen () const
 
void setCloseOnOpen (bool bVal)
 
uint16 getExitOnEdge () const
 
void setExitOnEdge (uint16 nVal)
 
CBagObject * getLActiveObject () const
 
ErrorCode setLActiveObject (CBagObject *pObj)
 
virtual ErrorCode onLActiveObject (uint32, CBofPoint *, void *=nullptr)
 
MouseActivity getLActivity () const
 
void setLActivity (MouseActivity ma)
 
ErrorCode paintStorageDevice (CBofWindow *pWnd, CBofBitmap *pBmp=nullptr, CBofRect *=nullptr)
 
virtual void setAssociateWnd (CBofWindow *pWnd)
 
virtual CBofWindow * getAssociateWnd ()
 
ParseCodes setInfo (CBagIfstream &fpInput) override
 
const CBofString & getBackgroundName () const
 
ErrorCode attach () override
 
ErrorCode detach () override
 
virtual ErrorCode close ()
 
virtual ErrorCode loadObjects ()
 
virtual ErrorCode releaseObjects ()
 
virtual ErrorCode noObjectsUnderMouse ()
 
virtual const CBofPoint viewPortToDevPt (const CBofPoint &xPoint)
 
virtual ErrorCode loadFile (const CBofString &sWldName)
 
virtual void onMouseMove (uint32, CBofPoint *, void *=nullptr)
 
virtual ErrorCode onMouseOver (uint32, CBofPoint *, void *=nullptr)
 
virtual void onLButtonDown (uint32, CBofPoint *, void *=nullptr)
 
virtual ErrorCode onCursorUpdate (int)
 
virtual CBagObject * onNewSpriteObject (const CBofString &sInit)
 
virtual CBagObject * onNewBitmapObject (const CBofString &sInit)
 
virtual CBagObject * onNewTextObject (const CBofString &sInit)
 
virtual CBagObject * onNewLinkObject (const CBofString &sInit)
 
virtual CBagObject * onNewRPObject (const CBofString &sInit)
 
virtual CBagObject * onNewEDObject (const CBofString &sInit)
 
virtual CBagObject * onNewDosObject (const CBofString &sInit)
 
virtual CBagObject * onNewSoundObject (const CBofString &sInit)
 
virtual CBagObject * onNewButtonObject (const CBofString &sInit)
 
virtual CBagObject * onNewCharacterObject (const CBofString &sInit)
 
virtual CBagObject * onNewMovieObject (const CBofString &)
 
virtual CBagObject * onNewCommandObject (const CBofString &sInit)
 
virtual CBagObject * onNewAreaObject (const CBofString &sInit)
 
virtual CBagObject * onNewExpressionObject (const CBofString &sInit)
 
virtual CBagObject * onNewVariableObject (const CBofString &sInit)
 
virtual CBagObject * onNewThingObject (const CBofString &sInit)
 
int getNumFloatPages () const
 
void setNumFloatPages (int nFloatPages)
 
void onSetFilter (bool(*filterFunction)(uint16 nFilterId, CBofBitmap *, CBofRect *))
 
FilterFunction getFilter ()
 
bool isFiltered () const
 

Static Public Member Functions

static void initialize ()
 
static void arrangePages ()
 
static void initArrangePages ()
 
- 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 ()
 
- Static Public Member Functions inherited from Bagel::CBagStorageDev
static void initialize ()
 
static void shutdown ()
 
static CBofPoint & getLastCursorLocation ()
 
static void setDirtyAllObjects (bool b)
 
static bool getDirtyAllObjects ()
 
static void setPreFiltered (bool b=true)
 
static bool getPreFiltered ()
 
static bool preFilterPan ()
 
static void setPreFilterPan (bool b=true)
 

Protected Attributes

CBofList< CBagObject * > * _queuedMsgList
 
- Protected Attributes inherited from Bagel::CBagStorageDevBmp
int _nMaskColor
 
CBofPoint _xCursorLocation
 
CBofRect _cSrcRect
 
bool _bTrans
 
CBofBitmap * _pWorkBmp
 
- Protected Attributes inherited from Bagel::CBagObject
uint16 _xObjType = AREA_OBJ
 
byte _bInteractive = 0
 
- Protected Attributes inherited from Bagel::CBofError
ErrorCode _errCode
 
- Protected Attributes inherited from Bagel::CBagStorageDev
uint16 _xSDevType
 
FilterFunction _pBitmapFilter
 
bool _bForeignList: true
 
bool _bCloseOnOpen: true
 
bool _bCloseup: true
 
bool _bCIC: true
 
bool _bCustom: true
 
bool _bFirstPaint: true
 
int _nFloatPages
 

Static Protected Attributes

static CBagLog * _lastFloatPage
 
- Static Protected Attributes inherited from Bagel::CBofError
static int _count
 
- Static Protected Attributes inherited from Bagel::CBagStorageDev
static CBofPoint * _xCursorLocation
 
static CBofRect * gRepaintRect
 
static bool _bHandledUpEvent
 
static bool _hidePdaFl
 
static bool _bPanPreFiltered
 
static bool _bDirtyAllObjects
 
static bool _bPreFilter
 

Additional Inherited Members

- Public Types inherited from Bagel::CBagParseObject
enum  KEYWORDS {
  UNKNOWN = 0, STORAGEDEV, START_WLD, VARIABLE,
  REMARK, DISKID, CURSOR, SHAREDPAL,
  DISKAUDIO, PDASTATE, SYSSCREEN, WIELDCURSOR
}
 
- Public Types inherited from Bagel::CBagStorageDev
enum  MouseActivity { kMouseNONE = 0x0000, kMouseDRAGGING = 0x0001 }
 
- Protected Member Functions inherited from Bagel::CBagBmpObject
void setBitmap (CBofBitmap *bmp)
 
- 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)
 

Member Function Documentation

◆ activateLocalObject()

ErrorCode Bagel::CBagLog::activateLocalObject ( CBagObject *  bagObj)
overridevirtual

This is different for the log sdev Object are just queued for insertion and the message light starts blinking. The messages will be added to the sdev when the message light is clicked

Returns
Error result code

Reimplemented from Bagel::CBagStorageDev.

◆ releaseMsg()

ErrorCode Bagel::CBagLog::releaseMsg ( )

Releases and deletes all the objects in the list

◆ removeFromMsgQueue()

bool Bagel::CBagLog::removeFromMsgQueue ( CBagObject *  bagObj)

Remove a (duplicate) message from the message queue

◆ arrangeFloater()

CBofPoint Bagel::CBagLog::arrangeFloater ( CBofPoint &  pos,
CBagObject *  bagObj 
)
overridevirtual

This function arranges the objects that are considered floating (no coordinates given in script). It is virtual so that derived storage devices can do special things, like paging etc.

Returns
Returns the next available location in the sdev, at this level the objects will go out of range of the sdev.

Reimplemented from Bagel::CBagStorageDev.

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