diff options
author | Campbell Barton <ideasman42@gmail.com> | 2012-09-06 06:10:09 +0400 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2012-09-06 06:10:09 +0400 |
commit | 47ec91e8d343c77e494a334ca8054c6d3538d893 (patch) | |
tree | d01a9dc7e4a592f4ba4d45fa29711fd251dab3ff /intern/ghost/GHOST_IWindow.h | |
parent | 5d2e4bb87e6d3db0a7978dd3bd3ec573a52c4ae9 (diff) |
code clenup: comments and some style edits on ghost/osx (odd indentation)
Diffstat (limited to 'intern/ghost/GHOST_IWindow.h')
-rw-r--r-- | intern/ghost/GHOST_IWindow.h | 104 |
1 files changed, 52 insertions, 52 deletions
diff --git a/intern/ghost/GHOST_IWindow.h b/intern/ghost/GHOST_IWindow.h index b606294e97d..a1a1acfca75 100644 --- a/intern/ghost/GHOST_IWindow.h +++ b/intern/ghost/GHOST_IWindow.h @@ -43,7 +43,7 @@ * * You can create a window with the system's GHOST_ISystem::createWindow * method. - * @see GHOST_ISystem#createWindow + * \see GHOST_ISystem#createWindow * * There are two coordinate systems: * <ul> @@ -53,8 +53,8 @@ * is the area that is drawable by the application (excluding title bars etc.). * </li> * </ul> - * @author Maarten Gribnau - * @date May 31, 2001 + * \author Maarten Gribnau + * \date May 31, 2001 */ class GHOST_IWindow { @@ -68,89 +68,89 @@ public: /** * Returns indication as to whether the window is valid. - * @return The validity of the window. + * \return The validity of the window. */ virtual bool getValid() const = 0; /** * Returns the associated OS object/handle - * @return The associated OS object/handle + * \return The associated OS object/handle */ virtual void *getOSWindow() const = 0; /** * Returns the type of drawing context used in this window. - * @return The current type of drawing context. + * \return The current type of drawing context. */ virtual GHOST_TDrawingContextType getDrawingContextType() = 0; /** * Tries to install a rendering context in this window. - * @param type The type of rendering context installed. - * @return Indication as to whether installation has succeeded. + * \param type The type of rendering context installed. + * \return Indication as to whether installation has succeeded. */ virtual GHOST_TSuccess setDrawingContextType(GHOST_TDrawingContextType type) = 0; /** * Sets the title displayed in the title bar. - * @param title The title to display in the title bar. + * \param title The title to display in the title bar. */ virtual void setTitle(const STR_String& title) = 0; /** * Returns the title displayed in the title bar. - * @param title The title displayed in the title bar. + * \param title The title displayed in the title bar. */ virtual void getTitle(STR_String& title) const = 0; /** * Returns the window rectangle dimensions. * These are screen coordinates. - * @param bounds The bounding rectangle of the window. + * \param bounds The bounding rectangle of the window. */ virtual void getWindowBounds(GHOST_Rect& bounds) const = 0; /** * Returns the client rectangle dimensions. * The left and top members of the rectangle are always zero. - * @param bounds The bounding rectangle of the client area of the window. + * \param bounds The bounding rectangle of the client area of the window. */ virtual void getClientBounds(GHOST_Rect& bounds) const = 0; /** * Resizes client rectangle width. - * @param width The new width of the client area of the window. + * \param width The new width of the client area of the window. */ virtual GHOST_TSuccess setClientWidth(GHOST_TUns32 width) = 0; /** * Resizes client rectangle height. - * @param height The new height of the client area of the window. + * \param height The new height of the client area of the window. */ virtual GHOST_TSuccess setClientHeight(GHOST_TUns32 height) = 0; /** * Resizes client rectangle. - * @param width The new width of the client area of the window. - * @param height The new height of the client area of the window. + * \param width The new width of the client area of the window. + * \param height The new height of the client area of the window. */ virtual GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height) = 0; /** * Converts a point in screen coordinates to client rectangle coordinates - * @param inX The x-coordinate on the screen. - * @param inY The y-coordinate on the screen. - * @param outX The x-coordinate in the client rectangle. - * @param outY The y-coordinate in the client rectangle. + * \param inX The x-coordinate on the screen. + * \param inY The y-coordinate on the screen. + * \param outX The x-coordinate in the client rectangle. + * \param outY The y-coordinate in the client rectangle. */ virtual void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0; /** * Converts a point in screen coordinates to client rectangle coordinates - * @param inX The x-coordinate in the client rectangle. - * @param inY The y-coordinate in the client rectangle. - * @param outX The x-coordinate on the screen. - * @param outY The y-coordinate on the screen. + * \param inX The x-coordinate in the client rectangle. + * \param inY The y-coordinate in the client rectangle. + * \param outX The x-coordinate on the screen. + * \param outY The y-coordinate on the screen. */ virtual void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0; @@ -167,70 +167,70 @@ public: /** * Returns the state of the window (normal, minimized, maximized). - * @return The state of the window. + * \return The state of the window. */ virtual GHOST_TWindowState getState() const = 0; /** * Sets the state of the window (normal, minimized, maximized). - * @param state The state of the window. - * @return Indication of success. + * \param state The state of the window. + * \return Indication of success. */ virtual GHOST_TSuccess setState(GHOST_TWindowState state) = 0; /** * Sets the window "modified" status, indicating unsaved changes - * @param isUnsavedChanges Unsaved changes or not - * @return Indication of success. + * \param isUnsavedChanges Unsaved changes or not + * \return Indication of success. */ virtual GHOST_TSuccess setModifiedState(bool isUnsavedChanges) = 0; /** * Gets the window "modified" status, indicating unsaved changes - * @return True if there are unsaved changes + * \return True if there are unsaved changes */ virtual bool getModifiedState() = 0; /** * Sets the order of the window (bottom, top). - * @param order The order of the window. - * @return Indication of success. + * \param order The order of the window. + * \return Indication of success. */ virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order) = 0; /** * Swaps front and back buffers of a window. - * @return A boolean success indicator. + * \return A boolean success indicator. */ virtual GHOST_TSuccess swapBuffers() = 0; /** * Activates the drawing context of this window. - * @return A boolean success indicator. + * \return A boolean success indicator. */ virtual GHOST_TSuccess activateDrawingContext() = 0; /** * Invalidates the contents of this window. - * @return Indication of success. + * \return Indication of success. */ virtual GHOST_TSuccess invalidate() = 0; /** * Returns the window user data. - * @return The window user data. + * \return The window user data. */ virtual GHOST_TUserDataPtr getUserData() const = 0; /** * Changes the window user data. - * @param data The window user data. + * \param data The window user data. */ virtual void setUserData(const GHOST_TUserDataPtr userData) = 0; /** * Returns the tablet data (pressure etc). - * @return The tablet data (pressure etc). + * \return The tablet data (pressure etc). */ virtual const GHOST_TabletData *GetTabletData() = 0; @@ -240,7 +240,7 @@ public: /** * Sets the progress bar value displayed in the window/application icon - * @param progress The progress % + * \param progress The progress % */ virtual GHOST_TSuccess setProgressBar(float progress) = 0; @@ -255,24 +255,24 @@ public: /** * Returns the current cursor shape. - * @return The current cursor shape. + * \return The current cursor shape. */ virtual GHOST_TStandardCursor getCursorShape() const = 0; /** * Set the shape of the cursor. - * @param cursor The new cursor shape type id. - * @return Indication of success. + * \param cursor The new cursor shape type id. + * \return Indication of success. */ virtual GHOST_TSuccess setCursorShape(GHOST_TStandardCursor cursorShape) = 0; /** * Set the shape of the cursor to a custom cursor. - * @param bitmap The bitmap data for the cursor. - * @param mask The mask data for the cursor. - * @param hotX The X coordinate of the cursor hotspot. - * @param hotY The Y coordinate of the cursor hotspot. - * @return Indication of success. + * \param bitmap The bitmap data for the cursor. + * \param mask The mask data for the cursor. + * \param hotX The X coordinate of the cursor hotspot. + * \param hotY The Y coordinate of the cursor hotspot. + * \return Indication of success. */ virtual GHOST_TSuccess setCustomCursorShape(GHOST_TUns8 bitmap[16][2], GHOST_TUns8 mask[16][2], @@ -287,21 +287,21 @@ public: /** * Returns the visibility state of the cursor. - * @return The visibility state of the cursor. + * \return The visibility state of the cursor. */ virtual bool getCursorVisibility() const = 0; /** * Shows or hides the cursor. - * @param visible The new visibility state of the cursor. - * @return Indication of success. + * \param visible The new visibility state of the cursor. + * \return Indication of success. */ virtual GHOST_TSuccess setCursorVisibility(bool visible) = 0; /** * Grabs the cursor for a modal operation. - * @param grab The new grab state of the cursor. - * @return Indication of success. + * \param grab The new grab state of the cursor. + * \return Indication of success. */ virtual GHOST_TSuccess setCursorGrab(GHOST_TGrabCursorMode mode, GHOST_Rect *bounds) { return GHOST_kSuccess; } |