xsi_command.h

Go to the documentation of this file.

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

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

#ifndef __XSICOMMAND_H__
#define __XSICOMMAND_H__

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

namespace XSI {

class ArgumentArray ; // Forward declaration

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

    ~Command();

    Command(const CRef& in_ref);

    Command(const Command& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    Command& operator=(const Command& in_obj);

    Command& operator=(const CRef& in_ref);

    ArgumentArray GetArguments() ;

    CString GetScriptingName() const ;

    CStatus PutScriptingName( const CString & in_Str ) ;

    CString GetHandler() ;

    CStatus PutHandler( const CString & ) ;

    CString GetLanguage() ;

    CStatus PutLanguage( const CString & ) ;

    CString GetFileName() ;

    CStatus PutFileName( const CString & ) ;

    CString GetCode() ;
    CStatus PutCode( const CString & ) ;

    bool IsReturnValueEnabled() ;

    CStatus EnableReturnValue( bool ) ;

    CString GetCategory(  ) ;

    CString GetDescription() ;

    CStatus PutDescription( const CString & ) ;

    CString GetTooltip() ;

    CStatus PutTooltip( const CString & ) ;

    CString GetUID() ;

    bool IsEnabled() ;

    CStatus PutEnabled( bool ) ;

    bool IsBuiltin() ;

    CStatus Execute( CValue& out_return ) ;

    bool GetFlag( LONG in_whichflag )  ;

    CStatus SetFlag( LONG in_whichflag, bool in_newvalue )  ;

    bool    SupportsKeyAssignment()  ;
    bool    CannotBeUsedInBatch() ;
    bool    IsNotLogged()  ;

    CStatus Update()  ;

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

//*****************************************************************************
class SICPPSDKDECL CommandArray : public CBase
{
    public:
    CommandArray();

    ~CommandArray();

    CommandArray(const CRef& in_ref);

    CommandArray(const CommandArray& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    CommandArray& operator=(const CommandArray& in_obj);

    CommandArray& operator=(const CRef& in_ref);

    Command GetItem( LONG in_index ) const;

    Command GetItem( const CString& in_name ) const;

    Command operator[]( LONG in_index );

    const Command operator[]( LONG in_index ) const;

    LONG GetCount() const;

    CommandArray Filter( CStringArray & in_keywords ) const ;

    CommandArray Filter( CString & in_keyword ) const ;
} ;

};

#endif // __XSICOMMAND_H__