UF_DRF_custom_symbol_text_s (view source)
 
Defined in: uf_drf_types.h
 
Also known as:
 
Overview
This structure defines the text data for a custom symbol


Data Members

note_tag
tag_t
This is the tag of the note from which
this text will be based. This object
must be of type UF_drafting_entity_type
and subtype UF_draft_note_subtype

text_type
UF_DRF_custom_symbol_text_type_t
The type of text for this structure

title
char *
The title of this text field.
This title displays in the dialog
when creating the symbol.

min_value
double
This value is the lower bound for
UF_DRF_integer_text and UF_DRF_real_text
types. For integer text, this value is
truncated to an integer form. This value
has no meaning for arbitrary, controlled,
mandatory, or partially controlled text

max_value
double
This value is the upper bound for
UF_DRF_integer_text and UF_DRF_real_text
types. For integer text, this value is
truncated to an integer form. This value
has no meaning for arbitrary, controlled,
mandatory, or partially controlled text

current_value
double
This value is the current value defined for
this text object. This value only has
meaning for UF_DRF_real_text and
UF_DRF_integer_text types. For integer text,
this value is truncated to integer format.
This value must be greater than or equal to
min_value and less than or equal to max_value.

optional_strings
char * *
An array of strings in localized format describing
a list of strings for controlled and partially
controlled text.

num_optional_strings
int
The number of strings in the array above.

current_option
int
The index of the currently selected string for
controlled and partialy controlled text. If
the text type is UF_DRF_partially_controlled_text
and the current_option is -1, then this indicates
that none of the given choices should be used and
the arbitrary text field will contain the string
for this text object.

simple_text
char *
The current value for arbitrary or mandatory text.
This field is only used for the
UF_DRF_arbitrary_text and UF_DRF_mandatory_text
types.