GHOST_IWindow.h

Go to the documentation of this file.

/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#ifndef _GHOST_IWINDOW_H_
#define _GHOST_IWINDOW_H_

#include "STR_String.h"
#include "GHOST_Rect.h"
#include "GHOST_Types.h"


class GHOST_IWindow
{
public:
    virtual ~GHOST_IWindow()
    {
    }

    virtual bool getValid() const = 0;

    virtual void* getOSWindow() const = 0;

    virtual GHOST_TDrawingContextType getDrawingContextType() = 0;

    virtual GHOST_TSuccess setDrawingContextType(GHOST_TDrawingContextType type) = 0;

    virtual void setTitle(const STR_String& title) = 0;

    virtual void getTitle(STR_String& title) const = 0;

    virtual void getWindowBounds(GHOST_Rect& bounds) const = 0;
    
    virtual void getClientBounds(GHOST_Rect& bounds) const = 0;

    virtual GHOST_TSuccess setClientWidth(GHOST_TUns32 width) = 0;

    virtual GHOST_TSuccess setClientHeight(GHOST_TUns32 height) = 0;

    virtual GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height) = 0;

    virtual void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0;

    virtual void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0;

    virtual void setAcceptDragOperation(bool canAccept) = 0;
    
    virtual bool canAcceptDragOperation() const = 0;
    
    virtual GHOST_TWindowState getState() const = 0;

    virtual GHOST_TSuccess setState(GHOST_TWindowState state) = 0;

    virtual GHOST_TSuccess setModifiedState(bool isUnsavedChanges) = 0;
    
    virtual bool getModifiedState() = 0;
    
    virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order) = 0;

    virtual GHOST_TSuccess swapBuffers() = 0;

    virtual GHOST_TSuccess activateDrawingContext() = 0;

    virtual GHOST_TSuccess invalidate() = 0;
    
    virtual GHOST_TUserDataPtr getUserData() const = 0;
    
    virtual void setUserData(const GHOST_TUserDataPtr userData) = 0;
    
    virtual const GHOST_TabletData* GetTabletData() = 0;
    
    /***************************************************************************************
     ** Progress bar functionality
     ***************************************************************************************/
    
    virtual GHOST_TSuccess setProgressBar(float progress) = 0;
    
    virtual GHOST_TSuccess endProgressBar() = 0;
    
    /***************************************************************************************
     ** Cursor management functionality
     ***************************************************************************************/

    virtual GHOST_TStandardCursor getCursorShape() const = 0;

    virtual GHOST_TSuccess setCursorShape(GHOST_TStandardCursor cursorShape) = 0;

    virtual GHOST_TSuccess setCustomCursorShape(GHOST_TUns8 bitmap[16][2], 
                                                GHOST_TUns8 mask[16][2], 
                                                int hotX, 
                                                int hotY) = 0;
                                                
    virtual GHOST_TSuccess setCustomCursorShape(GHOST_TUns8 *bitmap, 
                                                GHOST_TUns8 *mask, 
                                                int sizex, int sizey, 
                                                int hotX, int hotY, 
                                                int fg_color, int bg_color) = 0;

    virtual bool getCursorVisibility() const = 0;

    virtual GHOST_TSuccess setCursorVisibility(bool visible) = 0;

    virtual GHOST_TSuccess setCursorGrab(GHOST_TGrabCursorMode mode, GHOST_Rect *bounds) { return GHOST_kSuccess; }

#ifdef WITH_CXX_GUARDEDALLOC
public:
    void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GHOST:GHOST_IWindow"); }
    void operator delete( void *mem ) { MEM_freeN(mem); }
#endif
};

#endif // _GHOST_IWINDOW_H_