minetest
/
irrlicht
mirror of https://github.com/minetest/irrlicht.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Unify documentation between IOSOperator and COSOperator

This commit is contained in:
Gregor Parzefall 2023-10-05 17:52:58 +02:00 committed by sfan5
parent 645b51a34d
commit 93eebed8c9
2 changed files with 18 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/IOSOperator.h
View File

@ -11,11 +11,11 @@
namespace irr namespace irr
{ {
//! The Operating system operator provides operation system specific methods and information. //! The OSOperator provides OS-specific methods and information.
class IOSOperator : public virtual IReferenceCounted class IOSOperator : public virtual IReferenceCounted
{ {
public: public:
//! Get the current operation system version as string. //! Get the current OS version as string.
virtual const core::stringc& getOperatingSystemVersion() const = 0; virtual const core::stringc& getOperatingSystemVersion() const = 0;
//! Copies text to the clipboard //! Copies text to the clipboard

26
source/Irrlicht/COSOperator.h
View File

@ -11,7 +11,7 @@ namespace irr
class CIrrDeviceLinux; class CIrrDeviceLinux;
//! The Operating system operator provides operation system specific methods and information. //! The OSOperator provides OS-specific methods and information.
class COSOperator : public IOSOperator class COSOperator : public IOSOperator
{ {
public: public:
@ -27,25 +27,31 @@ public:
COSOperator(const COSOperator &) = delete; COSOperator(const COSOperator &) = delete;
COSOperator &operator=(const COSOperator &) = delete; COSOperator &operator=(const COSOperator &) = delete;
//! returns the current operation system version as string. //! Get the current OS version as string.
const core::stringc& getOperatingSystemVersion() const override; const core::stringc& getOperatingSystemVersion() const override;
//! copies text to the clipboard //! Copies text to the clipboard
//! \param text: text in utf-8
void copyToClipboard(const c8 *text) const override; void copyToClipboard(const c8 *text) const override;
//! copies text to the primary selection //! Copies text to the primary selection
//! This is a no-op on some platforms.
//! \param text: text in utf-8
void copyToPrimarySelection(const c8 *text) const override; void copyToPrimarySelection(const c8 *text) const override;
//! gets text from the clipboard //! Get text from the clipboard
//! \return Returns 0 if no string is in there, otherwise an utf-8 string.
const c8* getTextFromClipboard() const override; const c8* getTextFromClipboard() const override;
//! gets text from the primary selection //! Get text from the primary selection
//! This is a no-op on some platforms.
//! \return Returns 0 if no string is in there, otherwise an utf-8 string.
const c8* getTextFromPrimarySelection() const override; const c8* getTextFromPrimarySelection() const override;
//! gets the total and available system RAM in kB //! Get the total and available system RAM
//! \param Total: will contain the total system memory /** \param totalBytes: will contain the total system memory in Kilobytes (1024 B)
//! \param Avail: will contain the available memory \param availableBytes: will contain the available memory in Kilobytes (1024 B)
//! \return Returns true if successful, false if not \return True if successful, false if not */
bool getSystemMemory(u32* Total, u32* Avail) const override; bool getSystemMemory(u32* Total, u32* Avail) const override;
private: private: