ScummVM API documentation
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
Bagel::CBagPanWindow Class Reference
Inheritance diagram for Bagel::CBagPanWindow:
Bagel::CBagStorageDevWnd Bagel::CBofWindow Bagel::CBagStorageDev Bagel::CLList Bagel::CBofObject Bagel::CBofError Bagel::CBagParseObject Bagel::SpaceBar::CMainWindow Bagel::SpaceBar::SBarVidWnd

Public Member Functions

ErrorCode attachActiveObjects () override
 
ErrorCode onRender (CBofBitmap *pBmp, CRect *pRect=nullptr) override
 
ErrorCode runModal (CBagObject *pObj) override
 
ErrorCode insertFGObjects (CBagObject *pBmp)
 
void deleteFGObjects ()
 
CBagObject * getFGObjects (const CBofString &sObjName)
 
CBofPalette * setSlideBitmap (const CBofString &xSlideBmp, const CRect &xSlideRect=CRect(0, 0, 0, 0))
 
CBofRect unSetSlideBitmap ()
 
uint32 rotateTo (CPoint &xPoint, int nRate=8)
 
void activateView ()
 
void deActivateView ()
 
void enable () override
 
void disable () override
 
ErrorCode paintObjects (CBofList< CBagObject *> *list, CBofBitmap *pBmp, CRect &viewOffsetRect, CBofList< CRect > *=nullptr, bool tempVar=true) override
 
const CBofPoint devPtToViewPort (const CBofPoint &xPoint) override
 
const CBofPoint viewPortToDevPt (const CBofPoint &xPoint) override
 
void setViewPortSize (const CSize &xViewSize)
 
const CRect getViewPort ()
 
const CSize getViewPortSize ()
 
CBagPanBitmap * getSlideBitmap () const
 
void setViewPortPos (const CPoint &pos)
 
const CPoint getViewPortPos ()
 
const CRect getMaxView ()
 
void setMovementRect (const CRect &rect)
 
const CRect & getMovementRect ()
 
void setPaintToBackdrop (const bool bPaint)
 
bool getStretchToScreen ()
 
bool setStretchToScreen (bool val=true)
 
int getCorrection ()
 
void setCorrection (int nCorr)
 
double getFOV ()
 
void setFOV (double fov)
 
CBofPalette * getPalette ()
 
uint32 benchmark ()
 
void onClose () override
 
void onMouseMove (uint32 nFlags, CBofPoint *p, void *=nullptr) override
 
void onLButtonDown (uint32 nFlags, CBofPoint *point, void *=nullptr) override
 
void onLButtonUp (uint32 nFlags, CBofPoint *point, void *=nullptr) override
 
void onKeyHit (uint32 lKey, uint32 lRepCount) override
 
virtual void onSize (uint32 nType, int cx, int cy)
 
void OnWindowPosChanging (WindowPos *lpwndpos)
 
ErrorCode onCursorUpdate (int nCurrObj) override
 
bool deactivatePDA ()
 
bool activatePDA ()
 
void waitForPDA ()
 
- Public Member Functions inherited from Bagel::CBagStorageDevWnd
ErrorCode attach () override
 
ErrorCode detach () override
 
ErrorCode close () override
 
void onTimer (uint32 nEventID) override
 
void setOnUpdate (bool bVal=true)
 
bool getOnUpdate () const
 
virtual ErrorCode paintScreen (CBofRect *pRect=nullptr)
 
virtual ErrorCode paintObjects (CBofList< CBagObject *> *list, CBofBitmap *pBmp, CBofRect &viewOffsetRect, CBofList< CBofRect > *=nullptr, bool tempVar=true)
 
virtual CBofRect getLocation ()
 
ErrorCode setBackground (CBofBitmap *pBmp) override
 
CBofBitmap * getBackground () override
 
virtual CBofBitmap * getWorkBmp ()
 
ErrorCode loadFile (const CBofString &sFile) override
 
virtual const CBofString & getHelpFilename ()
 
void setHelpFilename (const CBofString &s) override
 
virtual ErrorCode onRender (CBofBitmap *pBmp, CBofRect *pRect=nullptr)
 
void onPaint (CBofRect *) override
 
void onMainLoop () override
 
void onClose () override
 
void onMouseMove (uint32 nFlags, CBofPoint *, void *=nullptr) override
 
void onLButtonDown (uint32 nFlags, CBofPoint *point, void *=nullptr) override
 
void onLButtonUp (uint32 nFlags, CBofPoint *point, void *=nullptr) override
 
void onKeyHit (uint32 lKey, uint32 nRepCount) override
 
- Public Member Functions inherited from Bagel::CBofWindow
 CBofWindow ()
 
 CBofWindow (const char *pszName, int x, int y, int nWidth, int nHeight, CBofWindow *pParent)
 
virtual ~CBofWindow ()
 
virtual ErrorCode create (const char *pszName, int x, int y, int nWidth, int nHeight, CBofWindow *pParent, uint32 nControlID=0)
 
virtual ErrorCode create (const char *pszName, CBofRect *pRect, CBofWindow *pParent, uint32 nControlID=0)
 
virtual void destroy ()
 
virtual void destroyWindow ()
 
void show ()
 
void select ()
 
void hide ()
 
void center ()
 
void move (int x, int y, bool bRepaint=false)
 
void reSize (CBofRect *pRect, bool bRepaint=false)
 
void postMessage (uint32 nMessage, uint32 lParam1, uint32 lParam2)
 
void postUserMessage (uint32 lMessage, uint32 lExtraInfo)
 
void setTimer (uint32 nID, uint32 nInterval, BofCallback pCallBack=nullptr)
 
void killTimer (uint32 nID)
 
void killMyTimers ()
 
CBofWindow * getParent () const
 
void validateAnscestors (CBofRect *pRect=nullptr)
 
void setActive ()
 
CBofRect getWindowRect () const
 
CBofRect getClientRect ()
 
CBofRect getRect () const
 
int width () const
 
int height () const
 
void screenToClient (CBofPoint *pPoint)
 
void selectPalette (CBofPalette *pPal)
 
ErrorCode setBackdrop (CBofBitmap *pNewBitmap, bool bRefresh=false)
 
ErrorCode setBackdrop (const char *pszFileName, bool bRefresh=false)
 
void clearBackdrop ()
 
CBofBitmap * getBackdrop () const
 
bool hasBackdrop () const
 
void killBackdrop ()
 
ErrorCode paintBackdrop (CBofRect *pRect=nullptr, int nTransparentColor=-1)
 
void setControlID (uint32 nID)
 
uint32 getControlID () const
 
void setBkColor (RGBCOLOR cColor)
 
RGBCOLOR getBkColor () const
 
void setFgColor (RGBCOLOR cColor)
 
RGBCOLOR getFgColor () const
 
void setPrevMouseDown (CBofPoint p)
 
CBofPoint getPrevMouseDown () const
 
void setCapture ()
 
void releaseCapture ()
 
bool hasCapture () const
 
void setFocus ()
 
void releaseFocus ()
 
bool hasFocus () const
 
void flushAllMessages ()
 
void validateRect (const CBofRect *pRect)
 
void invalidateRect (const CBofRect *pRect)
 
virtual void onBofButton (CBofObject *pButton, int nExtraInfo)
 
virtual void onBofScrollBar (CBofObject *pButton, int nNewPos)
 
virtual void onBofListBox (CBofObject *pListBox, int nItemIndex)
 
virtual void onSoundNotify (CBofObject *pObject, uint32 lParam2)
 
virtual void onMovieNotify (uint32 lParam1, uint32 lParam2)
 
virtual void onMCINotify (uint32 wParam, uint32 lParam)
 
virtual void handleEvent (const Common::Event &event)
 
Graphics::ManagedSurface * getSurface ()
 
bool isCreated () const
 
bool isVisible () const
 
bool isEnabled () const
 
void updateWindow ()
 
void setParent (CBofWindow *parent)
 
void handleEvents ()
 
void fillWindow (byte iColor)
 
void fillRect (CBofRect *pRect, byte iColor)
 
ErrorCode paintBeveledText (CBofRect *rect, const CBofString &string, int size, int weight, RGBCOLOR color, int justify, uint32 format)
 
- Public Member Functions inherited from Bagel::CLList
 CLList ()
 
 CLList (void *pObj)
 
virtual ~CLList ()
 
void Insert (CLList *pNewList)
 
void Delete ()
 
void addToHead (CLList *pNewList)
 
void addToTail (CLList *pNewList)
 
void MoveToHead ()
 
void MoveToTail ()
 
void MoveLeft ()
 
void MoveRight ()
 
CLList * getHead ()
 
CLList * getTail ()
 
CLList * getPrev () const
 
CLList * getNext () const
 
void * getData () const
 
void PutData (void *pObj)
 
void FlushList ()
 
- 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 CBofRect getRect ()
 
virtual void setRect (const CBofRect &xRect)
 
virtual CBofPoint getPosition ()
 
virtual void setPosition (const CBofPoint &pos)
 
virtual ErrorCode addObject (CBagObject *pObj, int nPos=0)
 
virtual ErrorCode activateLocalObject (CBagObject *pObj)
 
virtual ErrorCode activateLocalObject (const CBofString &sName)
 
virtual ErrorCode removeObject (CBagObject *pRObj)
 
virtual ErrorCode deactivateLocalObject (CBagObject *pObj)
 
virtual ErrorCode deactivateLocalObject (const CBofString &sName)
 
virtual ErrorCode detachActiveObjects ()
 
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
 
virtual ErrorCode loadObjects ()
 
virtual ErrorCode releaseObjects ()
 
virtual ErrorCode noObjectsUnderMouse ()
 
virtual ErrorCode loadFileFromStream (CBagIfstream &fpInput, const CBofString &sWldName, bool bAttach=true)
 
virtual ErrorCode onMouseOver (uint32, CBofPoint *, void *=nullptr)
 
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 * onNewUserObject (const CBofString &sInit)
 
virtual CBagObject * onNewThingObject (const CBofString &sInit)
 
virtual CBofPoint arrangeFloater (CBofPoint &nPos, CBagObject *pObj)
 
int getNumFloatPages () const
 
void setNumFloatPages (int nFloatPages)
 
void onSetFilter (bool(*filterFunction)(uint16 nFilterId, CBofBitmap *, CBofRect *))
 
FilterFunction getFilter ()
 
bool isFiltered () const
 
- Public Member Functions inherited from Bagel::CBagParseObject
virtual bool isAttached ()
 
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)
 

Static Public Member Functions

static void initialize ()
 
static void setPanSpeed (int nSpeed)
 
static int getPanSpeed ()
 
static int getRealCorrection ()
 
static void setRealCorrection (int n)
 
static void flushInputEvents ()
 
- Static Public Member Functions inherited from Bagel::CBagStorageDevWnd
static void initialize ()
 
- Static Public Member Functions inherited from Bagel::CBofWindow
static ErrorCode initialize ()
 
static ErrorCode shutdown ()
 
static Common::Point getMousePos ()
 
static CBofWindow * getActiveWindow ()
 
static CBofWindow * getWindowList ()
 
- 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)
 
- Static Public Member Functions inherited from Bagel::CBagParseObject
static void initialize ()
 

Static Public Attributes

static CBagWield * _pWieldBmp
 
static CBagPDA * _pPDABmp
 
- Static Public Attributes inherited from Bagel::CBagStorageDevWnd
static CBagEventSDev * _pEvtSDev
 

Additional Inherited Members

- Public Types inherited from Bagel::CBagStorageDev
enum  MouseActivity { kMouseNONE = 0x0000, kMouseDRAGGING = 0x0001 }
 
- Public Types inherited from Bagel::CBagParseObject
enum  KEYWORDS {
  UNKNOWN = 0, STORAGEDEV, START_WLD, VARIABLE,
  REMARK, DISKID, CURSOR, SHAREDPAL,
  DISKAUDIO, PDASTATE, SYSSCREEN, WIELDCURSOR
}
 
- Protected Member Functions inherited from Bagel::CBagStorageDevWnd
virtual ErrorCode setWorkBmp ()
 
virtual ErrorCode killWorkBmp ()
 
- Protected Member Functions inherited from Bagel::CBofWindow
void checkTimers ()
 
virtual void onLButtonDblClk (uint32 nFlags, CBofPoint *pPoint)
 
virtual void onRButtonDown (uint32 nFlags, CBofPoint *pPoint)
 
virtual void onRButtonUp (uint32 nFlags, CBofPoint *pPoint)
 
virtual void onRButtonDblClk (uint32 nFlags, CBofPoint *pPoint)
 
virtual void onReSize (CBofSize *pSize)
 
virtual void onUserMessage (uint32 nMessage, uint32 lParam)
 
virtual void onActivate ()
 
virtual void onDeActivate ()
 
- Protected Member Functions inherited from Bagel::CBofError
virtual void bofMessageBox (const Common::String &content, const Common::String &title)
 
- Protected Attributes inherited from Bagel::CBofWindow
CBofWindow * _parent = nullptr
 
Array< CBofWindow * > _children
 
char _szTitle [64] = { 0 }
 
CBofRect _cWindowRect
 
CBofRect _cRect
 
CBofBitmap * _pBackdrop = nullptr
 
uint32 _nID = 0
 
RGBCOLOR _cBkColor = RGB(255, 255, 255)
 
RGBCOLOR _cFgColor = RGB(0, 0, 0)
 
bool _bCaptured = false
 
Graphics::ManagedSurface * _surface = nullptr
 
CBofPoint _cPrevMouseDown
 
- Protected Attributes inherited from Bagel::CLList
CLList * _pPrev
 
CLList * _pNext
 
void * _pData
 
- 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 inherited from Bagel::CBofWindow
static CBofWindow * _pWindowList
 
static CBofWindow * _pActiveWindow
 
static CBofTimerPacket * _pTimerList
 
static int _mouseX
 
static int _mouseY
 
- 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
 

Member Function Documentation

◆ runModal()

ErrorCode Bagel::CBagPanWindow::runModal ( CBagObject *  pObj)
overridevirtual

The modal object is painted to the screen until it is done with its modal loop. This is mainly used with characters. It is called when the loop value of a modal character is set, before execution of the next line of script.

Reimplemented from Bagel::CBagStorageDevWnd.

◆ unSetSlideBitmap()

CBofRect Bagel::CBagPanWindow::unSetSlideBitmap ( )

Clear the last pan bitmaps and return a rect of the current view

◆ deactivatePDA()

bool Bagel::CBagPanWindow::deactivatePDA ( )

Deactivate the PDA by calling the PDA->deactivate() directly. This is called from the PDA ON/OFF button

◆ activatePDA()

bool Bagel::CBagPanWindow::activatePDA ( )

Activate the PDA by calling the PDA->deactivate() directly. This is called on a mouse down anywhere on the deactivated PDA.

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