modules/gui/skins2/src/os_factory.hpp

   1 /*****************************************************************************
   2  * os_factory.hpp
   3  *****************************************************************************
   4  * Copyright (C) 2003 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Cyril Deguet     <asmax@via.ecp.fr>
   8  *          Olivier Teulière <ipkiss@via.ecp.fr>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef OS_FACTORY_HPP
  26 #define OS_FACTORY_HPP
  27
  28 #include "skin_common.hpp"
  29 #include "../utils/position.hpp"
  30 #include <string>
  31 #include <list>
  32
  33 #include "../src/generic_window.hpp"
  34 class CmdGeneric;
  35 class OSBitmap;
  36 class OSGraphics;
  37 class OSLoop;
  38 class OSWindow;
  39 class OSTooltip;
  40 class OSPopup;
  41 class OSTimer;
  42
  43
  44 /// Abstract factory used to instantiate OS specific objects.
  45 class OSFactory: public SkinObject
  46 {
  47 public:
  48     enum CursorType_t
  49     {
  50         kDefaultArrow,
  51         kResizeNS,
  52         kResizeWE,
  53         kResizeNWSE,
  54         kResizeNESW,
  55         kNoCursor,
  56     };
  57
  58     /**
  59      * Initialization method overloaded in derived classes.
  60      * It must return false if the init failed.
  61      */
  62     virtual bool init() { return true; }
  63
  64     /**
  65      * Get the right instance of OSFactory.
  66      * Returns NULL if initialization of the concrete factory failed.
  67      */
  68     static OSFactory *instance( intf_thread_t *pIntf );
  69
  70     /// Delete the instance of OSFactory
  71     static void destroy( intf_thread_t *pIntf );
  72
  73     /// Instantiate an object OSGraphics
  74     virtual OSGraphics *createOSGraphics( int width, int height ) = 0;
  75
  76     /// Get the instance of the singleton OSLoop
  77     virtual OSLoop *getOSLoop() = 0;
  78
  79     /// Destroy the instance of OSLoop
  80     virtual void destroyOSLoop() = 0;
  81
  82     /// Minimize all the windows
  83     virtual void minimize() = 0;
  84
  85     /// Restore the minimized windows
  86     virtual void restore() = 0;
  87
  88     /// Add an icon in the system tray
  89     virtual void addInTray() = 0;
  90
  91     /// Remove the icon from the system tray
  92     virtual void removeFromTray() = 0;
  93
  94     /// Show the task in the task bar
  95     virtual void addInTaskBar() = 0;
  96
  97     /// Remove the task from the task bar
  98     virtual void removeFromTaskBar() = 0;
  99
 100     /// Instantiate an OSTimer with the given command
 101     virtual OSTimer *createOSTimer( CmdGeneric &rCmd ) = 0;
 102
 103     /// Instantiate an object OSWindow
 104     virtual OSWindow *createOSWindow( GenericWindow &rWindow,
 105                                       bool dragDrop, bool playOnDrop,
 106                                       OSWindow *pParent, GenericWindow::WindowType_t ) = 0;
 107
 108     /// Instantiate an object OSTooltip
 109     virtual OSTooltip *createOSTooltip() = 0;
 110
 111     /// Instantiate an object OSPopup
 112     virtual OSPopup *createOSPopup() = 0;
 113
 114     /// Get the directory separator
 115     virtual const std::string &getDirSeparator() const = 0;
 116
 117     /// Get the resource path
 118     virtual const std::list<std::string> &getResourcePath() const = 0;
 119
 120     /// Get the screen size
 121     virtual int getScreenWidth() const = 0;
 122     virtual int getScreenHeight() const = 0;
 123
 124     /// Get Monitor Information for a given Window
 125     virtual void getMonitorInfo( OSWindow *pWindow,
 126                                  int* x, int* y,
 127                                  int* width, int* height ) const = 0;
 128
 129     /// Get Monitor Information (screens numbered from 0 upwards.)
 130     virtual void getMonitorInfo( int num, int* x, int* y,
 131                                  int* width, int* height ) const = 0;
 132
 133     /// Get the work area (screen area without taskbars)
 134     virtual SkinsRect getWorkArea() const = 0;
 135
 136     /// Get the position of the mouse
 137     virtual void getMousePos( int &rXPos, int &rYPos ) const = 0;
 138
 139     /// Change the cursor
 140     virtual void changeCursor( CursorType_t type ) const = 0;
 141
 142     /// Delete a directory recursively
 143     virtual void rmDir( const std::string &rPath ) = 0;
 144
 145 protected:
 146     // Protected because it's a singleton
 147     OSFactory( intf_thread_t* pIntf ): SkinObject( pIntf ) { }
 148     virtual ~OSFactory() { }
 149 };
 150
 151
 152 #endif