PTRubberStamp
@interface PTRubberStamp : PTMarkup
A RubberStamp annotation displays text or graphics intended to look as if they were stamped on the page with a rubber stamp.
-
Creates a RubberStamp annotation and initializes it using given Cos/SDF object.
Note
The constructor does not copy any data, but is instead the logical equivalent of a type cast.Parameters
d
The Cos/SDF object to initialze the annotation with.
-
Undocumented
Declaration
Objective-C
- (instancetype)init;
Swift
init!()
-
Creates a new RubberStamp annotation in the specified document.
Declaration
Objective-C
+ (PTRubberStamp *)Create:(PTSDFDoc *)doc pos:(PTPDFRect *)pos icon:(PTRubberStampIcon)icon;
Swift
class func create(_ doc: PTSDFDoc!, pos: PTPDFRect!, icon: PTRubberStampIcon) -> PTRubberStamp!
Parameters
doc
A document to which the annotation is added.
pos
A rectangle specifying the annotation’s bounds in default user space units.
Return Value
A newly created blank RubberStamp annotation.
-
Returns the type of the icon associated with the RubberStamp annotation.
Return Value
A value of enum “Icon” that represents the type of icon associated with the annotation. Default value: e_Draft.
-
Undocumented
Declaration
Objective-C
- (void)SetRubberStampIconType: (PTRubberStampIcon)type;
Swift
func setRubberStampIconType(_ type: PTRubberStampIcon)
-
Sets the type of the icon associated with the RubberStamp annotation.
Declaration
Objective-C
- (void)SetIcon;
Swift
func setIcon()
Parameters
type
A value of enum “Icon” type that represents the type of icon associated with the annotation. Default value: e_Draft.
-
Returns the name of the icon associated with the RubberStamp annotation.
Note
The following icon names are equivalent to predefined icon types from the enum “Icon”: “Approved” = e_Approved “Experimental” = e_Experimental “NotApproved” = e_NotApproved “AsIs” = e_AsIs “Expired” = e_Expired “NotForPublicRelease” = e_NotForPublicRelease “Confidential” = e_Confidential “Final” = e_Final “Sold” = e_Sold “Departmental” = e_Departmental “Format” = e_ForComment “TopSecret” = e_TopSecret “ForPublicRelease” = e_ForPublicRelease “Draft” = e_Draft “Unknown” = e_Unknown Names other than mentioned above do not have predefined icon appearances.Declaration
Objective-C
- (NSString *)GetIconName;
Swift
func getIconName() -> String!
Return Value
A string that is the name of the icon associated with the RubberStamp annotation.
-
Sets the name of the icon associated with the RubberStamp annotation.
Note
The following icon names are equivalent to predefined icon types from the enum “Icon”: “Approved” = e_Approved “Experimental” = e_Experimental “NotApproved” = e_NotApproved “AsIs” = e_AsIs “Expired” = e_Expired “NotForPublicRelease” = e_NotForPublicRelease “Confidential” = e_Confidential “Final” = e_Final “Sold” = e_Sold “Departmental” = e_Departmental “Format” = e_ForComment “TopSecret” = e_TopSecret “ForPublicRelease” = e_ForPublicRelease “Draft” = e_Draft “Unknown” = e_Unknown Names other than mentioned above do not have predefined icon appearances.Declaration
Objective-C
- (void)SetRubberStampIconName:(NSString *)icon;
Swift
func setRubberStampIconName(_ icon: String!)
Parameters
iconstring
the name of the icon associated with the RubberStamp annotation.