org.flameshot.Flameshot.xml 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  1. <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
  2. <node>
  3. <interface name="org.flameshot.Flameshot">
  4. <!--
  5. graphicCapture:
  6. @path: the path where the screenshot will be saved. When the argument is empty the program will ask for a path graphically.
  7. @delay: delay time in milliseconds.
  8. @id: identificator of the call.
  9. Open the user interface used to capture the screen. Sends a captureTaken signal with the raw image after closing the GUI
  10. due to a capture taken. It could send a captureFailed signal if the screenshot can't be retrieved.
  11. -->
  12. <method name="graphicCapture">
  13. <arg name="path" type="s" direction="in"/>
  14. <arg name="delay" type="i" direction="in"/>
  15. <arg name="id" type="u" direction="in"/>
  16. </method>
  17. <!--
  18. fullScreen:
  19. @path: the path where the screenshot will be saved. When the argument is empty the program will ask for a path graphically.
  20. @toClipboard: Whether to copy the screenshot to clipboard or not.
  21. @delay: delay time in milliseconds, both return the @id defined in the call of this method.
  22. @id: identificator of the call.
  23. Takes a screenshot of the whole screen and sends a captureTaken signal with the raw image or a captureFailed signal.
  24. -->
  25. <method name="fullScreen">
  26. <arg name="path" type="s" direction="in"/>
  27. <arg name="toClipboard" type="b" direction="in"/>
  28. <arg name="delay" type="i" direction="in"/>
  29. <arg name="id" type="u" direction="in"/>
  30. </method>
  31. <!--
  32. openLauncher:
  33. Opens the capture launcher.
  34. -->
  35. <method name="openLauncher">
  36. <annotation name="org.freedesktop.DBus.Method.NoReply" value="true"/>
  37. </method>
  38. <!--
  39. captureScreen:
  40. @number: number of the screen to be captured.
  41. @path: the path where the screenshot will be saved. When the argument is empty the program will ask for a path graphically.
  42. @toClipboard: Whether to copy the screenshot to clipboard or not.
  43. @delay: delay time in milliseconds, both return the @id defined in the call of this method.
  44. @id: identificator of the call.
  45. Takes a screenshot of the whole screen and sends a captureTaken signal with the raw image or a captureFailed signal.
  46. -->
  47. <method name="captureScreen">
  48. <arg name="number" type="i" direction="in"/>
  49. <arg name="path" type="s" direction="in"/>
  50. <arg name="toClipboard" type="b" direction="in"/>
  51. <arg name="delay" type="i" direction="in"/>
  52. <arg name="id" type="u" direction="in"/>
  53. </method>
  54. <!--
  55. openConfig:
  56. Opens the configuration window.
  57. -->
  58. <method name="openConfig">
  59. <annotation name="org.freedesktop.DBus.Method.NoReply" value="true"/>
  60. </method>
  61. <!--
  62. trayIconEnabled:
  63. @enabled: The new state for the trayIcon.
  64. Enable or disable the trayIcon.
  65. -->
  66. <method name="trayIconEnabled">
  67. <arg name="enabled" type="b" direction="in"/>
  68. <annotation name="org.freedesktop.DBus.Method.NoReply" value="true"/>
  69. </method>
  70. <!--
  71. autostartEnabled:
  72. @enabled: The new state for the autostart.
  73. Enable or disable the autostart of the program.
  74. -->
  75. <method name="autostartEnabled">
  76. <arg name="enabled" type="b" direction="in"/>
  77. <annotation name="org.freedesktop.DBus.Method.NoReply" value="true"/>
  78. </method>
  79. <!--
  80. captureTaken:
  81. @id: identificator of the call.
  82. @rawImage: raw image in PNG format.
  83. Successful capture signal returning the image.
  84. -->
  85. <signal name="captureTaken">
  86. <arg name="id" type="u" direction="out"/>
  87. <arg name="rawImage" type="ay" direction="out"/>
  88. </signal>
  89. <!--
  90. captureFailed:
  91. @id: identificator of the call.
  92. Whenever the capture fails.
  93. -->
  94. <signal name="captureFailed">
  95. <arg name="id" type="u" direction="out"/>
  96. </signal>
  97. </interface>
  98. </node>