xsi_ppglayout.h Source File
 
 
 
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 
00483         CStatus SetViewPosition (LONG in_posX, LONG in_posY);
00484 
00510         CStatus GetViewPosition(LONG& out_posX, LONG& out_posY) const;
00511 
00544         CStatus SetViewSize( LONG in_width, LONG in_height );
00545 
00571         CStatus GetViewSize( LONG& out_width, LONG& out_height ) const;
00572 
00579         CString GetLogic () const;
00580 
00609         CStatus PutLogic ( const CString& in_strLogic );
00610 
00617         CString GetLanguage () const;
00618 
00626         CStatus PutLanguage ( const CString& in_strLogicLang );
00627 
00635         CStatus PutAttribute ( const CString& in_UIAttribute, const CValue & in_AttributeValue );
00636 
00652         CValue GetAttribute ( const CString& in_UIAttribute ) const;
00653 
00661         PPGItem GetItem( const CString& in_Name ) const;
00662 
00668         PPGItem GetItem( LONG in_Index ) const;
00669 
00675         LONG GetCount() const;
00676 
00677 
00678         private:
00679         PPGLayout * operator&() const;
00680         PPGLayout * operator&();
00681 };
00682 
00683 };
00684 #endif // __XSIPPGLAYOUT_H__