Database note type
pw::Object pw::Entity pw::DatabaseEntity
pw:: | Database note type |
Static Actions | |
create | This action creates a new database note object. |
Instance Actions | |
setText | This command specifies the text for the note. |
getText | This command returns the text associated with the note. |
setPosition | This command specifies the lower left corner for the first character of the first line of text for the note. |
getPosition | This command returns the position of the lower left corner of the first character. |
setFont | This command specifies the font for the note. |
getFont | This command returns the font used by the note. |
setStyle | This command specifies the font style for the note. |
getStyle | This command returns the style associated with the note. |
setSize | This command specifies the local font size of the text before it is transformed. |
getSize | This command returns the font size of the note as measured by the height of the letter ‘M’. |
setHorizontal | This command controls whether the text is written left to right or top to bottom. |
isHorizontal | This command returns a true value if the text is written from left to right and a false value if the text is written from top to bottom. |
setCharacterSlant | This command specifies the angle of slant for each character. |
getCharacterSlant | This command returns the angle each character is slanted as measured from the baseline (90 degrees is the default representing no slant). |
setTransformation | This command specifies how the text is transformed from its local XY plane into global coordinates. |
getTransformation | This command returns the transformation matrix used to transform the text from its local XY plane into global coordinates. |
pw::Note create
This action creates a new database note object.
none
This action retruns a new pw::Note object.
$note setStyle options
This command specifies the font style for the note.
options | This parameter specifies the list of styles to apply. An empty list removes all styles. The valid style types are Bold, Underline, and Italic. The list can contain any combination of the values. |
This command returns nothing.
$note setSize size
This command specifies the local font size of the text before it is transformed. If the transformation contains a scaling component, the end size of the font will be different.
size | This parameter is the size of the font, as measured by the letter ‘M’. |
This command returns nothing.
$note setTransformation xform
This command specifies how the text is transformed from its local XY plane into global coordinates. Normally it should be a pure rotation matrix such as specified by the rotation command of pwu::Transform, but any matrix is supported. The transformation is applied before the text is translated to its starting position. Note that if the transformation has a scaling component, the size value of the note will not be the true size of the font. If the transformation has a translation component, the start position of the text will be updated to reflect the true start position.
xform | This parameter is transformation of the note from local XY space into global coordinate space. It is applied about before the note is translated by its starting position. |
This command returns nothing.
This action creates a new database note object.
pw::Note create
This command specifies the text for the note.
$note setText $text
This command returns the text associated with the note.
$note getText
This command specifies the lower left corner for the first character of the first line of text for the note.
$note setPosition point
This command returns the position of the lower left corner of the first character.
$note getPosition
This command specifies the font for the note.
$note setFont < SansSerif | Serif | Fixed >
This command returns the font used by the note.
$note getFont
This command specifies the font style for the note.
$note setStyle options
This command returns the style associated with the note.
$note getStyle
This command specifies the local font size of the text before it is transformed.
$note setSize size
This command returns the font size of the note as measured by the height of the letter ‘M’.
$note getSize
This command controls whether the text is written left to right or top to bottom.
$note setHorizontal value
This command returns a true value if the text is written from left to right and a false value if the text is written from top to bottom.
$note isHorizontal
This command specifies how the text is transformed from its local XY plane into global coordinates.
$note setTransformation xform
This command returns the transformation matrix used to transform the text from its local XY plane into global coordinates.
$note getTransformation