xsi_ppglayout.h

Go to the documentation of this file.

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

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

#ifndef __XSIPPGLAYOUT_H__
#define __XSIPPGLAYOUT_H__

#include <xsi_base.h>
#include <xsi_ppgitem.h>
#include <xsi_value.h>
namespace XSI {

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

class SICPPSDKDECL PPGLayout : public CBase
{
public:
    PPGLayout();

    ~PPGLayout();

    PPGLayout(const CRef& in_ref);

    PPGLayout(const PPGLayout& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    PPGLayout& operator=(const PPGLayout& in_obj);

    PPGLayout& operator=(const CRef& in_ref);

    PPGItem AddItem(const CString& in_ParamName, const CString& in_Label = CString(), const CString& in_Type = CString());


    PPGItem AddString (const CString& in_ParamName, const CString& in_Label = CString(), bool in_Multiline = false, LONG in_Height = 120);

    PPGItem AddEnumControl (const CString& in_ParamName, const CValueArray& in_UIItemsArray, const CString& in_Label = CString(), const CString& in_UIType = CString(L"Combo"));

    PPGItem AddColor (const CString& in_RedComponentParamName, const CString& in_Label = CString(), bool in_Alpha = false );

    PPGItem AddButton (const CString& in_ScriptName, const CString& in_Label = CString() );

    PPGItem AddFCurve (const CString& in_ScriptName, LONG in_Height = 300 ) ;


    PPGItem AddStaticText (const CString& in_Text, LONG in_Width = 0, LONG in_Height = 0 ) ;

    PPGItem AddSpacer ( LONG in_Width = 0, LONG in_Height = 0 ) ;

    CStatus Clear ();
    CStatus Delete ();

    CStatus AddRow ();

    CStatus EndRow ();

    PPGItem AddGroup (const CString& in_Label = CString(), bool in_ShowFrame = true, LONG in_WidthPercentage = 0 );

    PPGItem EndGroup ();

    PPGItem AddTab (const CString& in_Label);

    CStatus SetViewPosition (LONG in_posX, LONG in_posY);

    CStatus GetViewPosition(LONG& out_posX, LONG& out_posY) const;

    CStatus SetViewSize( LONG in_width, LONG in_height );

    CStatus GetViewSize( LONG& out_width, LONG& out_height ) const;

    CString GetLogic () const;

    CStatus PutLogic ( const CString& in_strLogic );

    CString GetLanguage () const;

    CStatus PutLanguage ( const CString& in_strLogicLang );

    CStatus PutAttribute ( const CString& in_UIAttribute, const CValue & in_AttributeValue );

    CValue GetAttribute ( const CString& in_UIAttribute ) const;

    PPGItem GetItem( const CString& in_Name ) const;

    PPGItem GetItem( LONG in_Index ) const;

    LONG GetCount() const;


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

};
#endif // __XSIPPGLAYOUT_H__