OrsObjectPropertiesList

Manages the object properties panel on the right-hand side of the application

author:ORS Team
contact:http://theobjects.com
email:info@theobjects.com
organization:Object Research Systems (ORS), Inc.
address:760 St-Paul West, suite 101, Montréal, Québec, Canada, H3C 1M4
copyright:Object Research Systems (ORS), Inc. All rights reserved 2018.
date:Oct 01 2015 16:56
dragonflyVersion:
 3.0
UUID:d6f287f4761811e78bbd448a5b5d70c0

Class Code

class OrsPythonPlugins.OrsObjectPropertiesList.OrsObjectPropertiesList.OrsObjectPropertiesList(varname=None, managed=True)
UIDescriptors = [<ORSServiceClass.OrsPlugin.uidescriptor.UIDescriptor object>]
addLayoutChangesCallback()
addPropertyWidgetToIgnore(cls)

In certain contexts, properties of an object should not be displayed. Add the class object representing the OrsProperties to ignore

Parameters:cls –
Return:
addToIgnoredObjectList(objectGUIDToBeAdded)
closable = False
closeWidget(name)
contextualMenu(selectedItems)
deletePlugin(aWidget=None)
deleteSelectedObjects()
deleteSelectedObjectsAction()
classmethod exportAsMultipleObjectMenu(selectedItems)
classmethod exportItems(selectedItems)

Queries the user for an export file, and exports the objects to the file :return: Nothing

classmethod exportItemsAsMultipleORSObject(selectedItems)

Queries the user for an export folder, and exports the objects to the file :return: Nothing

classmethod exportItemsToReport(selectedItems)

Queries the user for an export file, and exports the objects to the file :return: Nothing

classmethod exportMenu(selectedItems)
interfacemethod exportORSObjectsInFile(objectsToExport, filename)

Saves a list of objects in a single .ORSObject file

Parameters:
  • objectsToExport (ORSModel.ors.Managed) [count=[0, None]] – list of objects
  • filename (file saving) – file name with .ORSObject extension
classmethod exportToReportMenu(selectedItems, title=None)
classmethod getClassNamesCanExportData(class_names)

Ensures that all class names given can be exported to CSV :param class_names: list of class names :return: Bool

getIgnorePublish()
getSelectedProgIdsList()
getTableModel()
ignorePublish(ignore)
classmethod ignorePublishOnAllInstances(ignore)
classmethod importItems()

Queries the user for an import file, and imports the objects found in the file :return: Nothing

classmethod importMenu()
interfacemethod importORSObjectsFromFile(fname, progress)

Import ORS objects from file

Deprecated since version 3.5: Use importORSObjectsFromFileAndPublish.

Parameters:
Returns:

importedObjects (ORSModel.ors.Managed) [count=[0, None]] – imported objects
interfacemethod importORSObjectsFromFileAndPublish(filenames, progress=None)

Import ORS objects from file and publish them

Parameters:
  • filenames (file) [count=[1, None]] – list of filenames
  • progress (ORSModel.ors.Progress) – a progress bar
Returns:

importedObjects (ORSModel.ors.Managed) [count=[0, None]] – imported objects
classmethod importObjectsFromFile()
keepAlive = False
multiple = False
openWidget(name, dock=None, tab=None, x=-1, y=-1, w=-1, l=-1, order=-1)
orsCurrentViewChange()
orsIgnorePublishChange()
orsSelectedObjectsChange()
postLoadSession()

Placeholder for code that needs to get executed when a session is loaded. Note that this method is called at the very end of the process, when the model has been restored, plugins have been instantiated and the workspace has been restored.

prePublishInSession()

Placeholder for code that needs to get executed when a session is loaded, before the object model gets published. Note that this method is called after all plugins have been created.

refreshOnPublish(eventData)
refreshUIFromModel()

Calls the UI to be updated based on the implementation

removeCallback(managedProgIds)
removePropertyWidgetFromIgnore(cls)

Remove the widget class from the ignore list :param cls: :return:

savable = True
setCallback(managedProgIds)
setManagedProgIdsList(progIds)
setSelectedProgIdsList(progIds)
setTitle(title)
updateSelectedProgIdList(progIds, add)