Blender V2.61 - r43446
|
#include <GHOST_IWindow.h>
Interface for GHOST windows.
You can create a window with the system's GHOST_ISystem::createWindow method.
There are two coordinate systems:
Definition at line 59 of file GHOST_IWindow.h.
virtual GHOST_IWindow::~GHOST_IWindow | ( | ) | [inline, virtual] |
Destructor.
Definition at line 65 of file GHOST_IWindow.h.
virtual GHOST_TSuccess GHOST_IWindow::activateDrawingContext | ( | ) | [pure virtual] |
Activates the drawing context of this window.
Implemented in GHOST_WindowCarbon, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by GHOST_ActivateWindowDrawingContext(), GPG_Application::processEvent(), and View().
virtual bool GHOST_IWindow::canAcceptDragOperation | ( | ) | const [pure virtual] |
Returns acceptance of the dropped object Usually called by the "object dropped" event handling function
Implemented in GHOST_Window.
virtual void GHOST_IWindow::clientToScreen | ( | GHOST_TInt32 | inX, |
GHOST_TInt32 | inY, | ||
GHOST_TInt32 & | outX, | ||
GHOST_TInt32 & | outY | ||
) | const [pure virtual] |
Converts a point in screen coordinates to client rectangle coordinates
inX | The x-coordinate in the client rectangle. |
inY | The y-coordinate in the client rectangle. |
outX | The x-coordinate on the screen. |
outY | The y-coordinate on the screen. |
Implemented in GHOST_WindowCarbon, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by GHOST_ClientToScreen(), GHOST_SetCursorGrab(), and GPG_Canvas::SetMousePosition().
virtual GHOST_TSuccess GHOST_IWindow::endProgressBar | ( | ) | [pure virtual] |
Hides the progress bar in the icon
Implemented in GHOST_Window, and GHOST_WindowWin32.
Referenced by GHOST_EndProgressBar().
virtual void GHOST_IWindow::getClientBounds | ( | GHOST_Rect & | bounds | ) | const [pure virtual] |
Returns the client rectangle dimensions. The left and top members of the rectangle are always zero.
bounds | The bounding rectangle of the client area of the window. |
Implemented in GHOST_WindowCarbon, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by GHOST_GetClientBounds(), GHOST_SetCursorGrab(), GPG_Canvas::GPG_Canvas(), GPG_Application::processEvent(), GHOST_Window::setCursorGrab(), and View().
virtual GHOST_TStandardCursor GHOST_IWindow::getCursorShape | ( | ) | const [pure virtual] |
Returns the current cursor shape.
Implemented in GHOST_Window.
Referenced by GHOST_GetCursorShape().
virtual bool GHOST_IWindow::getCursorVisibility | ( | ) | const [pure virtual] |
Returns the visibility state of the cursor.
Implemented in GHOST_Window.
Referenced by GHOST_GetCursorVisibility(), and Application::processEvent().
virtual GHOST_TDrawingContextType GHOST_IWindow::getDrawingContextType | ( | ) | [pure virtual] |
Returns the type of drawing context used in this window.
Implemented in GHOST_Window.
Referenced by GHOST_GetDrawingContextType().
virtual bool GHOST_IWindow::getModifiedState | ( | ) | [pure virtual] |
Gets the window "modified" status, indicating unsaved changes
Implemented in GHOST_Window.
virtual void* GHOST_IWindow::getOSWindow | ( | ) | const [pure virtual] |
Returns the associated OS object/handle
Implemented in GHOST_Window.
virtual GHOST_TWindowState GHOST_IWindow::getState | ( | ) | const [pure virtual] |
Returns the state of the window (normal, minimized, maximized).
Implemented in GHOST_WindowCarbon, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by GHOST_GetWindowState().
virtual const GHOST_TabletData* GHOST_IWindow::GetTabletData | ( | ) | [pure virtual] |
Returns the tablet data (pressure etc).
Implemented in GHOST_WindowCarbon, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWin32, and GHOST_WindowX11.
virtual void GHOST_IWindow::getTitle | ( | STR_String & | title | ) | const [pure virtual] |
Returns the title displayed in the title bar.
title | The title displayed in the title bar. |
Implemented in GHOST_WindowCarbon, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by GHOST_GetTitle(), and Application::processEvent().
virtual GHOST_TUserDataPtr GHOST_IWindow::getUserData | ( | ) | const [pure virtual] |
Returns the window user data.
Implemented in GHOST_Window.
Referenced by GHOST_GetWindowUserData().
virtual bool GHOST_IWindow::getValid | ( | ) | const [pure virtual] |
Returns indication as to whether the window is valid.
Implemented in GHOST_WindowCarbon, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by GHOST_WindowManager::beginFullScreen(), GHOST_SystemCocoa::createWindow(), GHOST_SystemWin32::createWindow(), GHOST_SystemCarbon::createWindow(), and GHOST_GetValid().
virtual void GHOST_IWindow::getWindowBounds | ( | GHOST_Rect & | bounds | ) | const [pure virtual] |
Returns the window rectangle dimensions. These are screen coordinates.
bounds | The bounding rectangle of the window. |
Implemented in GHOST_WindowCarbon, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by GHOST_GetWindowBounds().
virtual GHOST_TSuccess GHOST_IWindow::invalidate | ( | ) | [pure virtual] |
Invalidates the contents of this window.
Implemented in GHOST_WindowCarbon, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by MyGlutMouseHandler::ButtonDown(), MyGlutMouseHandler::ButtonUp(), frameTimerProc(), gearsTimerProc(), GHOST_InvalidateWindow(), and MyGlutMouseHandler::Motion().
virtual void GHOST_IWindow::screenToClient | ( | GHOST_TInt32 | inX, |
GHOST_TInt32 | inY, | ||
GHOST_TInt32 & | outX, | ||
GHOST_TInt32 & | outY | ||
) | const [pure virtual] |
Converts a point in screen coordinates to client rectangle coordinates
inX | The x-coordinate on the screen. |
inY | The y-coordinate on the screen. |
outX | The x-coordinate in the client rectangle. |
outY | The y-coordinate in the client rectangle. |
Implemented in GHOST_WindowCarbon, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by GHOST_ScreenToClient(), and GPG_Application::handleCursorMove().
virtual void GHOST_IWindow::setAcceptDragOperation | ( | bool | canAccept | ) | [pure virtual] |
Tells if the ongoing drag'n'drop object can be accepted upon mouse drop
Implemented in GHOST_Window.
Referenced by GHOST_setAcceptDragOperation().
virtual GHOST_TSuccess GHOST_IWindow::setClientHeight | ( | GHOST_TUns32 | height | ) | [pure virtual] |
Resizes client rectangle height.
height | The new height of the client area of the window. |
Implemented in GHOST_WindowCarbon, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by GHOST_SetClientHeight().
virtual GHOST_TSuccess GHOST_IWindow::setClientSize | ( | GHOST_TUns32 | width, |
GHOST_TUns32 | height | ||
) | [pure virtual] |
Resizes client rectangle.
width | The new width of the client area of the window. |
height | The new height of the client area of the window. |
Implemented in GHOST_WindowCarbon, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by GHOST_SetClientSize(), and GPG_Application::startWindow().
virtual GHOST_TSuccess GHOST_IWindow::setClientWidth | ( | GHOST_TUns32 | width | ) | [pure virtual] |
Resizes client rectangle width.
width | The new width of the client area of the window. |
Implemented in GHOST_WindowCarbon, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by GHOST_SetClientWidth().
virtual GHOST_TSuccess GHOST_IWindow::setCursorGrab | ( | GHOST_TGrabCursorMode | mode, |
GHOST_Rect * | bounds | ||
) | [inline, virtual] |
Grabs the cursor for a modal operation.
grab | The new grab state of the cursor. |
Reimplemented in GHOST_Window.
Definition at line 306 of file GHOST_IWindow.h.
References GHOST_kSuccess.
Referenced by GHOST_SetCursorGrab().
virtual GHOST_TSuccess GHOST_IWindow::setCursorShape | ( | GHOST_TStandardCursor | cursorShape | ) | [pure virtual] |
Set the shape of the cursor.
cursor | The new cursor shape type id. |
Implemented in GHOST_Window.
Referenced by GHOST_SetCursorShape(), Application::processEvent(), and GPG_Canvas::SetMouseState().
virtual GHOST_TSuccess GHOST_IWindow::setCursorVisibility | ( | bool | visible | ) | [pure virtual] |
Shows or hides the cursor.
visible | The new visibility state of the cursor. |
Implemented in GHOST_Window.
Referenced by GHOST_SetCursorVisibility(), Application::processEvent(), GPG_Canvas::SetMouseState(), GPG_Application::startFullScreen(), and GPG_Application::startWindow().
virtual GHOST_TSuccess GHOST_IWindow::setCustomCursorShape | ( | GHOST_TUns8 * | bitmap, |
GHOST_TUns8 * | mask, | ||
int | sizex, | ||
int | sizey, | ||
int | hotX, | ||
int | hotY, | ||
int | fg_color, | ||
int | bg_color | ||
) | [pure virtual] |
Implemented in GHOST_Window.
virtual GHOST_TSuccess GHOST_IWindow::setCustomCursorShape | ( | GHOST_TUns8 | bitmap[16][2], |
GHOST_TUns8 | mask[16][2], | ||
int | hotX, | ||
int | hotY | ||
) | [pure virtual] |
Set the shape of the cursor to a custom cursor.
bitmap | The bitmap data for the cursor. |
mask | The mask data for the cursor. |
hotX | The X coordinate of the cursor hotspot. |
hotY | The Y coordinate of the cursor hotspot. |
Implemented in GHOST_Window.
Referenced by GHOST_SetCustomCursorShape(), and GHOST_SetCustomCursorShapeEx().
virtual GHOST_TSuccess GHOST_IWindow::setDrawingContextType | ( | GHOST_TDrawingContextType | type | ) | [pure virtual] |
Tries to install a rendering context in this window.
type | The type of rendering context installed. |
Implemented in GHOST_Window.
Referenced by GHOST_SetDrawingContextType(), and GPG_Canvas::Init().
virtual GHOST_TSuccess GHOST_IWindow::setModifiedState | ( | bool | isUnsavedChanges | ) | [pure virtual] |
Sets the window "modified" status, indicating unsaved changes
isUnsavedChanges | Unsaved changes or not |
Implemented in GHOST_Window.
Referenced by GHOST_SetWindowModifiedState().
virtual GHOST_TSuccess GHOST_IWindow::setOrder | ( | GHOST_TWindowOrder | order | ) | [pure virtual] |
Sets the order of the window (bottom, top).
order | The order of the window. |
Implemented in GHOST_WindowCarbon, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by GHOST_SetWindowOrder().
virtual GHOST_TSuccess GHOST_IWindow::setProgressBar | ( | float | progress | ) | [pure virtual] |
Sets the progress bar value displayed in the window/application icon
progress | The progress % |
Implemented in GHOST_Window, and GHOST_WindowWin32.
Referenced by GHOST_SetProgressBar().
virtual GHOST_TSuccess GHOST_IWindow::setState | ( | GHOST_TWindowState | state | ) | [pure virtual] |
Sets the state of the window (normal, minimized, maximized).
state | The state of the window. |
Implemented in GHOST_WindowCarbon, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by GHOST_SetWindowState(), and GPG_Application::startFullScreen().
virtual void GHOST_IWindow::setTitle | ( | const STR_String & | title | ) | [pure virtual] |
Sets the title displayed in the title bar.
title | The title to display in the title bar. |
Implemented in GHOST_WindowCarbon, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by GHOST_SetTitle(), and Application::processEvent().
virtual void GHOST_IWindow::setUserData | ( | const GHOST_TUserDataPtr | userData | ) | [pure virtual] |
Changes the window user data.
data | The window user data. |
Implemented in GHOST_Window.
Referenced by GHOST_SetWindowUserData().
virtual GHOST_TSuccess GHOST_IWindow::swapBuffers | ( | ) | [pure virtual] |
Swaps front and back buffers of a window.
Implemented in GHOST_WindowCarbon, GHOST_WindowNULL, GHOST_WindowSDL, GHOST_WindowWin32, and GHOST_WindowX11.
Referenced by GHOST_SwapWindowBuffers(), Application::processEvent(), and GPG_Canvas::SwapBuffers().