GHOST_SystemCocoa.h

Go to the documentation of this file.

/*
 * $Id: GHOST_SystemCocoa.h 38908 2011-08-02 04:28:05Z merwin $
 * ***** 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):      Maarten Gribnau 05/2001
 *                                      Damien Plisson 09/2009
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#ifndef _GHOST_SYSTEM_COCOA_H_
#define _GHOST_SYSTEM_COCOA_H_

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

//#define __CARBONSOUND__


#include "GHOST_System.h"

class GHOST_EventCursor;
class GHOST_EventKey;
class GHOST_EventWindow;
class GHOST_WindowCocoa;


class GHOST_SystemCocoa : public GHOST_System {
public:
    GHOST_SystemCocoa();
    
    ~GHOST_SystemCocoa();
    
        /***************************************************************************************
         ** Time(r) functionality
         ***************************************************************************************/

        virtual GHOST_TUns64 getMilliSeconds() const;

        /***************************************************************************************
         ** Display/window management functionality
         ***************************************************************************************/

        virtual GHOST_TUns8 getNumDisplays() const;

        virtual void getMainDisplayDimensions(GHOST_TUns32& width, GHOST_TUns32& height) const;
        
        virtual GHOST_IWindow* createWindow(
                const STR_String& title,
                GHOST_TInt32 left,
                GHOST_TInt32 top,
                GHOST_TUns32 width,
                GHOST_TUns32 height,
                GHOST_TWindowState state,
                GHOST_TDrawingContextType type,
                const bool stereoVisual = false,
                const GHOST_TUns16 numOfAASamples = 0,
                const GHOST_TEmbedderWindowID parentWindow = 0 
        );
        
        /***************************************************************************************
         ** Event management functionality
         ***************************************************************************************/

        virtual bool processEvents(bool waitForEvent);
        
        GHOST_TUns8 handleQuitRequest();
        
        bool handleOpenDocumentRequest(void *filepathStr);      
        
        GHOST_TSuccess handleDraggingEvent(GHOST_TEventType eventType, GHOST_TDragnDropTypes draggedObjectType,
                                                                           GHOST_WindowCocoa* window, int mouseX, int mouseY, void* data);
        
        /***************************************************************************************
         ** Cursor management functionality
         ***************************************************************************************/

        virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const;

        virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y);
        
        /***************************************************************************************
         ** Access to mouse button and keyboard states.
         ***************************************************************************************/

        virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) const;

        virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const;

        virtual GHOST_TUns8* getClipboard(bool selection) const;
        
        virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const;

    GHOST_TSuccess handleWindowEvent(GHOST_TEventType eventType, GHOST_WindowCocoa* window);
        
    GHOST_TSuccess handleApplicationBecomeActiveEvent();

        void notifyExternalEventProcessed();

        int toggleConsole(int action) { return 0; }
        
        
protected:
        virtual GHOST_TSuccess init();

    GHOST_TSuccess handleTabletEvent(void *eventPtr, short eventType);
    
    GHOST_TSuccess handleMouseEvent(void *eventPtr);

    GHOST_TSuccess handleKeyEvent(void *eventPtr);
    
        GHOST_TSuccess setMouseCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y);

        GHOST_TUns64 m_start_time;
        
        bool m_outsideLoopEventProcessed;
        
        bool m_needDelayedApplicationBecomeActiveEventProcessing;
        
        GHOST_TUns32 m_pressedMouseButtons;
        
    GHOST_TUns32 m_modifierMask;

    bool m_ignoreWindowSizedMessages;   
        
        GHOST_TInt32 m_cursorDelta_x, m_cursorDelta_y;
        
        bool m_hasMultiTouchTrackpad;
        
        bool m_isGestureInProgress;
};

#endif // _GHOST_SYSTEM_COCOA_H_