DELLiveInfraU5Itf DELLiveInfraBrowserData

Usage: you must use this class as is. You should never derive it.

public class DELLiveInfraBrowserData

Class used to manage information needed to define a browser tab in the immersive browser.
Role: This class is used by browser agents to provide the information needed to populate a browser tab in Live Simulation environment.

Constructor and Destructor Index


o DELLiveInfraBrowserData()
Constructs a DELLiveInfraBrowserData object.
o ~DELLiveInfraBrowserData()

Method Index


o operator !=(DELLiveInfraBrowserData&)
Defines the operator !=.
o operator ==(DELLiveInfraBrowserData&)
Defines the operator ==.

Enumerated Type Index


o DEL_LI_Display
Flags used to define the default display mode to be used in the browser tab (in order: Display Thumbnails, or Display Text).
o DEL_LI_Modes
Flags used to define the browser behavior (in order: supports single-select, multi-select, listens to CSO events, supports double-clicks on thumbnails, supports right-mouse clicks on thumbnails, displays tooltips for thumbnails).
o DEL_LI_Show
Flags used to hide the "Arrange By.
o DEL_LI_Sort
Flags used to define the thumbnails' sorting order (in order: by Name, by Owner, by Type, by Active status, or no sorting).

Data Member Index


o _BGColor
Background Color for thumbnails (should contain RGBA information).
o _BrowserID
ID of the browser tab.
o _BrowserIcon
Icon displayed on the browser tab (16x16 png file located in CNext\resources\graphic\icons).
o _BrowserName
Name of the browser tab.
o _IsPrimary
TRUE if this structure defines the browser settings.
o _ObjectCreationCmdGroups
Command grouping information.
o _ObjectCreationCmdHeaders
Command headers displayed in the contextual menu of the browser tab.
o _ObjectCreationCmdIcons
Icons to be used for the commands in contextual menu.
o _ObjectCreationCmdLabels
Display names to be used for the commands in contextual menu.
o _Priority
Priority of the browser - lower priority = browser displayed more to the left side.
o _SettingsBitFlags
Settings for browser (bitmask composed from one or more of flags defined in the DEL_LI* enums above).
o _StampOwnerList
List of pointers to owners of the thumbnails that will be displayed in the browser tab.
o _StampStatusList
List of pointers to status of the thumbnails that will be displayed in the browser tab (new, deleted, modified, same).

Constructor and Destructor


o DELLiveInfraBrowserData
public DELLiveInfraBrowserData()
Constructs a DELLiveInfraBrowserData object.
o ~DELLiveInfraBrowserData
public virtual ~DELLiveInfraBrowserData()

Methods


o operator !=
public virtual operator !=( const iTab)
Defines the operator !=.
o operator ==
public virtual operator ==( const iTab)
Defines the operator ==.

Enumerated Types


o DEL_LI_Display 
enum DEL_LI_Display {
  DEL_LI_Thumbnail,
  DEL_LI_Text
}
Flags used to define the default display mode to be used in the browser tab (in order: Display Thumbnails, or Display Text). They are mutually exclusive, only one should be used.
o DEL_LI_Modes 
enum DEL_LI_Modes {
  DEL_LI_SingleSelect,
  DEL_LI_MultiSelect,
  DEL_LI_UseCSO,
  DEL_LI_DoubleClickStamp,
  DEL_LI_RightClickStamp,
  DEL_LI_UseToolTips
}
Flags used to define the browser behavior (in order: supports single-select, multi-select, listens to CSO events, supports double-clicks on thumbnails, supports right-mouse clicks on thumbnails, displays tooltips for thumbnails). One or more may be used (first two are mutually exclusive).
o DEL_LI_Show 
enum DEL_LI_Show {
  DEL_LI_HideName,
  DEL_LI_HideOwner,
  DEL_LI_HideType,
  DEL_LI_HideActive
}
Flags used to hide the "Arrange By..." buttons on the browser tab (in order: ... Name, ... Owner, ...Type, ... Active status). One or more may be used.
o DEL_LI_Sort 
enum DEL_LI_Sort {
  DEL_LI_SortName,
  DEL_LI_SortOwner,
  DEL_LI_SortType,
  DEL_LI_SortActive,
  DEL_LI_SortNone
}
Flags used to define the thumbnails' sorting order (in order: by Name, by Owner, by Type, by Active status, or no sorting). They are mutually exclusive, only one should be used.

Data Members
o _BGColor 
  public int _BGColor
Background Color for thumbnails (should contain RGBA information).
o _BrowserID 
  public CATString _BrowserID
ID of the browser tab.
o _BrowserIcon 
  public CATUnicodeString _BrowserIcon
Icon displayed on the browser tab (16x16 png file located in CNext\resources\graphic\icons).
o _BrowserName 
  public CATUnicodeString _BrowserName
Name of the browser tab.
o _IsPrimary 
  public CATBoolean _IsPrimary
TRUE if this structure defines the browser settings.
o _ObjectCreationCmdGroups 
  public CATListOfInt _ObjectCreationCmdGroups
Command grouping information.
o _ObjectCreationCmdHeaders 
  public CATListOfCATUnicodeString _ObjectCreationCmdHeaders
Command headers displayed in the contextual menu of the browser tab.
o _ObjectCreationCmdIcons 
  public CATListOfCATUnicodeString _ObjectCreationCmdIcons
Icons to be used for the commands in contextual menu.
o _ObjectCreationCmdLabels 
  public CATListOfCATUnicodeString _ObjectCreationCmdLabels
Display names to be used for the commands in contextual menu.
o _Priority 
  public unsigned int _Priority
Priority of the browser - lower priority = browser displayed more to the left side.
o _SettingsBitFlags 
  public unsigned int _SettingsBitFlags
Settings for browser (bitmask composed from one or more of flags defined in the DEL_LI* enums above).
o _StampOwnerList 
  public CATListValCATBaseUnknown_var _StampOwnerList
List of pointers to owners of the thumbnails that will be displayed in the browser tab.
o _StampStatusList 
  public CATListOfInt _StampStatusList
List of pointers to status of the thumbnails that will be displayed in the browser tab (new, deleted, modified, same). The values added to this list must be of type DELLiveInfraStampStatus (DEL_LS_NewStamp, DEL_LS_DeleteStamp, DEL_LS_ModifyStamp, DEL_LS_SameStamp).
This object is included in the file: DELLiveInfraBrowserData.h
If needed, your Imakefile.mk should include the module: DELLiveInfraU5Itf

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.