LabRPS: Created page with "{{TOCright}} == Introduction == An 32px App FeaturePython object, or formally an {{incode|App::FeaturePython}}, is a simple instance of the App DocumentObject in Python. This is a simple object that by default doesn't have many properties, Depending on the properties that are assigned to it, it can be used to manage different types of data. 800px {{Captio..."

2024-10-28T15:49:53Z

Created page with "{{TOCright}} == Introduction == An 32px App FeaturePython object, or formally an {{incode|App::FeaturePython}}, is a simple instance of the App DocumentObject in Python. This is a simple object that by default doesn't have many properties, Depending on the properties that are assigned to it, it can be used to manage different types of data. 800px {{Captio..."

New page

{{TOCright}}

== Introduction ==

An [[Image:Feature.svg|32px]] [[App_FeaturePython|App FeaturePython]] object, or formally an {{incode|App::FeaturePython}}, is a simple instance of the [[App_DocumentObject|App DocumentObject]] in [[Python|Python]].

This is a simple object that by default doesn't have many properties, Depending on the properties that are assigned to it, it can be used to manage different types of data.

[[Image:LabRPS_core_objects.svg|800px]]

{{Caption|Simplified diagram of the relationships between the core objects in LabRPS}}

== Usage ==

The [[App_FeaturePython|App FeaturePython]] is an internal object, so it cannot be created from the graphical interface. It is meant to be sub-classed by classes that will handle different types of data.

== Properties ==

See [[Property|Property]] for all property types that scripted objects can have.

The [[App_FeaturePython|App FeaturePython]] ({{incode|App::FeaturePython}} class) is derived from the basic [[App_DocumentObject|App DocumentObject]] ({{incode|App::DocumentObject}} class) and inherits all its properties. It also has several additional properties.

These are the properties available in the [[Property_editor|property editor]]. Hidden properties can be shown by using the {{MenuCommand|Show all}} command in the context menu of the [[Property_editor|property editor]].

=== Data ===

{{TitleProperty|Base}}

* {{PropertyData|Proxy|PythonObject|Hidden}}: a custom class associated with this object.
* {{PropertyData|Label|String}}: the user editable name of this object, it is an arbitrary UTF8 string.
* {{PropertyData|Label2|String|Hidden}}: a longer, user editable description of this object, it is an arbitrary UTF8 string that may include newlines. By default, it is an empty string {{value|""}}.
* {{PropertyData|Expression Engine|ExpressionEngine|Hidden}}: a list of expressions. By default, it is empty {{value|[]}}.
* {{PropertyData|Visibility|Bool|Hidden}}: whether to display the object or not.

=== View ===

{{TitleProperty|Base}}

* {{PropertyView|Proxy|PythonObject|Hidden}}: a custom [[Viewprovider|viewprovider]] class associated with this object.

{{TitleProperty|Display Options}}
* {{PropertyView|Display Mode|Enumeration}}: it is empty by default.
* {{PropertyView|Show In Tree|Bool}}: it defaults to {{TRUE}}, in which case the object will appear in the [[Tree_view|Tree view]]; otherwise, the object will be hidden in the tree view. Once an object in the tree is invisible, you can see it again by opening the context menu over the name of the document (right-click), and selecting {{CheckBox|TRUE|Show hidden items}}. Then the hidden item can be chosen and {{PropertyView|Show In Tree}} can be switched back to {{TRUE}}.
* {{PropertyView|Visibility|Bool}}: it defaults to {{TRUE}}, in which case the object will be visible in the [[Tree_view|tree view]]. By default this property can be toggled on and off by selecting the object, and pressing the {{KEY|Space}} bar.

== Scripting ==

{{Emphasis|See also:}} [[LabRPS_Scripting_Basics|LabRPS Scripting Basics]] and [[Scripted_objects|scripted objects]].

An App FeaturePython is created with the {{incode|addObject()}} method of the document.

{{Code|code=
import LabRPS as App

doc = App.newDocument()
obj = App.ActiveDocument.addObject("App::FeaturePython", "Name")
obj.Label = "Custom label"
}}

{{Document_objects_navi}}
{{Userdocnavi}}

App FeaturePython - Revision history