OrsTextPresenterManager¶
Manages all aspects of text annotations
- author:
Dragonfly Team
- contact:
- email:
- organization:
Comet Technologies Canada Inc.
- address:
460 Ste-Catherine Ouest, suite 600, Montréal, Québec, Canada, H3B 1A7
- copyright:
Comet Technologies Canada Inc. All rights reserved 2023.
- date:
Oct 30 2015 18:19
- dragonflyVersion:
3.1.0.286 (D)
- UUID:
bed278e2761c11e789a9448a5b5d70c0
Class Code¶
- class OrsPythonPlugins.OrsTextPresenterManager.OrsTextPresenterManager.OrsTextPresenterManager(*args, **kwargs)¶
- cleanup()¶
Deletes the variables managed by the plugin. It is the place to remove callbacks and other references to Python objects that would prevent them to be garbage collected. This method is called during the process of deletion of the plugin. It calls for the cleanup and deletion of the forms.
- getState()¶
This method is called when saving a plugin instance in a session to obtain the information required to set up the plugin at the loading of the session.
The plugin needs to be savable (see
ORSServiceClass.OrsPlugin.abstractPlugin.AbstractPlugin.savable).- Return:
a string of information that will be sent back to the setState method
- Rtype:
str
Note
The usage of the character
"is not permitted, unless escaped.
- manageTextPresenter(aTextPresenter)¶
Adds a text presenter
- Parameters:
aTextPresenter (ORSModel.ors.VisualText) – a text presenter object
- setState(aString)¶
This method is called to set up the plugin when loading a session.
Note
This method is called only if the string returned by
ORSServiceClass.OrsPlugin.orsPlugin.OrsPlugin.getState()at the saving of the session was not empty.- Parameters:
state (str) – string of information as provided by the getState during the saving of the session
- unmanageAllTextPresenters()¶
Removes all text presenters
- unmanageTextPresenter(aTextPresenter)¶
Removes a text presenter
- Parameters:
aTextPresenter (ORSModel.ors.VisualText) – a text presenter object
