flameshot/data/dbus/org.flameshot.Flameshot.xml

<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node>
  <interface name="org.flameshot.Flameshot">

    <!--
        requestCapture:
        @requestData: Serialized CaptureRequest object.

        Start a capture using a CaptureRequest.
    -->
    <method name="requestCapture">
      <arg name="requestData" type="ay" direction="in"/>
    </method>

    <!--
        openLauncher:

        Opens the capture launcher.
    -->
    <method name="openLauncher">
      <annotation name="org.freedesktop.DBus.Method.NoReply" value="true"/>
    </method>

    <!--
        openConfig:

        Opens the configuration window.
    -->
    <method name="openConfig">
      <annotation name="org.freedesktop.DBus.Method.NoReply" value="true"/>
    </method>

    <!--
        trayIconEnabled:
        @enabled: The new state for the trayIcon.

        Enable or disable the trayIcon.
    -->
    <method name="trayIconEnabled">
      <arg name="enabled" type="b" direction="in"/>
      <annotation name="org.freedesktop.DBus.Method.NoReply" value="true"/>
    </method>

    <!--
        autostartEnabled:
        @enabled: The new state for the autostart.

        Enable or disable the autostart of the program.
    -->
    <method name="autostartEnabled">
      <arg name="enabled" type="b" direction="in"/>
      <annotation name="org.freedesktop.DBus.Method.NoReply" value="true"/>
    </method>

    <!--
        captureTaken:
        @id: identificator of the call.
        @rawImage: raw image in PNG format.
        @selection: QRect selection geometry.

        Successful capture signal returning the image.
    -->
    <signal name="captureTaken">
      <arg name="id" type="u" direction="out"/>
      <arg name="rawImage" type="ay" direction="out"/>
      <arg name="selection" type="(iiii)" direction="out"/>
    </signal>

    <!--
        captureFailed:
        @id: identificator of the call.

        Whenever the capture fails.
    -->
    <signal name="captureFailed">
      <arg name="id" type="u" direction="out"/>
    </signal>

    <!--
        captureSaved:
        @id: identificator of the call.
        @savePath: canonical path of the newly created image file.

        An image was written to disk after capture.
    -->
    <signal name="captureSaved">
      <arg name="id" type="u" direction="out"/>
      <arg name="savePath" type="s" direction="out"/>
    </signal>

  </interface>
</node>