就业培训     下载中心     Wiki     联络 登录   注册
  1. 首页
  2. C4D R23.110 C++ SDK
私有成员函数 | 所有成员列表

InExcludeData Class Reference

#include <customgui_inexclude.h>

Inheritance diagram for InExcludeData:
Inheritance graph
[ legend ]

详细描述

InExclude custom data type ( CUSTOMDATATYPE_INEXCLUDE_LIST ).

私有成员函数

  InExcludeData ()
  ~InExcludeData ()

对象

Bool   InsertObject ( BaseList2D *pObject, Int32 lFlags)
Bool   DeleteObject ( BaseDocument *doc, BaseList2D *pObject)
Bool   DeleteObject ( Int32 lIndex)
Int32   GetObjectIndex ( BaseDocument *doc, BaseList2D *pObject) const
BaseList2D *  ObjectFromIndex ( BaseDocument *doc, Int32 lIndex) const
Int32   GetObjectCount () const

Flags

Int32   GetFlags ( Int32 lIndex) const
void  SetFlags ( Int32 lIndex, Int32 lFlags)
Int32   GetFlags ( BaseDocument *doc, BaseList2D *pObject) const
Int32   GetFlagCount () const
void  SetFlagCount ( Int32 lFlagCount)
Int32   GetDefaultFlag () const
void  SetDefaultFlag ( Int32 defaultFlag)

数据

BaseContainer *  GetData ( Int32 lIndex) const
BaseContainer *  GetData ( BaseDocument *doc, BaseList2D *pObject) const

Inclusion Table

InclusionTable *  BuildInclusionTable ( BaseDocument *doc, Int32 hierarchy_bit= NOTOK )

构造函数 & 析构函数文档编制

◆  InExcludeData()

InExcludeData () private

◆  ~InExcludeData()

~ InExcludeData () private

成员函数文档编制

◆  InsertObject()

Bool InsertObject ( BaseList2D *  pObject ,
Int32   lFlags  
)

Inserts a link to pObject into the list.

注意
Sends MSG_DESCRIPTION_INEX_ADDED to the parent.
参数
[in] pObject The object to add to the list.
[in] lFlags A bit field for the initial selection state of pObject .
返回
true if successful, otherwise false .

◆  DeleteObject() [1/2]

Bool DeleteObject ( BaseDocument *  doc ,
BaseList2D *  pObject  
)

Removes pObject from the list.

注意
Sends MSG_DESCRIPTION_INEX_DELETED to the parent.
参数
[in] doc The document to evaluate the links in. The caller owns the pointed document.
[in] pObject The object to remove. The caller owns the pointed object.
返回
true if successful, otherwise false .

◆  DeleteObject() [2/2]

Bool DeleteObject ( Int32   lIndex )

Removes the object at index lIndex in the list.

注意
Sends MSG_DESCRIPTION_INEX_DELETED to the parent.
参数
[in] lIndex The object index: 0 <= lIndex < GetObjectCount()
返回
true if successful, otherwise false .

◆  GetObjectIndex()

Int32 GetObjectIndex ( BaseDocument *  doc ,
BaseList2D *  pObject  
) const

Gets the index of pObject in the list.

参数
[in] doc The document to evaluate the links in. The caller owns the pointed document.
[in] pObject The object to search for. The caller owns the pointed object.
返回
The object index, or NOTOK if it was not found.

◆  ObjectFromIndex()

BaseList2D * ObjectFromIndex ( BaseDocument *  doc ,
Int32   lIndex  
) const

Gets the object at index lIndex in the list.

参数
[in] doc The document to evaluate the links in. The caller owns the pointed document.
[in] lIndex The object index: 0 <= lIndex < GetObjectCount()
返回
The found object, or nullptr . The document owns the pointed object.

◆  GetObjectCount()

Int32 GetObjectCount ( ) const

Gets the number of objects in the list.

返回
The object count.

◆  GetFlags() [1/2]

Int32 GetFlags ( Int32   lIndex ) const

Gets the flags for the object at index lIndex in the list.

参数
[in] lIndex The object index: 0 <= lIndex < GetObjectCount()
返回
A bit field for the selection state of the object.

◆  SetFlags()

void SetFlags ( Int32   lIndex ,
Int32   lFlags  
)

Sets the flags for the object at index lIndex in the list.

参数
[in] lIndex The object index: 0 <= lIndex < GetObjectCount()
[in] lFlags A bit field for the selection state of the object.

◆  GetFlags() [2/2]

Int32 GetFlags ( BaseDocument *  doc ,
BaseList2D *  pObject  
) const

Gets the flags for pObject .

参数
[in] doc The document to evaluate the links in. The caller owns the pointed document.
[in] pObject The object to get the flags for. The caller owns the pointed object.
返回
A bit field for the selection state of the object.

◆  GetFlagCount()

Int32 GetFlagCount ( ) const

Gets the number of flags for each object.

由于
R18
返回
The number of flags for each object.

◆  SetFlagCount()

void SetFlagCount ( Int32   lFlagCount )

Sets the number of flags for each object.

由于
R18
参数
[in] lFlagCount The number of flags for each object.

◆  GetDefaultFlag()

Int32 GetDefaultFlag ( ) const

Gets the default flag for new items in the list.

由于
R18
返回
The default flag for new items in the list.

◆  SetDefaultFlag()

void SetDefaultFlag ( Int32   defaultFlag )

Gets the default flag for this list.

由于
R18
参数
[in] defaultFlag The default flag for new items in the list.

◆  GetData() [1/2]

BaseContainer * GetData ( Int32   lIndex ) const

Retrieves the data container for the object at index lIndex in the list.

参数
[in] lIndex The object index: 0 <= lIndex < GetObjectCount()
返回
The data container. See IN_EXCLUDE_DATA_SELECTION . The inexclude list owns the pointed container.

◆  GetData() [2/2]

BaseContainer * GetData ( BaseDocument *  doc ,
BaseList2D *  pObject  
) const

Retrieves the data container for pObject .

参数
[in] doc The document to evaluate the links in. The caller owns the pointed document.
[in] pObject The object to get the data for. The caller owns the pointed object.
返回
The data container. See IN_EXCLUDE_DATA_SELECTION . The inexclude list owns the pointed container.

◆  BuildInclusionTable()

InclusionTable * BuildInclusionTable ( BaseDocument *  doc ,
Int32   hierarchy_bit = NOTOK  
)

Builds an inclusion table for a specific bit.

参数
[in] doc The document to evaluate the links in. The caller owns the pointed document.
[in] hierarchy_bit The bit position to generate the table for.
返回
The inclusion table, or nullptr . The caller owns the pointed inclusion table.
Delete it afterward by calling FreeInclusionTable ( table ).