GHOST_WindowCocoa.h

Go to the documentation of this file.

/*
 * $Id: GHOST_WindowCocoa.h 37861 2011-06-27 13:57:27Z 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_COCOA_H_
#define _GHOST_WINDOW_COCOA_H_

#ifndef __APPLE__
#error Apple OSX only!
#endif // __APPLE__

#include "GHOST_Window.h"
#include "STR_String.h"

@class CocoaWindow;
@class CocoaOpenGLView;

class GHOST_SystemCocoa;

class GHOST_WindowCocoa : public GHOST_Window {
public:
        GHOST_WindowCocoa(
                GHOST_SystemCocoa *systemCocoa,
                const STR_String& title,
                GHOST_TInt32 left,
                GHOST_TInt32 bottom,
                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_WindowCocoa();

        virtual bool getValid() const;
        
        virtual void* getOSWindow() const;

        virtual void setTitle(const STR_String& title);

        virtual void getTitle(STR_String& title) const;

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

        virtual GHOST_TSuccess setClientWidth(GHOST_TUns32 width);

        virtual GHOST_TSuccess setClientHeight(GHOST_TUns32 height);

        virtual GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height);

        virtual GHOST_TWindowState getState() const;

        virtual GHOST_TSuccess setModifiedState(bool isUnsavedChanges);
        
        virtual void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;

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

        void clientToScreenIntern(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;

        void screenToClientIntern(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;

        NSScreen* getScreen();
        
        virtual GHOST_TSuccess setState(GHOST_TWindowState state);

        virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order);

        virtual GHOST_TSuccess swapBuffers();

        GHOST_TSuccess updateDrawingContext();

        virtual GHOST_TSuccess activateDrawingContext();

        virtual void loadCursor(bool visible, GHOST_TStandardCursor cursor) const;
    

        const GHOST_TabletData* GetTabletData()
        { return &m_tablet; }

        GHOST_TabletData& GetCocoaTabletData()
        { return m_tablet; }
        
        virtual GHOST_TSuccess setProgressBar(float progress);
        
        virtual GHOST_TSuccess endProgressBar();
protected:
        virtual GHOST_TSuccess installDrawingContext(GHOST_TDrawingContextType type);

        virtual GHOST_TSuccess removeDrawingContext();
    
        virtual GHOST_TSuccess invalidate();

        virtual GHOST_TSuccess setWindowCursorVisibility(bool visible);
        
        virtual GHOST_TSuccess setWindowCursorGrab(GHOST_TGrabCursorMode mode);
                
        virtual GHOST_TSuccess setWindowCursorShape(GHOST_TStandardCursor shape);

        virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 *bitmap, GHOST_TUns8 *mask,
                                        int sizex, int sizey, int hotX, int hotY, int fg_color, int bg_color);
                                        
        virtual GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 bitmap[16][2], GHOST_TUns8 mask[16][2], int hotX, int hotY);
    
    CocoaWindow *m_window;
        
        CocoaOpenGLView *m_openGLView; 
    
        NSOpenGLContext *m_openGLContext;
        
        GHOST_SystemCocoa *m_systemCocoa;
                        
        static NSOpenGLContext *s_firstOpenGLcontext;
        
        NSCursor*       m_customCursor;

        GHOST_TabletData m_tablet;
};

#endif // _GHOST_WINDOW_COCOA_H_