xsi_griddata.h

Go to the documentation of this file.

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

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

#ifndef __XSIGRIDDATA_H__
#define __XSIGRIDDATA_H__

#include <xsi_base.h>
#include <xsi_ppgitem.h>
#include <xsi_value.h>
#include <xsi_bitarray.h>

namespace XSI {
struct CColor ;
//*****************************************************************************
//*****************************************************************************

class GridWidget ;

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

    ~GridData();

    GridData(const CRef& in_ref);

    GridData(const GridData& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    GridData& operator=(const GridData& in_obj);

    GridData& operator=(const CRef& in_ref);

    CValueArray GetData() const;

    CStatus PutData( const CValueArray& in_items ) ;

    CStatus PutColumnCount( LONG in_val );

    LONG GetColumnCount() const ;

    CStatus PutRowCount( LONG in_val ) ;

    LONG GetRowCount() const ;

    CStatus PutCell(LONG in_Column, LONG in_Row, const CValue& in_CellValue);

    CStatus PutCell(const CString& in_ColumnLabel, const CString& in_RowLabel, const CValue& in_CellValue);

    CValue GetCell(LONG in_Column, LONG in_Row) const;

    CValue GetCell(const CString& in_ColumnLabel, const CString& in_RowLabel) const;
    CStatus PutColumnValues( LONG in_Column, const CValueArray & in_ColumnItems );
    CStatus PutColumnValues( const CString& in_ColumnLabel, const CValueArray & in_ColumnItems );

    CValueArray GetColumnValues(LONG in_Column ) const ;

    CValueArray GetColumnValues(const CString& in_ColumnLabel ) const ;

    CStatus PutRowValues( LONG in_Row, const CValueArray & in_RowItems );

    CStatus PutRowValues( const CString& in_RowLabel, const CValueArray & in_RowItems );

    CValueArray GetRowValues(LONG in_Row ) const ;

    CValueArray GetRowValues(const CString& in_RowLabel ) const ;

    CStatus PutRowLabel(LONG in_RowIndex, const CString& in_RowLabel );

    CString GetRowLabel(LONG in_RowIndex) const;

    CStatus PutColumnLabel(LONG in_ColumnIndex, const CString& in_ColumnLabel);

    CString GetColumnLabel(LONG in_ColumnIndex) const;

    CStatus BeginEdit();

    CStatus EndEdit();

    CStatus PutColumnType(LONG in_ColumnIndex, siGridWidgetColumnType in_Type );

    siGridWidgetColumnType GetColumnType( LONG in_ColumnIndex ) const;

    CStatus PutColumnComboItems(LONG in_ColumnIndex, const CValueArray& in_Items);

    CValueArray GetColumnComboItems(LONG in_ColumnIndex);

    GridWidget GetGridWidget() ;

    CStatus SetRowBackgroundColor( LONG in_Row, const CColor &in_Color );

    CColor GetRowBackgroundColor(LONG in_Row );

    CStatus SetIntColumnDef( LONG in_lColumnIndex, LONG in_lMin = INT_MIN, LONG in_lMax = INT_MAX, LONG in_lInc = 1 );

    CStatus GetIntColumnDef( LONG in_lColumnIndex, LONG &out_lMin, LONG &out_lMax, LONG &out_lInc ) const;

    CStatus SetFloatColumnDef( LONG in_lColumnIndex, double in_dMin = DBL_MIN, double in_dMax = DBL_MAX, double in_dInc = 1.0, short in_sDecimal = 2 ) ;

    CStatus GetFloatColumnDef( LONG in_lColumnIndex, double &out_dMin, double &out_dMax, double &out_dInc, short &out_sDecimal ) const;

    CStatus SetVectorColumnDef( LONG in_lColumnIndex, short in_sVectorSize, double in_dMin = DBL_MIN, double in_dMax = DBL_MAX, double in_dInc = 1.0, short in_sDecimal = 2 ) ;

    CStatus GetVectorColumnDef( LONG in_lColumnIndex, short &out_sVectorSize, double &out_dMin, double &out_dMax, double &out_dInc, short &out_sDecimal ) const;

    CStatus SetFileColumnDef( LONG in_lColumnIndex, const CString &in_csBrowseType = "File", const CString &in_csStartupPath = "/", const CString &in_csFilter = ".*" ) ;

    CStatus GetFileColumnDef( LONG in_lColumnIndex, CString& out_csBrowseType, CString& out_csStartupPath, CString& out_csFilter ) const;

    CStatus SetShaderBallColumnDef( LONG in_lColumnIndex, LONG in_lThumbnailSize = 28 ) ;

    CStatus GetShaderBallColumnDef( LONG in_lColumnIndex, LONG &out_lThumbnailSize ) const;

    CStatus SetImageClipColumnDef( LONG in_lColumnIndex, LONG in_lThumbnailSize = 28 );

    CStatus GetImageClipColumnDef( LONG in_lColumnIndex, LONG &out_lThumbnailSize ) const;

    CStatus InsertRow( LONG in_lRowIndex ) ;

    CStatus RemoveRow( LONG in_lRowIndex ) ;

    CStatus InsertColumn( LONG in_lColumnIndex ) ;

    CStatus RemoveColumn( LONG in_lColumnIndex ) ;

    CStatus SetCellBackgroundColor( LONG in_lCol, LONG in_lRow, const CColor &in_Color ) ;

    CColor GetCellBackgroundColor( LONG in_lCol, LONG in_lRow ) const ;

    CStatus SetColumnsVisibility( const CLongArray &in_alCols, bool in_bVisible ) ;

    CStatus SetRowsVisibility( const CLongArray &in_alRows, bool in_bVisible ) ;

    CStatus SetCellReadOnlyFlags( const CLongArray &in_alCells, bool in_bROFlag ) ;

    CStatus GetCellReadOnlyFlags( const CLongArray &in_alCells, CBitArray &out_aROFlags ) const;

    CStatus PutMultiSelectionMode( XSI::siGridDataMultiSelectionMode in_eSelectionMode ) ;

    XSI::siGridDataMultiSelectionMode GetMultiSelectionMode() const;

    CStatus PutReadOnly( bool in_bROFlag ) ;

    bool GetReadOnly() const;

private:

    GridData * operator&() const;
    GridData * operator&();
};

};
#endif // __XSIGRIDDATA_H__