diff options
author | Marc-André Lureau <marcandre.lureau@redhat.com> | 2010-12-07 02:44:13 +0100 |
---|---|---|
committer | Marc-André Lureau <marcandre.lureau@redhat.com> | 2010-12-09 10:58:47 +0100 |
commit | e8e84574952132f8e94ed97b6fdf69646e32488b (patch) | |
tree | a491a5b482b2297b44a459c022cf7e01180855f0 /doc/reference | |
parent | 027fb69593e471510701ae4f556f84b4c5d7ccc0 (diff) |
gtk: continue API documentation
Diffstat (limited to 'doc/reference')
-rw-r--r-- | doc/reference/spice-gtk-docs.xml | 16 | ||||
-rw-r--r-- | doc/reference/spice-gtk-sections.txt | 232 |
2 files changed, 239 insertions, 9 deletions
diff --git a/doc/reference/spice-gtk-docs.xml b/doc/reference/spice-gtk-docs.xml index 0057119..2938960 100644 --- a/doc/reference/spice-gtk-docs.xml +++ b/doc/reference/spice-gtk-docs.xml @@ -27,28 +27,26 @@ <title>Session and Channels Objects, from spice-client-glib</title> <xi:include href="xml/spice-session.xml"/> <xi:include href="xml/spice-channel.xml"/> + <xi:include href="xml/channel-cursor.xml"/> <xi:include href="xml/channel-display.xml"/> <xi:include href="xml/channel-inputs.xml"/> <xi:include href="xml/channel-main.xml"/> <xi:include href="xml/channel-playback.xml"/> <xi:include href="xml/channel-record.xml"/> - <xi:include href="xml/spice-channel-enums.xml"/> + </chapter> + + <chapter> + <title>GTK Widget, from spice-client-gtk</title> + <xi:include href="xml/spice-widget.xml"/> </chapter> <chapter id="application-support"> - <title>Application support, from spice-client-glib</title> + <title>Application Support, from spice-client-glib</title> <xi:include href="xml/spice-audio.xml"/> - <xi:include href="xml/spice-cmdline.xml"/> <xi:include href="xml/spice-util.xml"/> </chapter> - <chapter> - <title>Display GTK Widget, from spice-client-gtk</title> - <xi:include href="xml/spice-widget.xml"/> - <xi:include href="xml/spice-widget-enums.xml"/> - <xi:include href="xml/spice-grabsequence.xml"/> - </chapter> </part> <chapter id="object-tree"> diff --git a/doc/reference/spice-gtk-sections.txt b/doc/reference/spice-gtk-sections.txt new file mode 100644 index 0000000..c7f1709 --- /dev/null +++ b/doc/reference/spice-gtk-sections.txt @@ -0,0 +1,232 @@ +<SECTION> +<FILE>channel-playback</FILE> +<TITLE>SpicePlaybackChannel</TITLE> +SpicePlaybackChannel +SpicePlaybackChannelClass +<SUBSECTION Standard> +SPICE_PLAYBACK_CHANNEL +SPICE_IS_PLAYBACK_CHANNEL +SPICE_TYPE_PLAYBACK_CHANNEL +spice_playback_channel_get_type +SPICE_PLAYBACK_CHANNEL_CLASS +SPICE_IS_PLAYBACK_CHANNEL_CLASS +SPICE_PLAYBACK_CHANNEL_GET_CLASS +<SUBSECTION Private> +spice_playback_channel +</SECTION> + +<SECTION> +<FILE>spice-session</FILE> +<TITLE>SpiceSession</TITLE> +SpiceSession +SpiceSessionClass +spice_session_new +spice_session_connect +spice_session_open_fd +spice_session_disconnect +spice_session_get_channels +<SUBSECTION> +spice_cmdline_get_option_group +spice_cmdline_session_setup +<SUBSECTION Standard> +SPICE_SESSION +SPICE_IS_SESSION +SPICE_TYPE_SESSION +spice_session_get_type +SPICE_SESSION_CLASS +SPICE_IS_SESSION_CLASS +SPICE_SESSION_GET_CLASS +</SECTION> + +<SECTION> +<FILE>channel-main</FILE> +<TITLE>SpiceMainChannel</TITLE> +SpiceMainChannel +SpiceMainChannelClass +spice_main_channel +spice_main_set_display +spice_main_clipboard_grab +spice_main_clipboard_release +spice_main_clipboard_notify +spice_main_clipboard_request +<SUBSECTION Standard> +SPICE_MAIN_CHANNEL +SPICE_IS_MAIN_CHANNEL +SPICE_TYPE_MAIN_CHANNEL +spice_main_channel_get_type +SPICE_MAIN_CHANNEL_CLASS +SPICE_IS_MAIN_CHANNEL_CLASS +SPICE_MAIN_CHANNEL_GET_CLASS +</SECTION> + +<SECTION> +<FILE>spice-channel</FILE> +<TITLE>SpiceChannel</TITLE> +SpiceChannelEvent +SpiceChannel +SpiceChannelClass +spice_channel_new +spice_channel_destroy +spice_channel_connect +spice_channel_open_fd +spice_channel_disconnect +spice_channel_test_capability +spice_channel_set_capability +<SUBSECTION Standard> +SPICE_TYPE_CHANNEL_EVENT +spice_channel_event_get_type +SPICE_CHANNEL +SPICE_IS_CHANNEL +SPICE_TYPE_CHANNEL +spice_channel_get_type +SPICE_CHANNEL_CLASS +SPICE_IS_CHANNEL_CLASS +SPICE_CHANNEL_GET_CLASS +<SUBSECTION Private> +spice_msg_handler +spice_msg_in +spice_msg_out +</SECTION> + +<SECTION> +<FILE>spice-audio</FILE> +<TITLE>SpiceAudio</TITLE> +SpiceAudio +SpiceAudioClass +spice_audio_new +<SUBSECTION Standard> +SPICE_AUDIO +SPICE_IS_AUDIO +SPICE_TYPE_AUDIO +spice_audio_get_type +SPICE_AUDIO_CLASS +SPICE_IS_AUDIO_CLASS +SPICE_AUDIO_GET_CLASS +</SECTION> + +<SECTION> +<FILE>channel-display</FILE> +<TITLE>SpiceDisplayChannel</TITLE> +SpiceDisplayChannel +SpiceDisplayChannelClass +<SUBSECTION Standard> +SPICE_DISPLAY_CHANNEL +SPICE_IS_DISPLAY_CHANNEL +SPICE_TYPE_DISPLAY_CHANNEL +spice_display_channel_get_type +SPICE_DISPLAY_CHANNEL_CLASS +SPICE_IS_DISPLAY_CHANNEL_CLASS +SPICE_DISPLAY_CHANNEL_GET_CLASS +<SUBSECTION Private> +spice_display_channel +</SECTION> + +<SECTION> +<FILE>channel-cursor</FILE> +<TITLE>SpiceCursorChannel</TITLE> +SpiceCursorChannel +SpiceCursorChannelClass +<SUBSECTION Standard> +SPICE_CURSOR_CHANNEL +SPICE_IS_CURSOR_CHANNEL +SPICE_TYPE_CURSOR_CHANNEL +spice_cursor_channel_get_type +SPICE_CURSOR_CHANNEL_CLASS +SPICE_IS_CURSOR_CHANNEL_CLASS +SPICE_CURSOR_CHANNEL_GET_CLASS +<SUBSECTION Private> +spice_cursor_channel +</SECTION> + +<SECTION> +<FILE>channel-record</FILE> +<TITLE>SpiceRecordChannel</TITLE> +SpiceRecordChannel +SpiceRecordChannelClass +spice_record_send_data +<SUBSECTION Standard> +SPICE_RECORD_CHANNEL +SPICE_IS_RECORD_CHANNEL +SPICE_TYPE_RECORD_CHANNEL +spice_record_channel_get_type +SPICE_RECORD_CHANNEL_CLASS +SPICE_IS_RECORD_CHANNEL_CLASS +SPICE_RECORD_CHANNEL_GET_CLASS +<SUBSECTION Private> +spice_record_channel +</SECTION> + +<SECTION> +<FILE>channel-inputs</FILE> +<TITLE>SpiceInputsChannel</TITLE> +SpiceInputsChannel +SpiceInputsChannelClass +SpiceInputsLock +spice_inputs_motion +spice_inputs_position +spice_inputs_button_press +spice_inputs_button_release +spice_inputs_key_press +spice_inputs_key_release +spice_inputs_set_key_locks +<SUBSECTION Standard> +SPICE_TYPE_INPUTS_LOCK +spice_inputs_lock_get_type +SPICE_INPUTS_CHANNEL +SPICE_IS_INPUTS_CHANNEL +SPICE_TYPE_INPUTS_CHANNEL +spice_inputs_channel_get_type +SPICE_INPUTS_CHANNEL_CLASS +SPICE_IS_INPUTS_CHANNEL_CLASS +SPICE_INPUTS_CHANNEL_GET_CLASS +<SUBSECTION Private> +spice_inputs_channel +</SECTION> + +<SECTION> +<FILE>spice-widget</FILE> +<TITLE>SpiceDisplay</TITLE> +SpiceDisplay +SpiceDisplayClass +SpiceDisplayKeyEvent +spice_display_new +spice_display_mouse_ungrab +spice_display_copy_to_guest +spice_display_paste_from_guest +spice_display_set_grab_keys +spice_display_get_grab_keys +spice_display_send_keys +spice_display_get_pixbuf +<SUBSECTION> +SpiceGrabSequence +spice_grab_sequence_new +spice_grab_sequence_new_from_string +spice_grab_sequence_copy +spice_grab_sequence_free +spice_grab_sequence_as_string +<SUBSECTION Standard> +SPICE_DISPLAY +SPICE_IS_DISPLAY +SPICE_TYPE_DISPLAY +spice_display_get_type +SPICE_DISPLAY_CLASS +SPICE_IS_DISPLAY_CLASS +SPICE_DISPLAY_GET_CLASS +SPICE_TYPE_GRAB_SEQUENCE +spice_grab_sequence_get_type +SPICE_TYPE_DISPLAY_KEY_EVENT +spice_display_key_event_get_type +<SUBSECTION Private> +spice_display +</SECTION> + +<SECTION> +<FILE>spice-util</FILE> +spice_util_set_debug +spice_util_get_version_string +<SUBSECTION Private> +SPICE_DEBUG +spice_util_get_debug +SPICE_RESERVED_PADDING +</SECTION> + |