class_inputeventfromwindow.rst 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/InputEventFromWindow.xml.
  6. .. _class_InputEventFromWindow:
  7. InputEventFromWindow
  8. ====================
  9. **Inherits:** :ref:`InputEvent<class_InputEvent>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`InputEventScreenDrag<class_InputEventScreenDrag>`, :ref:`InputEventScreenTouch<class_InputEventScreenTouch>`, :ref:`InputEventWithModifiers<class_InputEventWithModifiers>`
  11. Abstract base class for :ref:`Viewport<class_Viewport>`-based input events.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. InputEventFromWindow represents events specifically received by windows. This includes mouse events, keyboard events in focused windows or touch screen actions.
  16. .. rst-class:: classref-reftable-group
  17. Properties
  18. ----------
  19. .. table::
  20. :widths: auto
  21. +-----------------------+-----------------------------------------------------------------+-------+
  22. | :ref:`int<class_int>` | :ref:`window_id<class_InputEventFromWindow_property_window_id>` | ``0`` |
  23. +-----------------------+-----------------------------------------------------------------+-------+
  24. .. rst-class:: classref-section-separator
  25. ----
  26. .. rst-class:: classref-descriptions-group
  27. Property Descriptions
  28. ---------------------
  29. .. _class_InputEventFromWindow_property_window_id:
  30. .. rst-class:: classref-property
  31. :ref:`int<class_int>` **window_id** = ``0``
  32. .. rst-class:: classref-property-setget
  33. - void **set_window_id** **(** :ref:`int<class_int>` value **)**
  34. - :ref:`int<class_int>` **get_window_id** **(** **)**
  35. The ID of a :ref:`Window<class_Window>` that received this event.
  36. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  37. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  38. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  39. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  40. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  41. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  42. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`