OrsObjectPropertiesList

Plugin that present objects of the model.

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.
date:July 2017
dragonflyVersion:
 3.0
UUID:d6f287f4761811e78bbd448a5b5d70c0

Class Code

class OrsPythonPlugins.OrsObjectPropertiesList.OrsObjectPropertiesList.OrsObjectPropertiesList(varname=None, managed=True)
UIDescriptors = [<ORSServiceClass.OrsPlugin.uidescriptor.UIDescriptor object>]
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)
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 getAbout()
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)
orsCurrentDisplayChange()
orsIgnorePublishChange()
orsSelectedObjectsChange()
postLoadSession()
prePublishInSession()
refreshOnPublish(eventData)
refreshUIFromModel()
removeCallback(managedProgIds)
removePropertyWidgetFromIgnore(cls)

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

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