#include <HUtilityPMI.h>
Public Member Functions | |
unsigned int | GetStringCount () const |
void | GetStrings (unsigned int &out_count, String out_strings[], TextAttributes out_text_attributes[]) const |
virtual Type | GetType () const |
NoteEntity (HC_KEY segment_key=INVALID_KEY) | |
NoteEntity (NoteEntity const &that) | |
NoteEntity const & | operator= (NoteEntity const &that) |
void | Set (NoteEntity const &that) |
void | SetStrings (unsigned int in_count, String const in_strings[], TextAttributes const in_text_attributes[]) |
This class represents a single or multi-line block of text.
PMI::NoteEntity::NoteEntity | ( | HC_KEY | segment_key = INVALID_KEY | ) |
Constructs a NoteEntity object. It requires specifying the segment key where the NoteEntity will insert associated geometry.
unsigned int PMI::NoteEntity::GetStringCount | ( | ) | const |
void PMI::NoteEntity::GetStrings | ( | unsigned int & | out_count, |
String | out_strings[], | ||
TextAttributes | out_text_attributes[] | ||
) | const |
Gets the strings for this NoteEntity.
out_count | the number of strings for this NoteEntity. Returned to the user. |
out_strings | the array of strings for this NoteEntity. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array. |
out_text_attributes | the array of TextAttributes for the strings for this NoteEntity. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array. |
virtual Type PMI::NoteEntity::GetType | ( | ) | const [inline, virtual] |
Reimplemented from PMI::Entity.
void PMI::NoteEntity::SetStrings | ( | unsigned int | in_count, |
String const | in_strings[], | ||
TextAttributes const | in_text_attributes[] | ||
) |
Sets the strings for this NoteEntity. These will replace any existing strings.
in_count | the number of strings in the array |
in_strings | the array of strings for this NoteEntity |
in_text_attributes | the array of TextAttributes for the strings for this NoteEntity |