UI Configuration

Functions
UICONFIG_API int	UICONFIG_ask_column_configurations (tag_t client_scope, int *column_config_count, tag_t **column_configs)
UICONFIG_API int	UICONFIG_ask_column_definitions (tag_t column_config, logical query_by_scope, tag_t scope, int *column_def_count, char ***object_type_names, char ***property_names, int **pixel_widths, int *sort_by_column_def_index, char **sort_direction)
UICONFIG_API int	UICONFIG_save_column_configuration (tag_t scope, tag_t client_scope, const char *column_config_id, int column_def_count, const char **object_type_names, const char **property_names, const int *pixel_widths, int sort_by_column_def_index, const char *sort_direction)

Detailed Description

Teamcenter has implemented UI Configuration functions that allows users to customize the UI of clients (Active Workspace Client, Rich Client, etc.)

Teamcenter makes use of this mechanism itself, and it also provides ITK level functions for programmers to make use of the same UI Configuration mechanism.

Note

Teamcenter may alter or obsolete UI Configuration codes as the product evolves. These changes will be documented in the Release Notes.

The ITK UI Configuration functions include:

• Functions to query the UI configuration.
• Functions to save the UI configuration

To use these functions, include uiconfig_itk.h.

Function Documentation

UICONFIG_API int UICONFIG_ask_column_configurations	(	tag_t	client_scope,
		int *	column_config_count,
		tag_t **	column_configs
	)

Queries the column configs for a client scope

Returns

• ITK_ok on success
• UICONFIG_no_such_client_scope_uri, if the client scope URI does not exist

Parameters

client_scope	(I) Client scope Tag
column_config_count	(O) Number of column definition
column_configs	(OF) column_config_count Column configuration Tags

UICONFIG_API int UICONFIG_ask_column_definitions	(	tag_t	column_config,
		logical	query_by_scope,
		tag_t	scope,
		int *	column_def_count,
		char ***	object_type_names,
		char ***	property_names,
		int **	pixel_widths,
		int *	sort_by_column_def_index,
		char **	sort_direction
	)

Queries the column definitions

Returns

• ITK_ok on success
• POM_invalid_tag if column configuration tag or scope tag is invalid

Parameters

column_config	(I) Column configuration Tag
query_by_scope	(I) TRUE if query by passed in scope, FALSE if query by login user
scope	(I) Scope tag if queryByScope is TRUE
column_def_count	(O) Number of column definitions
object_type_names	(OF) column_def_count Type names of Fnd0ColumnDef objects. The array is packed, which means that the memory is deallocated by calling MEM_free on the container only.
property_names	(OF) column_def_count Property names of Fnd0ColumnDef objects. The array is packed, which means that the memory is deallocated by calling MEM_free on the container only.
pixel_widths	(OF) column_def_count Pixel width of Fnd0ColumnDef objects
sort_by_column_def_index	(O) Index of Fnd0ColumnDef object to sort by
sort_direction	(OF) Sort direction. Values can are Ascending and Descending

UICONFIG_API int UICONFIG_save_column_configuration	(	tag_t	scope,
		tag_t	client_scope,
		const char *	column_config_id,
		int	column_def_count,
		const char **	object_type_names,
		const char **	property_names,
		const int *	pixel_widths,
		int	sort_by_column_def_index,
		const char *	sort_direction
	)

Creates the Fnd0ColumnConfig and its Fnd0ColumnDef objects if they do not exist, and update those object if they exist

Returns

• ITK_ok on success
• UICONFIG_invalid_column_config_id if the column configuration Id is invalid
• UICONFIG_invalid_column_def_id if the column definition Id is invalid
• UICONFIG_invalid_object_type_name if the object type name is invalid
• UICONFIG_invalid_property_name if the property name is invalid
• UICONFIG_invalid_pixel_width if the pixel width is invalid
• UICONFIG_invalid_sort_by_column if the sort by column is invalid
• UICONFIG_invalid_sort_direction if the sort direction is invalid
• UICONFIG_different_object_type_name if the object type name is different from the object type name of the column definition
• UICONFIG_different_property_name if the property name is different from the property name of the column definition

Parameters

scope	(I) Tag of scope ( user, role or group, NULLTAG if site scope )
client_scope	(I) Tag of Fnd0ClientScope object that the Fnd0ColumnConfig object should be attached to
column_config_id	(I) Column configuration Id
column_def_count	(I) Number of columnDef
object_type_names	(I) Object type names of column definitions
property_names	(I) Property names of column definitions
pixel_widths	(I) Pixel widths of column definitions
sort_by_column_def_index	(I) Index of column to sort by
sort_direction	(I) Sort direction, valid values are Ascending and Descending