xsi_preferences.h

Go to the documentation of this file.

//*****************************************************************************
//*****************************************************************************

#if (_MSC_VER > 1000) || defined(SGI_COMPILER)
#pragma once
#endif

#ifndef __XSIPREFERENCES_H__
#define __XSIPREFERENCES_H__

#include <xsi_value.h>
#include <xsi_siobject.h>

namespace XSI {

//*****************************************************************************
//*****************************************************************************
class SICPPSDKDECL Preferences : public SIObject
{
public:
    Preferences();

    ~Preferences();

    Preferences(const CRef& in_ref);

    Preferences(const Preferences& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    Preferences& operator=(const Preferences& in_obj);

    Preferences& operator=(const CRef& in_ref);

    CRefArray GetCategories( ) const;

    CStatus GetPreferenceValue( const CString &in_sPrefName, CValue &out_value);

    CStatus SetPreferenceValue( const CString &in_sPrefName, const CValue &in_value);

    CStatus Import( const CString &in_sFile );

    CStatus Export( const CString &in_sFile, const CString &in_sCategories );

    CStatus RestoreDefault( const CString &in_sPrefName );

    private:
    Preferences * operator&() const;
    Preferences * operator&();
};

};

#endif // __XSIPREFERENCES_H__