Cleanup: API docs
[blender.git] / doc / python_api / examples / bpy.props.1.py
1 """
2 Operator Example
3 ++++++++++++++++
4
5 A common use of custom properties is for python based :class:`Operator` classes.
6 """
7
8 import bpy
9
10
11 class DialogOperator(bpy.types.Operator):
12     bl_idname = "object.dialog_operator"
13     bl_label = "Property Example"
14
15     my_float = bpy.props.FloatProperty(name="Some Floating Point")
16     my_bool = bpy.props.BoolProperty(name="Toggle Option")
17     my_string = bpy.props.StringProperty(name="String Value")
18
19     def execute(self, context):
20         print("Dialog Runs")
21         return {'FINISHED'}
22
23     def invoke(self, context, event):
24         wm = context.window_manager
25         return wm.invoke_props_dialog(self)
26
27
28 bpy.utils.register_class(DialogOperator)
29
30 # test call
31 bpy.ops.object.dialog_operator('INVOKE_DEFAULT')