GHOST_Window.h

Go to the documentation of this file.

/*
 * $Id: GHOST_Window.h 37765 2011-06-23 19:55:47Z blendix $
 * ***** 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_WINDOW_H_
#define _GHOST_WINDOW_H_

#include "GHOST_IWindow.h"

class STR_String;

class GHOST_Window : public GHOST_IWindow
{
public:
        GHOST_Window(
                GHOST_TUns32 width,
                GHOST_TUns32 height,
                GHOST_TWindowState state,
                GHOST_TDrawingContextType type = GHOST_kDrawingContextTypeNone,
                const bool stereoVisual = false,
                const GHOST_TUns16 numOfAASamples = 0);

        virtual ~GHOST_Window();

        virtual void* getOSWindow() const;
        
        inline virtual GHOST_TStandardCursor getCursorShape() const;

        virtual GHOST_TSuccess setCursorShape(GHOST_TStandardCursor cursorShape);

        virtual GHOST_TSuccess setCustomCursorShape(GHOST_TUns8 bitmap[16][2], 
                                                                                                GHOST_TUns8 mask[16][2], 
                                                                                                int hotX, 
                                                                                                int hotY);
                                                                                                
        virtual GHOST_TSuccess setCustomCursorShape(GHOST_TUns8 *bitmap, 
                                                                                                GHOST_TUns8 *mask, 
                                                                                                int sizex, int sizey,
                                                                                                int hotX,  int hotY,
                                                                                                int fg_color, int bg_color);
        
        inline virtual bool getCursorVisibility() const;
        inline virtual GHOST_TGrabCursorMode getCursorGrabMode() const;
        inline virtual void getCursorGrabInitPos(GHOST_TInt32 &x, GHOST_TInt32 &y) const;
        inline virtual void getCursorGrabAccum(GHOST_TInt32 &x, GHOST_TInt32 &y) const;
        inline virtual void setCursorGrabAccum(GHOST_TInt32 x, GHOST_TInt32 y);

        virtual GHOST_TSuccess setCursorVisibility(bool visible);

        virtual GHOST_TSuccess setCursorGrab(GHOST_TGrabCursorMode mode, GHOST_Rect *bounds);

        virtual GHOST_TSuccess getCursorGrabBounds(GHOST_Rect& bounds);

        virtual GHOST_TSuccess setProgressBar(float progress) {return GHOST_kFailure;};
        
        virtual GHOST_TSuccess endProgressBar() {return GHOST_kFailure;};
        
        virtual void setAcceptDragOperation(bool canAccept);
        
        virtual bool canAcceptDragOperation() const;
        
        virtual GHOST_TSuccess setModifiedState(bool isUnsavedChanges);
        
        virtual bool getModifiedState();
        
        inline virtual GHOST_TDrawingContextType getDrawingContextType();

        virtual GHOST_TSuccess setDrawingContextType(GHOST_TDrawingContextType type);

        inline virtual GHOST_TUserDataPtr getUserData() const
        {
                return m_userData;
        }
        
        virtual void setUserData(const GHOST_TUserDataPtr userData)
        {
                m_userData = userData;
        }

protected:
        virtual GHOST_TSuccess installDrawingContext(GHOST_TDrawingContextType type) = 0;

        virtual GHOST_TSuccess removeDrawingContext() = 0;

        virtual GHOST_TSuccess setWindowCursorVisibility(bool visible) = 0;

        virtual GHOST_TSuccess setWindowCursorGrab(GHOST_TGrabCursorMode mode) { return GHOST_kSuccess; };
        
        virtual GHOST_TSuccess setWindowCursorShape(GHOST_TStandardCursor shape) = 0;

        virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 bitmap[16][2], GHOST_TUns8 mask[16][2],
                                                         int hotX, int hotY) = 0;
        
        virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 *bitmap, GHOST_TUns8 *mask, 
                                                int szx, int szy, int hotX, int hotY, int fg, int bg) = 0;
        GHOST_TDrawingContextType m_drawingContextType;
        
        GHOST_TUserDataPtr m_userData;

        bool m_cursorVisible;

        GHOST_TGrabCursorMode m_cursorGrab;

        GHOST_TInt32 m_cursorGrabInitPos[2];

        GHOST_TInt32 m_cursorGrabAccumPos[2];

        GHOST_Rect m_cursorGrabBounds;

        GHOST_TStandardCursor m_cursorShape;
    
        bool m_progressBarVisible;
        
        bool m_canAcceptDragOperation;
        
        bool m_isUnsavedChanges;
        
        bool m_fullScreen;

        bool m_stereoVisual;
        
        GHOST_TUns16 m_numOfAASamples;
    
    GHOST_TUns32 m_fullScreenWidth;
    GHOST_TUns32 m_fullScreenHeight;
};


inline GHOST_TDrawingContextType GHOST_Window::getDrawingContextType()
{
        return m_drawingContextType;
}

inline bool GHOST_Window::getCursorVisibility() const
{
        return m_cursorVisible;
}

inline GHOST_TGrabCursorMode GHOST_Window::getCursorGrabMode() const
{
        return m_cursorGrab;
}

inline void GHOST_Window::getCursorGrabInitPos(GHOST_TInt32 &x, GHOST_TInt32 &y) const
{
        x = m_cursorGrabInitPos[0];
        y = m_cursorGrabInitPos[1];
}

inline void GHOST_Window::getCursorGrabAccum(GHOST_TInt32 &x, GHOST_TInt32 &y) const
{
        x= m_cursorGrabAccumPos[0];
        y= m_cursorGrabAccumPos[1];
}

inline void GHOST_Window::setCursorGrabAccum(GHOST_TInt32 x, GHOST_TInt32 y)
{
        m_cursorGrabAccumPos[0]= x;
        m_cursorGrabAccumPos[1]= y;
}

inline GHOST_TStandardCursor GHOST_Window::getCursorShape() const
{
        return m_cursorShape;
}

#endif // _GHOST_WINDOW_H