GHOST_WindowX11.h

Go to the documentation of this file.

/*
 * 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.
 */
 
#pragma once
 
#include "GHOST_Window.h"
#include <X11/Xlib.h>
#include <X11/Xutil.h>
// For tablets
#ifdef WITH_X11_XINPUT
#  include <X11/extensions/XInput.h>
#endif
 
#include "GHOST_TaskbarX11.h"
 
#include <map>
 
class GHOST_SystemX11;
 
#ifdef WITH_XDND
class GHOST_DropTargetX11;
#endif
 
class GHOST_WindowX11 : public GHOST_Window {
 public:
  GHOST_WindowX11(GHOST_SystemX11 *system,
                  Display *display,
                  const char *title,
                  GHOST_TInt32 left,
                  GHOST_TInt32 top,
                  GHOST_TUns32 width,
                  GHOST_TUns32 height,
                  GHOST_TWindowState state,
                  GHOST_WindowX11 *parentWindow,
                  GHOST_TDrawingContextType type = GHOST_kDrawingContextTypeNone,
                  const bool is_dialog = false,
                  const bool stereoVisual = false,
                  const bool exclusive = false,
                  const bool alphaBackground = false,
                  const bool is_debug = false);
 
  bool getValid() const;
 
  void setTitle(const char *title);
 
  std::string getTitle() const;
 
  void getWindowBounds(GHOST_Rect &bounds) const;
 
  void getClientBounds(GHOST_Rect &bounds) const;
 
  bool isDialog() const;
 
  GHOST_TSuccess setClientWidth(GHOST_TUns32 width);
 
  GHOST_TSuccess setClientHeight(GHOST_TUns32 height);
 
  GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height);
 
  void screenToClient(GHOST_TInt32 inX,
                      GHOST_TInt32 inY,
                      GHOST_TInt32 &outX,
                      GHOST_TInt32 &outY) const;
 
  void clientToScreen(GHOST_TInt32 inX,
                      GHOST_TInt32 inY,
                      GHOST_TInt32 &outX,
                      GHOST_TInt32 &outY) const;
 
  GHOST_TWindowState getState() const;
 
  GHOST_TSuccess setState(GHOST_TWindowState state);
 
  GHOST_TSuccess setOrder(GHOST_TWindowOrder order);
 
  GHOST_TSuccess invalidate();
 
  GHOST_TSuccess setProgressBar(float progress);
  GHOST_TSuccess endProgressBar();
 
  ~GHOST_WindowX11();
 
  void validate();
 
  Window getXWindow();
 
  GHOST_TabletData &GetTabletData()
  {
    return m_tabletData;
  }
 
#if defined(WITH_X11_XINPUT) && defined(X_HAVE_UTF8_STRING)
  XIC getX11_XIC()
  {
    return m_xic;
  }
 
  bool createX11_XIC();
#endif
 
#ifdef WITH_X11_XINPUT
  void refreshXInputDevices();
#endif
 
#ifdef WITH_XDND
  GHOST_DropTargetX11 *getDropTarget()
  {
    return m_dropTarget;
  }
#endif
 
  /*
   * Need this in case that we want start the window
   * in FullScree or Maximized state.
   * Check GHOST_WindowX11.cpp
   */
  bool m_post_init;
  GHOST_TWindowState m_post_state;
 
  GHOST_TSuccess beginFullScreen() const;
 
  GHOST_TSuccess endFullScreen() const;
 
  GHOST_TSuccess setDialogHints(GHOST_WindowX11 *parentWindow);
 
  GHOST_TUns16 getDPIHint();
 
 protected:
  GHOST_Context *newDrawingContext(GHOST_TDrawingContextType type);
 
  GHOST_TSuccess setWindowCursorVisibility(bool visible);
 
  GHOST_TSuccess setWindowCursorGrab(GHOST_TGrabCursorMode mode);
 
  GHOST_TGrabCursorMode getWindowCursorGrab() const;
 
  GHOST_TSuccess setWindowCursorShape(GHOST_TStandardCursor shape);
  GHOST_TSuccess hasCursorShape(GHOST_TStandardCursor shape);
 
  GHOST_TSuccess setWindowCustomCursorShape(GHOST_TUns8 *bitmap,
                                            GHOST_TUns8 *mask,
                                            int sizex,
                                            int sizey,
                                            int hotX,
                                            int hotY,
                                            bool canInvertColor);
 
 private:
  /* Force use of public constructor. */
 
  GHOST_WindowX11();
 
  GHOST_WindowX11(const GHOST_WindowX11 &);
 
  GHOST_TSuccess getStandardCursor(GHOST_TStandardCursor g_cursor, Cursor &xcursor);
 
  Cursor getEmptyCursor();
 
  Window m_window;
  Display *m_display;
  XVisualInfo *m_visualInfo;
  void *m_fbconfig;
 
  GHOST_TWindowState m_normal_state;
 
  GHOST_SystemX11 *m_system;
 
  bool m_invalid_window;
 
  Cursor m_empty_cursor;
 
  Cursor m_custom_cursor;
 
  Cursor m_visible_cursor;
 
  std::map<unsigned int, Cursor> m_standard_cursors;
 
  GHOST_TaskBarX11 m_taskbar;
 
#ifdef WITH_XDND
  GHOST_DropTargetX11 *m_dropTarget;
#endif
 
  GHOST_TabletData m_tabletData;
 
#if defined(WITH_X11_XINPUT) && defined(X_HAVE_UTF8_STRING)
  XIC m_xic;
#endif
 
  bool m_valid_setup;
  bool m_is_debug_context;
 
  void icccmSetState(int state);
  int icccmGetState() const;
 
  void netwmMaximized(bool set);
  bool netwmIsMaximized() const;
 
  void netwmFullScreen(bool set);
  bool netwmIsFullScreen() const;
 
  void motifFullScreen(bool set);
  bool motifIsFullScreen() const;
};