xsi_ppglayout.h

Go to the documentation of this file.
00001 //*****************************************************************************
00011 //*****************************************************************************
00012 
00013 #if (_MSC_VER > 1000) || defined(SGI_COMPILER)
00014 #pragma once
00015 #endif
00016 
00017 #ifndef __XSIPPGLAYOUT_H__
00018 #define __XSIPPGLAYOUT_H__
00019 
00020 #include <xsi_base.h>
00021 #include <xsi_ppgitem.h>
00022 #include <xsi_value.h>
00023 namespace XSI {
00024 
00025 //*****************************************************************************
00152 //*****************************************************************************
00153 
00154 class SICPPSDKDECL PPGLayout : public CBase
00155 {
00156 public:
00158     PPGLayout();
00159 
00161     ~PPGLayout();
00162 
00166     PPGLayout(const CRef& in_ref);
00167 
00171     PPGLayout(const PPGLayout& in_obj);
00172 
00177     bool IsA( siClassID in_ClassID) const;
00178 
00182     siClassID GetClassID() const;
00183 
00188     PPGLayout& operator=(const PPGLayout& in_obj);
00189 
00195     PPGLayout& operator=(const CRef& in_ref);
00196 
00225     PPGItem AddItem(const CString& in_ParamName, const CString& in_Label = CString(), const CString& in_Type = CString());
00226 
00227 
00273     PPGItem AddString (const CString& in_ParamName, const CString& in_Label = CString(), bool in_Multiline = false, LONG in_Height = 120);
00274 
00293     PPGItem AddEnumControl (const CString& in_ParamName, const CValueArray& in_UIItemsArray, const CString& in_Label = CString(), const CString& in_UIType = CString(L"Combo"));
00294 
00320     PPGItem AddColor (const CString& in_RedComponentParamName, const CString& in_Label = CString(), bool in_Alpha = false );
00321 
00334     PPGItem AddButton (const CString& in_ScriptName, const CString& in_Label = CString() );
00335 
00349     PPGItem AddFCurve (const CString& in_ScriptName, LONG in_Height = 300 ) ;
00350 
00351 
00369     PPGItem AddStaticText (const CString& in_Text, LONG in_Width = 0, LONG in_Height = 0 ) ;
00370 
00382     PPGItem AddSpacer ( LONG in_Width = 0, LONG in_Height = 0 ) ;
00383 
00390     CStatus Clear ();
00396     CStatus Delete ();
00397 
00407     CStatus AddRow ();
00408 
00412     CStatus EndRow ();
00413 
00431     PPGItem AddGroup (const CString& in_Label = CString(), bool in_ShowFrame = true, LONG in_WidthPercentage = 0 );
00432 
00436     PPGItem EndGroup ();
00437 
00450     PPGItem AddTab (const CString& in_Label);
00451 
00458     CString GetLogic () const;
00459 
00488     CStatus PutLogic ( const CString& in_strLogic );
00489 
00496     CString GetLanguage () const;
00497 
00505     CStatus PutLanguage ( const CString& in_strLogicLang );
00506 
00514     CStatus PutAttribute ( const CString& in_UIAttribute, const CValue & in_AttributeValue );
00515 
00531     CValue GetAttribute ( const CString& in_UIAttribute ) const;
00532 
00540     PPGItem GetItem( const CString& in_Name ) const;
00541 
00547     PPGItem GetItem( LONG in_Index ) const;
00548 
00554     LONG GetCount() const;
00555 
00556 
00557     private:
00558     PPGLayout * operator&() const;
00559     PPGLayout * operator&();
00560 };
00561 
00562 };
00563 #endif // __XSIPPGLAYOUT_H__