include/IOSOperator.h

   1 // Copyright (C) 2002-2012 Nikolaus Gebhardt\r
   2 // This file is part of the "Irrlicht Engine".\r
   3 // For conditions of distribution and use, see copyright notice in irrlicht.h\r
   4 \r
   5 #ifndef __I_OS_OPERATOR_H_INCLUDED__\r
   6 #define __I_OS_OPERATOR_H_INCLUDED__\r
   7 \r
   8 #include "IReferenceCounted.h"\r
   9 #include "irrString.h"\r
  10 \r
  11 namespace irr\r
  12 {\r
  13 \r
  14 //! The Operating system operator provides operation system specific methods and information.\r
  15 class IOSOperator : public virtual IReferenceCounted\r
  16 {\r
  17 public:\r
  18         //! Get the current operation system version as string.\r
  19         virtual const core::stringc& getOperatingSystemVersion() const = 0;\r
  20 \r
  21         //! Get the current operation system version as string.\r
  22         /** \deprecated Use getOperatingSystemVersion instead. This method will be removed in Irrlicht 1.9. */\r
  23         _IRR_DEPRECATED_ const wchar_t* getOperationSystemVersion() const\r
  24         {\r
  25                 return core::stringw(getOperatingSystemVersion()).c_str();\r
  26         }\r
  27 \r
  28         //! Copies text to the clipboard\r
  29         virtual void copyToClipboard(const c8* text) const = 0;\r
  30 \r
  31         //! Get text from the clipboard\r
  32         /** \return Returns 0 if no string is in there. */\r
  33         virtual const c8* getTextFromClipboard() const = 0;\r
  34 \r
  35         //! Get the processor speed in megahertz\r
  36         /** \param MHz The integer variable to store the speed in.\r
  37         \return True if successful, false if not */\r
  38         virtual bool getProcessorSpeedMHz(u32* MHz) const = 0;\r
  39 \r
  40         //! Get the total and available system RAM\r
  41         /** \param totalBytes: will contain the total system memory in bytes\r
  42         \param availableBytes: will contain the available memory in bytes\r
  43         \return True if successful, false if not */\r
  44         virtual bool getSystemMemory(u32* totalBytes, u32* availableBytes) const = 0;\r
  45 \r
  46 };\r
  47 \r
  48 } // end namespace\r
  49 \r
  50 #endif\r