Public API Reference

csplugincommon/canvas/canvascommon.h

Go to the documentation of this file.

/*
    Copyright (C) 1998-2001 by Jorrit Tyberghein
              (C) 2012 by Frank Richter
    Originally written by Andrew Zabolotny <bit@eltech.ru>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library 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
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CS_CSPLUGINCOMMON_CANVAS_CANVASCOMMON_H__
#define __CS_CSPLUGINCOMMON_CANVAS_CANVASCOMMON_H__

#include "csextern.h"

#include "iutil/event.h"
#include "iutil/pluginconfig.h"
#include "ivideo/canvas.h"
#include "ivideo/natwin.h"

struct iEventOutlet;
struct iObjectRegistry;

namespace CS
{
  namespace PluginCommon
  {

    #include "csutil/deprecated_warn_off.h"

    class CS_CRYSTALSPACE_EXPORT CanvasCommonBase :
      public virtual iGraphicsCanvas,
      public iNativeWindow,
      public iNativeWindowManager,
      public iPluginConfig,
      public iEventPlug
    {
    public:
      iObjectRegistry* objectReg;
      bool canvas_open;

      csString win_title;

      int fbWidth, fbHeight, Depth;

      int DisplayNumber;
      bool FullScreen;
      bool AllowResizing;
      virtual void ChangeDepth (int d);
      virtual const char *GetName() const;

      enum HWMouseMode
      {
        hwmcOff,
        hwmcOn,
        hwmcRGBAOnly
      };
      HWMouseMode hwMouse;
    protected:
      int refreshRate;
      bool vsync;
      bool fitToWorkingArea;

      csString name;

      void Initialize (iObjectRegistry* object_reg);

      void ResizeNotify (int newWidth, int newHeight);
      void BroadcastResize (int oldWidth, int oldHeight);

      virtual bool GetWorkspaceDimensions (int& width, int& height);
      virtual bool AddWindowFrameDimensions (int& width, int& height);
    public:
      CanvasCommonBase ();
      virtual ~CanvasCommonBase ();

      virtual bool CanvasOpen ();
      virtual void CanvasClose ();

      virtual void Print (csRect const* /*area*/ = 0) { }

      virtual bool SetGamma (float /*gamma*/) { return false; }
      virtual float GetGamma () const { return 1.0; }

    public:
      csRef<iEventOutlet> EventOutlet;

      int GetColorDepth () { return Depth; }

      virtual bool CanvasResize (int w, int h);
      bool ForceCanvasResize (int w, int h);

      virtual iNativeWindow* GetNativeWindow ();

      virtual bool GetFullScreen ()
      { return FullScreen; }

      virtual void SetFullScreen (bool b);

      virtual bool SetMousePosition (int x, int y);

      virtual bool SetMouseCursor (csMouseCursorID iShape);

      virtual bool SetMouseCursor (iImage *image, const csRGBcolor* keycolor = 0,
                                   int hotspot_x = 0, int hotspot_y = 0,
                                   csRGBcolor fg = csRGBcolor(255,255,255),
                                   csRGBcolor bg = csRGBcolor(0,0,0));

      void GetFramebufferDimensions (int& width, int& height)
      { width = fbWidth; height = fbHeight; }

      bool CanResize ()
      { return AllowResizing; }
    protected:
      // Virtual Alert function so it can be overridden by subclasses
      // of csGraphics2D.
      virtual void AlertV (int type, const char* title, const char* okMsg,
        const char* msg, va_list args);
      virtual void Alert (int type, const char* title, const char* okMsg,
          const char* msg, ...);
      virtual void AlertV (int type, const wchar_t* title, const wchar_t* okMsg,
        const wchar_t* msg, va_list args);
      virtual void Alert (int type, const wchar_t* title, const wchar_t* okMsg,
          const wchar_t* msg, ...);
      // Virtual SetTitle function so it can be overridden by subclasses
      // of csGraphics2D.
      virtual void SetTitle (const char* title);
      virtual void SetTitle (const wchar_t* title)
      { SetTitle (csString (title)); }

      virtual void SetIcon (iImage *image);

      virtual bool IsWindowTransparencyAvailable() { return false; }
      virtual bool SetWindowTransparent (bool transparent) { return false; }
      virtual bool GetWindowTransparent () { return false; }

      virtual bool SetWindowDecoration (WindowDecoration decoration, bool flag)
      { return false; }
      virtual bool GetWindowDecoration (WindowDecoration decoration);

      virtual bool FitSizeToWorkingArea (int& desiredWidth,
                                         int& desiredHeight);
      virtual bool GetOptionDescription (int idx, csOptionDescription*);
      virtual bool SetOption (int id, csVariant* value);
      virtual bool GetOption (int id, csVariant* value);
      virtual unsigned GetPotentiallyConflictingEvents ()
      { return CSEVTYPE_Keyboard | CSEVTYPE_Mouse; }
      virtual unsigned QueryEventPriority (unsigned /*iType*/)
      { return 150; }
    };

    #include "csutil/deprecated_warn_on.h"
  } // namespace PluginCommon
} // namespace CS

#endif // __CS_CSPLUGINCOMMON_CANVAS_CANVASCOMMON_H__

---