notekit_bus.xml

<node>
	<interface name="com.github.blackhole89.NoteKit.Notebook">
		<property name="active_note" type="s" access="read"/>
		<!--
				insert_text:
				@text: Text to insert into the buffer, at the current
				       position of the cursor.
				@since: 0.1.0

				Method used to insert text into the buffer.
		-->
		<method name="insert_text">
			<arg direction="in" type="s" name="text"/>
		</method>
		<!--
				insert_nke:
				@data:       Data of the external widget. The uint refers
				             to the compression method of the data.
				              - 0: no compression
				              - 1: path
				              - 2: zlib
				              - 3: zstd
				              - to be continued
				             The bytearray refers to the raw data itself.
				@handle:     Tuple refering to a way that the application
				             can find itself. The first string refers to
				             the unique external notekit handle, and the
				             second one refers to some data (most likely
				             a path) passed back to the application.
				@widget_rep: Tuple refering to the widget representation
				             internal to NoteKit.
				@since: 0.1.0

				Method used to insert a new external widget into the
				buffer.
		-->
		<method name="insert_nke">
			<arg direction="in" type="(usay)" name="data"/>
			<arg direction="in" type="(ss)" name="handle"/>
			<arg direction="out" type="(ss)" name="widget_rep"/>
		</method>
		<!--
				update_nke:
				@widget_rep: Tuple refering to the widget representation
				             internal to NoteKit. It will be received on
				             invocation.
				@data:       Updated data of the external widget. The
				             uint refers to the compression method of
				             the data.
				              - 0: no compression
				              - 1: path
				              - 2: zlib
				              - 3: zstd
				              - to be continued
				             The bytearray refers to the raw data itself.
				@since: 0.1.0

				Method used to update an external NoteKit widget.
		-->
		<method name="update_nke">
			<arg direction="in" type="(ss)" name="widget_rep" />
			<arg direction="in" type="(usay)" name="data" />
		</method>
		<!--
				update_nke_edata:
				@widget_rep: Tuple refering to the widget representation
				             internal to NoteKit. It will be received on
				             invocation.
				@edata:      Data passed back to the external application
				             eactivate invocation.
				@since: 0.1.0

				Method used to update an external NoteKit widget's edata.
		-->
		<method name="update_nke_edata">
			<arg direction="in" type="(ss)" name="widget_rep" />
			<arg direction="in" type="s" name="edata" />
		</method>
	</interface>
</node>