 |
ScummVM API documentation
|
|
|
ScummVM API documentation
|
|
#include <master_win.h>
Public Member Functions | |
| virtual ErrorCode | Run () |
| ErrorCode | close () override |
| CBofString & | getWldScript () |
| virtual ErrorCode | showSystemDialog (bool saveFl=true) |
| bool | showRestartDialog (CBofWindow *win=nullptr, bool saveFl=true) |
| bool | showSaveDialog (CBofWindow *win, bool saveFl=true) |
| bool | showRestoreDialog (CBofWindow *win, bool saveFl=true) |
| bool | showQuitDialog (CBofWindow *win, bool saveFl=true) |
| ErrorCode | showCreditsDialog (CBofWindow *win, bool saveFl=true) |
| void | fillSaveBuffer (StBagelSave *saveBuf) |
| void | doRestore (StBagelSave *saveBuf) |
| ErrorCode | newGame () |
| ErrorCode | loadFile (const CBofString &wldName, const CBofString &startWldName, bool restartFl=false, bool setStartFl=true) |
| ErrorCode | loadFileFromStream (CBagIfstream &input, const CBofString &wldName) |
| ErrorCode | loadGlobalVars (const CBofString &wldName) |
| ErrorCode | setCurrfadeIn (int fade) |
| ErrorCode | setStorageDev (const CBofString &wldName, bool entry=true) |
| ErrorCode | gotoNewWindow (const CBofString *str) |
| uint16 | getDiskID () const |
| void | setDiskID (uint16 id) |
| CBofWindow * | getCurrentGameWindow () const |
| CBagStorageDevWnd * | getCurrentStorageDev () const |
| CBagStorageDevManager * | getStorageDevManager () const |
| CBagVarManager * | getVariableManager () const |
| virtual CBagStorageDev * | onNewStorageDev (const CBofString &typestr)=0 |
| virtual CBagStorageDev * | onNewStorageDev (int type)=0 |
| virtual void | onNewFilter (CBagStorageDev *, const CBofString &typeStr)=0 |
| virtual void | onNewFilter (CBagStorageDev *sdev, int type)=0 |
| virtual ErrorCode | onHelp (const CBofString &helpFile, bool saveBkgFl=true, CBofWindow *parent=nullptr) |
| void | onUserMessage (uint32 message, uint32 param) override |
| void | onKeyHit (uint32 keyCode, uint32 repCount) override |
| void | onClose () override |
| StObj * | getObjList () |
| void | setSaveObjs (bool saveFl) |
| bool | isObjSave () |
| void | saveSDevStack () |
| void | restoreActiveMessages (CBagStorageDevManager *sdevManager) |
 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 | onMainLoop () |
| virtual void | onSoundNotify (CBofObject *pObject, uint32 lParam2) |
| virtual void | onMovieNotify (uint32 lParam1, uint32 lParam2) |
| virtual void | onMCINotify (uint32 wParam, uint32 lParam) |
| virtual void | onTimer (uint32 nTimerId) |
| virtual void | handleEvent (const Common::Event &event) |
| Graphics::ManagedSurface * | getSurface () |
| bool | isCreated () const |
| virtual void | enable () |
| virtual void | disable () |
| 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::CBagParseObject | |
| virtual ErrorCode | attach () |
| virtual ErrorCode | detach () |
| virtual bool | isAttached () |
| virtual ParseCodes | setInfo (CBagIfstream &) |
| 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 | setActiveCursor (int cursorId) |
| static int | getActiveCursor () |
| static bool | getFlyThru () |
| static bool | getPanimations () |
| static void | setPanimations (bool panimsFl) |
| static int | getCorrection () |
| static void | setCorrection (int correction) |
| static int | getPanSpeed () |
| static void | setPanSpeed (int speed) |
| static int | getMidiVolume () |
| static void | setMidiVolume (int vol) |
| static int | getWaveVolume () |
| static void | setWaveVolume (int vol) |
| static bool | getMidi () |
| static bool | getDigitalAudio () |
| static void | muteToggle () |
| static void | forcePaintScreen () |
| 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::CBagParseObject | |
| static void | initialize () |
Static Public Attributes | |
| static int | _menuCount |
Protected Attributes | |
| CBagStorageDevWnd * | _gameWindow |
| CBofString | _wldScript |
| CBofString | _startWld |
| CBofString | _cdChangeAudio |
| CBofString | _sysScreen |
| uint16 | _diskId |
| int | _fadeIn |
| CBofList< CBagStorageDev * > * | _gameSDevList |
| CBagStorageDevManager * | _storageDeviceList |
| CBagVarManager * | _variableList |
| CBofSound * | _waitSound |
| 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 |
Static Protected Attributes | |
| static bool | _objSaveFl |
| static StObj * | _objList |
| static CBagCursor * | _cursorList [60] |
| static int | _curCursor |
| 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 |
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 } |
| Protected Member Functions inherited from Bagel::CBofWindow | |
| void | checkTimers () |
| virtual void | onMouseMove (uint32 nFlags, CBofPoint *pPoint, void *=nullptr) |
| virtual void | onLButtonDown (uint32 nFlags, CBofPoint *pPoint, void *=nullptr) |
| virtual void | onLButtonUp (uint32 nFlags, CBofPoint *pPoint, void *=nullptr) |
| 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 | onPaint (CBofRect *pRect) |
| virtual void | onActivate () |
| virtual void | onDeActivate () |
| Protected Member Functions inherited from Bagel::CBofError | |
| virtual void | bofMessageBox (const Common::String &content, const Common::String &title) |
This is the main window that is never destroyed throughout the game. It handles bringing new windows in and out of focus as well as containing the parsing file and info. It also captures keyboard entry and will save state information
1.8.13