SqMod/source/Misc/Sound.hpp

#ifndef _MISC_SOUND_HPP_
#define _MISC_SOUND_HPP_

// ------------------------------------------------------------------------------------------------
#include "Common.hpp"

// ------------------------------------------------------------------------------------------------
namespace SqMod {

/* ------------------------------------------------------------------------------------------------
 * ...
*/
class CSound
{
public:

    /* --------------------------------------------------------------------------------------------
     * ...
    */
    CSound() noexcept;

    /* --------------------------------------------------------------------------------------------
     * ...
    */
    CSound(SQInt32 id) noexcept;

    /* --------------------------------------------------------------------------------------------
     * ...
    */
    CSound(const CSound & x) noexcept;

    /* --------------------------------------------------------------------------------------------
     * ...
    */
    CSound(CSound && x) noexcept;

    /* --------------------------------------------------------------------------------------------
     * ...
    */
    ~CSound();

    /* --------------------------------------------------------------------------------------------
     * ...
    */
    CSound & operator= (const CSound & x) noexcept;

    /* --------------------------------------------------------------------------------------------
     * ...
    */
    CSound & operator= (CSound && x) noexcept;

    /* --------------------------------------------------------------------------------------------
     * ...
    */
    CSound operator+ (const CSound & x) const noexcept;

    /* --------------------------------------------------------------------------------------------
     * ...
    */
    CSound operator- (const CSound & x) const noexcept;

    /* --------------------------------------------------------------------------------------------
     * ...
    */
    CSound operator* (const CSound & x) const noexcept;

    /* --------------------------------------------------------------------------------------------
     * ...
    */
    CSound operator/ (const CSound & x) const noexcept;

    /* --------------------------------------------------------------------------------------------
     * ...
    */
    bool operator == (const CSound & x) const noexcept;

    /* --------------------------------------------------------------------------------------------
     * ...
    */
    bool operator != (const CSound & x) const noexcept;

    /* --------------------------------------------------------------------------------------------
     * ...
    */
    bool operator < (const CSound & x) const noexcept;

    /* --------------------------------------------------------------------------------------------
     * ...
    */
    bool operator > (const CSound & x) const noexcept;

    /* --------------------------------------------------------------------------------------------
     * ...
    */
    bool operator <= (const CSound & x) const noexcept;

    /* --------------------------------------------------------------------------------------------
     * ...
    */
    bool operator >= (const CSound & x) const noexcept;

    /* --------------------------------------------------------------------------------------------
     * ...
    */
    SQInteger Cmp(const CSound & x) const noexcept;

    /* --------------------------------------------------------------------------------------------
     * ...
    */
    operator SQInt32 () const noexcept;

    /* --------------------------------------------------------------------------------------------
     * ...
    */
    operator bool () const noexcept;

    /* --------------------------------------------------------------------------------------------
     * ...
    */
    SQInt32 GetID() const noexcept;

    /* --------------------------------------------------------------------------------------------
     * ...
    */
    void SetID(SQInt32 id) noexcept;

    /* --------------------------------------------------------------------------------------------
     * ...
    */
    void Play() const noexcept;

protected:

    /* --------------------------------------------------------------------------------------------
     * ...
    */
    SQInt32 m_ID;
};

} // Namespace:: SqMod

#endif // _MISC_SOUND_HPP_
Initial commit. 2015-09-30 02:56:11 +02:00			`#ifndef _MISC_SOUND_HPP_`
			`#define _MISC_SOUND_HPP_`

			`// ------------------------------------------------------------------------------------------------`
			`#include "Common.hpp"`

			`// ------------------------------------------------------------------------------------------------`
			`namespace SqMod {`

Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00			`/* ------------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`class CSound`
			`{`
			`public:`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
			`/* --------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`CSound() noexcept;`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
			`/* --------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`CSound(SQInt32 id) noexcept;`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
			`/* --------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`CSound(const CSound & x) noexcept;`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
			`/* --------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`CSound(CSound && x) noexcept;`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
			`/* --------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`~CSound();`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
			`/* --------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`CSound & operator= (const CSound & x) noexcept;`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
			`/* --------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`CSound & operator= (CSound && x) noexcept;`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
			`/* --------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`CSound operator+ (const CSound & x) const noexcept;`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
			`/* --------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`CSound operator- (const CSound & x) const noexcept;`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
			`/* --------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`CSound operator* (const CSound & x) const noexcept;`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
			`/* --------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`CSound operator/ (const CSound & x) const noexcept;`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
			`/* --------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`bool operator == (const CSound & x) const noexcept;`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
			`/* --------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`bool operator != (const CSound & x) const noexcept;`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
			`/* --------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`bool operator < (const CSound & x) const noexcept;`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
			`/* --------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`bool operator > (const CSound & x) const noexcept;`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
			`/* --------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`bool operator <= (const CSound & x) const noexcept;`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
			`/* --------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`bool operator >= (const CSound & x) const noexcept;`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
			`/* --------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`SQInteger Cmp(const CSound & x) const noexcept;`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
			`/* --------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`operator SQInt32 () const noexcept;`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
			`/* --------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`operator bool () const noexcept;`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
			`/* --------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`SQInt32 GetID() const noexcept;`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
			`/* --------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`void SetID(SQInt32 id) noexcept;`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
			`/* --------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`void Play() const noexcept;`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
Initial commit. 2015-09-30 02:56:11 +02:00			`protected:`
Prepared various miscellaneous types for documentation. 2015-10-29 21:59:35 +01:00
			`/* --------------------------------------------------------------------------------------------`
			`* ...`
			`*/`
Initial commit. 2015-09-30 02:56:11 +02:00			`SQInt32 m_ID;`
			`};`

			`} // Namespace:: SqMod`

			`#endif // _MISC_SOUND_HPP_`