GHOST_WindowWin32.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_WINDOW_WIN32_H_
#define _GHOST_WINDOW_WIN32_H_

#ifndef WIN32
#error WIN32 only!
#endif // WIN32

#include "GHOST_Window.h"
#include "GHOST_TaskbarWin32.h"

#define _WIN32_WINNT 0x501 // require Windows XP or newer
#define WIN32_LEAN_AND_MEAN
#include <windows.h>


#include <wintab.h>
#define PACKETDATA  (PK_BUTTONS | PK_NORMAL_PRESSURE | PK_ORIENTATION | PK_CURSOR)
#define PACKETMODE  PK_BUTTONS
#include <pktdef.h>

class GHOST_SystemWin32;
class GHOST_DropTargetWin32;

// typedefs for WinTab functions to allow dynamic loading
typedef UINT (API * GHOST_WIN32_WTInfo) ( UINT, UINT, LPVOID );
typedef HCTX (API * GHOST_WIN32_WTOpen) (HWND, LPLOGCONTEXTA, BOOL);
typedef BOOL (API * GHOST_WIN32_WTClose) (HCTX);
typedef BOOL (API * GHOST_WIN32_WTPacket) (HCTX, UINT, LPVOID);

class GHOST_WindowWin32 : public GHOST_Window {
public:
    GHOST_WindowWin32(
        GHOST_SystemWin32 * system,
        const STR_String& title,
        GHOST_TInt32 left,
        GHOST_TInt32 top,
        GHOST_TUns32 width,
        GHOST_TUns32 height,
        GHOST_TWindowState state,
        GHOST_TDrawingContextType type = GHOST_kDrawingContextTypeNone,
        const bool stereoVisual = false,
        const GHOST_TUns16 numOfAASamples = 0,
        GHOST_TEmbedderWindowID parentWindowHwnd=0,
        GHOST_TSuccess msEnabled = GHOST_kFailure,
        int msPixelFormat = 0
    );

    virtual ~GHOST_WindowWin32();

    GHOST_Window *getNextWindow();

    virtual bool getValid() const;

    virtual HWND getHWND() 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 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;

    virtual GHOST_TSuccess setState(GHOST_TWindowState state);

    virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order);

    virtual GHOST_TSuccess swapBuffers();

    virtual GHOST_TSuccess activateDrawingContext();

    virtual GHOST_TSuccess invalidate();

    virtual GHOST_TSuccess setProgressBar(float progress);
    
    virtual GHOST_TSuccess endProgressBar();
    
    static LPCSTR getWindowClassName() { return s_windowClassName; }

    void registerMouseClickEvent(int press);

    void lostMouseCapture();

    void loadCursor(bool visible, GHOST_TStandardCursor cursorShape) const;

    const GHOST_TabletData* GetTabletData()
    { return m_tabletData; }

    void processWin32TabletInitEvent();
    void processWin32TabletEvent(WPARAM wParam, LPARAM lParam);

protected:
    GHOST_TSuccess initMultisample(PIXELFORMATDESCRIPTOR pfd);

    virtual GHOST_TSuccess installDrawingContext(GHOST_TDrawingContextType type);

    virtual GHOST_TSuccess removeDrawingContext();

    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[16][2],
                                                      GHOST_TUns8 mask[16][2],
                                                      int hotX, int hotY);

    virtual GHOST_TSuccess setWindowCustomCursorShape(
        GHOST_TUns8 *bitmap, 
        GHOST_TUns8 *mask, 
        int sizex, 
        int sizey,
        int hotX, 
        int hotY,
        int fg_color, 
        int bg_color
    );
    
    GHOST_SystemWin32 * m_system;
    GHOST_DropTargetWin32 * m_dropTarget;
    HWND m_hWnd;
    HDC m_hDC;
    HGLRC m_hGlRc;
    static HGLRC s_firsthGLRc;
    static HDC s_firstHDC;
    bool m_hasMouseCaptured;
    bool m_hasGrabMouse;
    int m_nPressedButtons;
    HCURSOR m_customCursor;

    ITaskbarList3 * m_Bar;

    static LPCSTR s_windowClassName;
    static const int s_maxTitleLength;

    HMODULE m_wintab;

    GHOST_TabletData* m_tabletData;

    HCTX m_tablet;
    LONG m_maxPressure;
    LONG m_maxAzimuth, m_maxAltitude;

    GHOST_TUns16 m_multisample;

    GHOST_TSuccess m_multisampleEnabled;

    int m_msPixelFormat;

    const STR_String& m_title;
    GHOST_TInt32 m_left;
    GHOST_TInt32 m_top;
    GHOST_TUns32 m_width;
    GHOST_TUns32 m_height;
    GHOST_TWindowState m_normal_state;
    bool m_stereo;

    GHOST_Window *m_nextWindow;

    GHOST_TEmbedderWindowID m_parentWindowHwnd;
};

#endif // _GHOST_WINDOW_WIN32_H_