summaryrefslogtreecommitdiff
path: root/doc/classes/InputEventWithModifiers.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/InputEventWithModifiers.xml')
-rw-r--r--doc/classes/InputEventWithModifiers.xml103
1 files changed, 103 insertions, 0 deletions
diff --git a/doc/classes/InputEventWithModifiers.xml b/doc/classes/InputEventWithModifiers.xml
new file mode 100644
index 0000000000..7bbdf0a441
--- /dev/null
+++ b/doc/classes/InputEventWithModifiers.xml
@@ -0,0 +1,103 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="InputEventWithModifiers" inherits="InputEvent" category="Core" version="3.0.alpha.custom_build">
+ <brief_description>
+ Base class for input events with modifiers.
+ </brief_description>
+ <description>
+ </description>
+ <tutorials>
+ </tutorials>
+ <demos>
+ </demos>
+ <methods>
+ <method name="get_alt" qualifiers="const">
+ <return type="bool">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_command" qualifiers="const">
+ <return type="bool">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_control" qualifiers="const">
+ <return type="bool">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_metakey" qualifiers="const">
+ <return type="bool">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="get_shift" qualifiers="const">
+ <return type="bool">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="set_alt">
+ <return type="void">
+ </return>
+ <argument index="0" name="enable" type="bool">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_command">
+ <return type="void">
+ </return>
+ <argument index="0" name="enable" type="bool">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_control">
+ <return type="void">
+ </return>
+ <argument index="0" name="enable" type="bool">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_metakey">
+ <return type="void">
+ </return>
+ <argument index="0" name="enable" type="bool">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_shift">
+ <return type="void">
+ </return>
+ <argument index="0" name="enable" type="bool">
+ </argument>
+ <description>
+ </description>
+ </method>
+ </methods>
+ <members>
+ <member name="alt" type="bool" setter="set_alt" getter="get_alt">
+ State of the Alt modifier.
+ </member>
+ <member name="command" type="bool" setter="set_command" getter="get_command">
+ State of the Command modifier.
+ </member>
+ <member name="control" type="bool" setter="set_control" getter="get_control">
+ State of the Ctrl modifier.
+ </member>
+ <member name="meta" type="bool" setter="set_metakey" getter="get_metakey">
+ State of the Meta modifier.
+ </member>
+ <member name="shift" type="bool" setter="set_shift" getter="get_shift">
+ State of the Shift modifier.
+ </member>
+ </members>
+ <constants>
+ </constants>
+</class>