prop.h File Reference

#include <pom/pom/pom_tokens.h>
#include <unidefs.h>
#include <property/propdesc.h>
#include <property/prop_msg.h>
#include <property/libproperty_exports.h>
#include <property/libproperty_undef.h>

Go to the source code of this file.

Macros
#define	PROP_DISPLAY_ACTUAL_NAMES   2
#define	PROP_DISPLAY_PRESENTATION_NAMES   1
#define	PROP_NAME_DISPLAY_PREF   "PROP_Show_Actual_Names"

Functions
PROPERTY_API int	PROP_ask_descriptor (tag_t prop_tag, tag_t *prop_desc_tag)
PROPERTY_API int	PROP_ask_lov (tag_t prop_tag, tag_t *lov_tag)
PROPERTY_API int	PROP_ask_num_elements (tag_t prop_tag, int *num_elem)
PROPERTY_API int	PROP_ask_owning_object (tag_t prop_tag, tag_t *obj_tag)
PROPERTY_API int	PROP_ask_property_by_name (tag_t object_tag, const char *prop_name, tag_t *prop_tag)
PROPERTY_API int	PROP_ask_value_char (tag_t prop_tag, char *value)
PROPERTY_API int	PROP_ask_value_char_at (tag_t prop_tag, int position, char *value)
PROPERTY_API int	PROP_ask_value_chars (tag_t prop_tag, int *num, char **values)
PROPERTY_API int	PROP_ask_value_date (tag_t prop_tag, date_t *value)
PROPERTY_API int	PROP_ask_value_date_at (tag_t prop_tag, int position, date_t *value)
PROPERTY_API int	PROP_ask_value_dates (tag_t prop_tag, int *num, date_t **values)
PROPERTY_API int	PROP_ask_value_double (tag_t prop_tag, double *value)
PROPERTY_API int	PROP_ask_value_double_at (tag_t prop_tag, int position, double *value)
PROPERTY_API int	PROP_ask_value_doubles (tag_t prop_tag, int *num, double **values)
PROPERTY_API int	PROP_ask_value_int (tag_t prop_tag, int *value)
PROPERTY_API int	PROP_ask_value_int_at (tag_t prop_tag, int position, int *value)
PROPERTY_API int	PROP_ask_value_ints (tag_t prop_tag, int *num, int **values)
PROPERTY_API int	PROP_ask_value_logical (tag_t prop_tag, logical *value)
PROPERTY_API int	PROP_ask_value_logical_at (tag_t prop_tag, int position, logical *value)
PROPERTY_API int	PROP_ask_value_logicals (tag_t prop_tag, int *num, logical **values)
PROPERTY_API int	PROP_ask_value_string (tag_t prop_tag, char **value)
PROPERTY_API int	PROP_ask_value_string_at (tag_t prop_tag, int position, char **value)
PROPERTY_API int	PROP_ask_value_strings (tag_t prop_tag, int *num, char ***values)
PROPERTY_API int	PROP_ask_value_tag (tag_t prop_tag, tag_t *value)
PROPERTY_API int	PROP_ask_value_tag_at (tag_t prop_tag, int position, tag_t *value)
PROPERTY_API int	PROP_ask_value_tags (tag_t prop_tag, int *num, tag_t **values)
PROPERTY_API int	PROP_is_modifiable (tag_t prop_tag, logical *mod_flag)
PROPERTY_API int	PROP_list_properties (tag_t object_tag, int *num, tag_t **prop_tags)
PROPERTY_API int	PROP_set_value_char (tag_t prop_tag, char value)
PROPERTY_API int	PROP_set_value_char_at (tag_t prop_tag, int position, char value)
PROPERTY_API int	PROP_set_value_chars (tag_t prop_tag, int num, const char *values)
PROPERTY_API int	PROP_set_value_date (tag_t prop_tag, date_t value)
PROPERTY_API int	PROP_set_value_date_at (tag_t prop_tag, int position, date_t value)
PROPERTY_API int	PROP_set_value_dates (tag_t prop_tag, int num, const date_t *values)
PROPERTY_API int	PROP_set_value_double (tag_t prop_tag, double value)
PROPERTY_API int	PROP_set_value_double_at (tag_t prop_tag, int position, double value)
PROPERTY_API int	PROP_set_value_doubles (tag_t prop_tag, int num, const double *values)
PROPERTY_API int	PROP_set_value_int (tag_t prop_tag, int value)
PROPERTY_API int	PROP_set_value_int_at (tag_t prop_tag, int position, int value)
PROPERTY_API int	PROP_set_value_ints (tag_t prop_tag, int num, const int *values)
PROPERTY_API int	PROP_set_value_logical (tag_t prop_tag, logical value)
PROPERTY_API int	PROP_set_value_logical_at (tag_t prop_tag, int position, logical value)
PROPERTY_API int	PROP_set_value_logicals (tag_t prop_tag, int num, const logical *values)
PROPERTY_API int	PROP_set_value_string (tag_t prop_tag, const char *value)
PROPERTY_API int	PROP_set_value_string_at (tag_t prop_tag, int position, const char *value)
PROPERTY_API int	PROP_set_value_strings (tag_t prop_tag, int num, char **values)
PROPERTY_API int	PROP_set_value_tag (tag_t prop_tag, tag_t value)
PROPERTY_API int	PROP_set_value_tag_at (tag_t prop_tag, int position, tag_t value)
PROPERTY_API int	PROP_set_value_tags (tag_t prop_tag, int num, const tag_t *values)
Property functions that get their value from the Property Descriptor
There is a duplicate PROPDESC_ function for each of these.
PROPERTY_API int	PROP_ask_name (tag_t prop_tag, char **name)
PROPERTY_API int	PROP_ask_object_type (tag_t prop_tag, tag_t *type_tag)
PROPERTY_API int	PROP_ask_property_type (tag_t prop_tag, PROP_type_t *proptype, char **proptype_n)
PROPERTY_API int	PROP_ask_value_type (tag_t prop_tag, PROP_value_type_t *valtype, char **valtype_n)
PROPERTY_API int	PROP_ask_max_num_elements (tag_t prop_tag, int *maxnumelem)
PROPERTY_API int	PROP_ask_max_string_length (tag_t prop_tag, int *maxstrlen)
Properties User Interface
This section defines ITK to support specifically to support User Interface (UIF) functionality on properties.
PROPERTY_API int	PROP_UIF_ask_property_by_name (tag_t object_tag, const char *disp_name, tag_t *prop_tag)
PROPERTY_API int	PROP_UIF_ask_name (tag_t prop_tag, char **disp_name)
PROPERTY_API int	PROP_UIF_is_displayable (tag_t prop_tag, logical *is_display)
PROPERTY_API int	PROP_UIF_is_enabled (tag_t prop_tag, logical *is_enabled)
PROPERTY_API int	PROP_UIF_ask_value (tag_t prop_tag, char **d_value)
PROPERTY_API int	PROP_UIF_set_value (tag_t prop_tag, const char *value)
PROPERTY_API int	PROP_UIF_list_displayable_properties (tag_t object_tag, int *num, tag_t **prop_tags)
PROPERTY_API int	PROP_list_common_modifiable_properties (int object_count, tag_t *object_tags, int *prop_count, char ***prop_names)
PROPERTY_API int	PROP_is_property_localizable (tag_t object_tag, char *prop_name, logical *is_localizable)
PROPERTY_API int	PROP_ask_composite_property (tag_t component, const char *composite_property, char **value)
PROPERTY_API int	PROP_ask_composite_property_objs (tag_t component, const char *composite_property, int *n_related_components, tag_t **related_components)

Detailed Description

This file contains the ANSI C interface to Teamcenter Engineering properties

Definition in file prop.h.