summaryrefslogtreecommitdiff
path: root/docs/reference
diff options
context:
space:
mode:
authorPhilip Withnall <philip@tecnocode.co.uk>2009-04-30 19:00:46 +0100
committerPhilip Withnall <philip@tecnocode.co.uk>2009-04-30 19:00:46 +0100
commit0e99e3fda71efe6c6e50c23667640dd66cf1e087 (patch)
treee10813d4f8f21db30db58f90aacd32611d7b3d13 /docs/reference
parent223e3deffbd1cc84eb4b278dd4505ea9fc36a7c4 (diff)
downloadtotem-0e99e3fda71efe6c6e50c23667640dd66cf1e087.tar.gz
Bug 578387 – Remaining API documentation additions
This adds a load of .h files to the ignore list, and documents the remaining functions which would be useful to plugins. It makes TOTEM_MAX_RECENT_ITEM_LEN private to totem-menu.c, since that was the only file which used it. It also removes a completely unused declaration of bacon_cd_selection_create from totem-preferences.h. See the changes to totem-sections.txt for the list of API I've considered useful to expose (by way of documentation) to plugins.
Diffstat (limited to 'docs/reference')
-rw-r--r--docs/reference/Makefile.am31
-rw-r--r--docs/reference/totem-sections.txt53
2 files changed, 84 insertions, 0 deletions
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 69494287b..d6ab3ce40 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -64,6 +64,37 @@ IGNORE_HFILES += \
baconvideowidget-marshal.h \
bacon-video-widget-gst-missing-plugins.h
+# Files we don't want exported to plugins
+IGNORE_HFILES += \
+ bacon-video-widget-common.h \
+ baconvideowidget-marshal.h \
+ bacon-video-widget-gst-missing-plugins.h \
+ bacon-resize.h \
+ totem-playlist.h \
+ totem-fullscreen.h \
+ totem-module.h \
+ totem-time-label.h \
+ totem-plugin-manager.h \
+ totem-properties-view.h \
+ totem-open-location.h \
+ totem-python-module.h \
+ totem-statusbar.h \
+ totem-sidebar.h \
+ totem-session.h \
+ totem-resources.h \
+ totem-plugins-engine.h \
+ totem-options.h \
+ totem-preferences.h \
+ totem-dvb-setup.h \
+ gstscreenshot.h \
+ totem-uri.h \
+ totem-python-plugin.h \
+ totem-subtitle-encoding.h \
+ totem-menu.h \
+ video-utils.h \
+ debug.h \
+ totem-dnd-menu.h
+
# Plugin files
IGNORE_HFILES += \
bacon-video-widget-properties.h \
diff --git a/docs/reference/totem-sections.txt b/docs/reference/totem-sections.txt
index 7c31b429d..dc2d573a6 100644
--- a/docs/reference/totem-sections.txt
+++ b/docs/reference/totem-sections.txt
@@ -1,9 +1,12 @@
<SECTION>
<FILE>totem-object</FILE>
<TITLE>TotemObject</TITLE>
+Totem
TotemObject
TotemObjectClass
TotemRemoteCommand
+TotemRemoteSetting
+TOTEM_GCONF_PREFIX
totem_object_plugins_init
totem_object_plugins_shutdown
totem_file_opened
@@ -22,17 +25,23 @@ totem_action_fullscreen
totem_action_fullscreen_toggle
totem_action_next
totem_action_previous
+totem_action_next_angle
+totem_action_remote_get_setting
+totem_action_remote_set_setting
totem_action_seek_time
totem_action_seek_relative
totem_action_volume_relative
+totem_action_volume_toggle_mute
totem_action_toggle_aspect_ratio
totem_action_get_aspect_ratio
totem_action_set_aspect_ratio
totem_action_toggle_controls
totem_action_set_scale_ratio
+totem_action_set_playlist_index
totem_action_remote
totem_is_fullscreen
totem_is_playing
+totem_is_paused
totem_is_seekable
totem_get_main_window
totem_get_ui_manager
@@ -41,6 +50,10 @@ totem_get_video_widget_backend_name
totem_get_current_mrl
totem_get_current_time
totem_set_current_subtitle
+totem_get_playlist_length
+totem_get_playlist_pos
+totem_get_short_title
+totem_get_title_at_playlist_pos
totem_add_sidebar_page
totem_remove_sidebar_page
<SUBSECTION Standard>
@@ -50,12 +63,35 @@ TOTEM_TYPE_OBJECT
totem_object_get_type
TOTEM_OBJECT_CLASS
TOTEM_IS_OBJECT_CLASS
+TOTEM_DISC_MEDIA_TYPE
+totem_disc_media_type_get_type
+totem_disc_media_type_quark
+TOTEM_REMOTE_COMMAND
+TOTEM_TYPE_DISC_MEDIA_TYPE
+TOTEM_TYPE_REMOTE_COMMAND
+totem_remote_command_get_type
+totem_remote_command_quark
+<SUBSECTION Private>
+totem_action_set_mrl
+totem_action_set_mrl_and_play
+totem_action_set_mrl_with_warning
</SECTION>
<SECTION>
<FILE>totem-interface</FILE>
<TITLE>Interface</TITLE>
+totem_interface_error
+totem_interface_error_blocking
totem_interface_error_with_link
+totem_interface_boldify_label
+totem_interface_italicise_label
+<SUBSECTION Private>
+totem_interface_get_full_path
+totem_interface_get_license
+totem_interface_load
+totem_interface_load_pixbuf
+totem_interface_load_with_full_path
+totem_interface_set_transient_for
</SECTION>
<SECTION>
@@ -64,6 +100,13 @@ totem_interface_error_with_link
TotemPlugin
TotemPluginClass
TotemPluginError
+TotemPluginActivationFunc
+TotemPluginDeactivationFunc
+TotemPluginWidgetFunc
+TOTEM_PLUGIN_DEFINE_TYPE
+TOTEM_PLUGIN_REGISTER
+TOTEM_PLUGIN_REGISTER_EXTENDED
+TOTEM_PLUGIN_REGISTER_TYPE
totem_plugin_activate
totem_plugin_deactivate
totem_plugin_create_configure_dialog
@@ -78,8 +121,16 @@ totem_plugin_get_type
TOTEM_PLUGIN_GET_CLASS
TOTEM_PLUGIN_CLASS
TOTEM_IS_PLUGIN_CLASS
+TOTEM_PLUGIN_CONST
+TOTEM_PLUGIN_ERROR
+register_totem_plugin
+totem_plugin_error_get_type
+totem_plugin_error_quark
+TOTEM_TYPE_PLUGIN_ERROR
<SUBSECTION Private>
TotemPluginPrivate
+totem_get_plugin_paths
+TotemPluginBooleanFunc
</SECTION>
<SECTION>
@@ -128,6 +179,7 @@ BvwAspectRatio
BvwAudioOutType
BvwDVDEvent
BvwMetadataType
+BvwVisualsQuality
BvwVideoProperty
BvwError
BvwUseType
@@ -196,6 +248,7 @@ bacon_video_widget_is_seekable
<SUBSECTION Standard>
bacon_video_widget_error_quark
bacon_video_widget_get_type
+BVW_ERROR
BACON_TYPE_VIDEO_WIDGET
BACON_VIDEO_WIDGET
BACON_VIDEO_WIDGET_CLASS