From e94c3323641ff8080bed1996e05e7b517022cf55 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Dzi=C4=99giel?= Date: Sun, 21 Jan 2024 20:51:05 +0100 Subject: [PATCH] doc: Upload initial ClapperGtk API reference --- doc/clapper-gtk/clapper-gtk.devhelp2 | 1 + doc/clapper-gtk/clapper-gtk.toml | 58 + doc/clapper-gtk/clapper-logo.svg | 29 + doc/clapper-gtk/class.Billboard.html | 1301 ++++++++++++++++ doc/clapper-gtk/class.BulletinBoard.html | 1296 ++++++++++++++++ doc/clapper-gtk/class.Container.html | 1319 ++++++++++++++++ doc/clapper-gtk/class.EngageLayer.html | 1311 ++++++++++++++++ doc/clapper-gtk/class.LeadContainer.html | 1343 ++++++++++++++++ doc/clapper-gtk/class.NextItemButton.html | 1352 ++++++++++++++++ doc/clapper-gtk/class.PreviousItemButton.html | 1352 ++++++++++++++++ doc/clapper-gtk/class.ProgressBar.html | 1362 ++++++++++++++++ doc/clapper-gtk/class.QueueSelection.html | 737 +++++++++ doc/clapper-gtk/class.SimpleControls.html | 1330 ++++++++++++++++ doc/clapper-gtk/class.SkipItemButton.html | 1374 +++++++++++++++++ doc/clapper-gtk/class.TitleHeader.html | 1311 ++++++++++++++++ .../class.ToggleFullscreenButton.html | 1328 ++++++++++++++++ doc/clapper-gtk/class.TogglePlayButton.html | 1328 ++++++++++++++++ doc/clapper-gtk/class.Video.html | 1315 ++++++++++++++++ doc/clapper-gtk/class.WindowStateButtons.html | 1266 +++++++++++++++ doc/clapper-gtk/classes_hierarchy.html | 181 +++ doc/clapper-gtk/const.MAJOR_VERSION.html | 153 ++ doc/clapper-gtk/const.MICRO_VERSION.html | 153 ++ doc/clapper-gtk/const.MINOR_VERSION.html | 153 ++ doc/clapper-gtk/const.VERSION_S.html | 153 ++ doc/clapper-gtk/ctor.Billboard.new.html | 197 +++ doc/clapper-gtk/ctor.BulletinBoard.new.html | 197 +++ doc/clapper-gtk/ctor.Container.new.html | 197 +++ doc/clapper-gtk/ctor.EngageLayer.new.html | 197 +++ doc/clapper-gtk/ctor.LeadContainer.new.html | 197 +++ doc/clapper-gtk/ctor.NextItemButton.new.html | 197 +++ .../ctor.PreviousItemButton.new.html | 197 +++ doc/clapper-gtk/ctor.ProgressBar.new.html | 197 +++ doc/clapper-gtk/ctor.QueueSelection.new.html | 229 +++ doc/clapper-gtk/ctor.SimpleControls.new.html | 197 +++ doc/clapper-gtk/ctor.TitleHeader.new.html | 197 +++ .../ctor.ToggleFullscreenButton.new.html | 197 +++ .../ctor.TogglePlayButton.new.html | 197 +++ doc/clapper-gtk/ctor.Video.new.html | 197 +++ .../ctor.WindowStateButtons.new.html | 197 +++ doc/clapper-gtk/flags.VideoActionMask.html | 235 +++ doc/clapper-gtk/fonts.css | 150 ++ doc/clapper-gtk/func.BILLBOARD_CAST.html | 196 +++ doc/clapper-gtk/func.BULLETIN_BOARD_CAST.html | 196 +++ doc/clapper-gtk/func.CHECK_VERSION.html | 232 +++ doc/clapper-gtk/func.CONTAINER_CAST.html | 196 +++ doc/clapper-gtk/func.ENCODE_VERSION.html | 232 +++ doc/clapper-gtk/func.ENGAGE_LAYER_CAST.html | 196 +++ doc/clapper-gtk/func.LEAD_CONTAINER_CAST.html | 196 +++ .../func.NEXT_ITEM_BUTTON_CAST.html | 196 +++ .../func.PREVIOUS_ITEM_BUTTON_CAST.html | 196 +++ doc/clapper-gtk/func.PROGRESS_BAR_CAST.html | 196 +++ .../func.QUEUE_SELECTION_CAST.html | 196 +++ .../func.SIMPLE_CONTROLS_CAST.html | 196 +++ .../func.SKIP_ITEM_BUTTON_CAST.html | 196 +++ doc/clapper-gtk/func.TITLE_HEADER_CAST.html | 196 +++ .../func.TOGGLE_FULLSCREEN_BUTTON_CAST.html | 196 +++ .../func.TOGGLE_PLAY_BUTTON_CAST.html | 196 +++ doc/clapper-gtk/func.VIDEO_CAST.html | 196 +++ .../func.WINDOW_STATE_BUTTONS_CAST.html | 196 +++ .../func.get_player_from_ancestor.html | 233 +++ doc/clapper-gtk/func.get_resource.html | 191 +++ doc/clapper-gtk/fzy.js | 222 +++ doc/clapper-gtk/go-up-symbolic.png | Bin 0 -> 471 bytes doc/clapper-gtk/index.html | 830 ++++++++++ doc/clapper-gtk/index.json | 1 + doc/clapper-gtk/main.js | 177 +++ .../method.Billboard.announce_speed.html | 214 +++ .../method.Billboard.announce_volume.html | 214 +++ .../method.Billboard.pin_message.html | 232 +++ .../method.Billboard.post_message.html | 232 +++ ...method.Billboard.unpin_pinned_message.html | 181 +++ .../method.BulletinBoard.announce_speed.html | 214 +++ .../method.BulletinBoard.announce_volume.html | 214 +++ .../method.BulletinBoard.pin_message.html | 232 +++ .../method.BulletinBoard.post_message.html | 232 +++ ...od.BulletinBoard.unpin_pinned_message.html | 181 +++ .../method.Container.get_adaptive_height.html | 227 +++ .../method.Container.get_adaptive_width.html | 227 +++ .../method.Container.get_child.html | 219 +++ .../method.Container.get_height_target.html | 227 +++ .../method.Container.get_width_target.html | 227 +++ .../method.Container.set_adaptive_height.html | 237 +++ .../method.Container.set_adaptive_width.html | 237 +++ .../method.Container.set_child.html | 226 +++ .../method.Container.set_height_target.html | 234 +++ .../method.Container.set_width_target.html | 236 +++ ...hod.LeadContainer.get_blocked_actions.html | 215 +++ .../method.LeadContainer.get_leading.html | 215 +++ ...hod.LeadContainer.set_blocked_actions.html | 223 +++ .../method.LeadContainer.set_leading.html | 224 +++ .../method.ProgressBar.get_reveal_labels.html | 215 +++ .../method.ProgressBar.get_seek_method.html | 215 +++ .../method.ProgressBar.set_reveal_labels.html | 222 +++ .../method.ProgressBar.set_seek_method.html | 222 +++ .../method.QueueSelection.get_queue.html | 211 +++ .../method.QueueSelection.set_queue.html | 218 +++ ...hod.SimpleControls.get_fullscreenable.html | 216 +++ ...method.SimpleControls.get_seek_method.html | 215 +++ ...hod.SimpleControls.set_fullscreenable.html | 225 +++ ...method.SimpleControls.set_seek_method.html | 222 +++ .../method.Video.add_fading_overlay.html | 229 +++ doc/clapper-gtk/method.Video.add_overlay.html | 233 +++ .../method.Video.get_auto_inhibit.html | 227 +++ .../method.Video.get_fade_delay.html | 227 +++ .../method.Video.get_inhibited.html | 228 +++ doc/clapper-gtk/method.Video.get_player.html | 227 +++ .../method.Video.get_touch_fade_delay.html | 228 +++ .../method.Video.set_auto_inhibit.html | 235 +++ .../method.Video.set_fade_delay.html | 226 +++ .../method.Video.set_touch_fade_delay.html | 230 +++ doc/clapper-gtk/opensearch.xml | 1 + .../property.Container.adaptive-height.html | 198 +++ .../property.Container.adaptive-width.html | 198 +++ .../property.Container.height-target.html | 198 +++ .../property.Container.width-target.html | 198 +++ ...roperty.LeadContainer.blocked-actions.html | 194 +++ .../property.LeadContainer.leading.html | 194 +++ .../property.ProgressBar.reveal-labels.html | 194 +++ .../property.ProgressBar.seek-method.html | 194 +++ .../property.QueueSelection.queue.html | 190 +++ ...roperty.SimpleControls.fullscreenable.html | 194 +++ .../property.SimpleControls.seek-method.html | 194 +++ .../property.Video.auto-inhibit.html | 200 +++ .../property.Video.fade-delay.html | 198 +++ doc/clapper-gtk/property.Video.inhibited.html | 198 +++ doc/clapper-gtk/property.Video.player.html | 196 +++ .../property.Video.touch-fade-delay.html | 199 +++ doc/clapper-gtk/search.js | 417 +++++ doc/clapper-gtk/signal.Container.adapt.html | 214 +++ .../signal.QueueSelection.item-query.html | 217 +++ .../signal.QueueSelection.item-selected.html | 221 +++ .../signal.Video.toggle-fullscreen.html | 182 +++ doc/clapper-gtk/solarized-dark.css | 88 ++ doc/clapper-gtk/solarized-light.css | 88 ++ doc/clapper-gtk/style.css | 1042 +++++++++++++ doc/clapper-gtk/urlmap.js | 7 + .../vfunc.SkipItemButton.can_skip.html | 231 +++ .../vfunc.SkipItemButton.skip_item.html | 205 +++ 138 files changed, 45973 insertions(+) create mode 100644 doc/clapper-gtk/clapper-gtk.devhelp2 create mode 100644 doc/clapper-gtk/clapper-gtk.toml create mode 100644 doc/clapper-gtk/clapper-logo.svg create mode 100644 doc/clapper-gtk/class.Billboard.html create mode 100644 doc/clapper-gtk/class.BulletinBoard.html create mode 100644 doc/clapper-gtk/class.Container.html create mode 100644 doc/clapper-gtk/class.EngageLayer.html create mode 100644 doc/clapper-gtk/class.LeadContainer.html create mode 100644 doc/clapper-gtk/class.NextItemButton.html create mode 100644 doc/clapper-gtk/class.PreviousItemButton.html create mode 100644 doc/clapper-gtk/class.ProgressBar.html create mode 100644 doc/clapper-gtk/class.QueueSelection.html create mode 100644 doc/clapper-gtk/class.SimpleControls.html create mode 100644 doc/clapper-gtk/class.SkipItemButton.html create mode 100644 doc/clapper-gtk/class.TitleHeader.html create mode 100644 doc/clapper-gtk/class.ToggleFullscreenButton.html create mode 100644 doc/clapper-gtk/class.TogglePlayButton.html create mode 100644 doc/clapper-gtk/class.Video.html create mode 100644 doc/clapper-gtk/class.WindowStateButtons.html create mode 100644 doc/clapper-gtk/classes_hierarchy.html create mode 100644 doc/clapper-gtk/const.MAJOR_VERSION.html create mode 100644 doc/clapper-gtk/const.MICRO_VERSION.html create mode 100644 doc/clapper-gtk/const.MINOR_VERSION.html create mode 100644 doc/clapper-gtk/const.VERSION_S.html create mode 100644 doc/clapper-gtk/ctor.Billboard.new.html create mode 100644 doc/clapper-gtk/ctor.BulletinBoard.new.html create mode 100644 doc/clapper-gtk/ctor.Container.new.html create mode 100644 doc/clapper-gtk/ctor.EngageLayer.new.html create mode 100644 doc/clapper-gtk/ctor.LeadContainer.new.html create mode 100644 doc/clapper-gtk/ctor.NextItemButton.new.html create mode 100644 doc/clapper-gtk/ctor.PreviousItemButton.new.html create mode 100644 doc/clapper-gtk/ctor.ProgressBar.new.html create mode 100644 doc/clapper-gtk/ctor.QueueSelection.new.html create mode 100644 doc/clapper-gtk/ctor.SimpleControls.new.html create mode 100644 doc/clapper-gtk/ctor.TitleHeader.new.html create mode 100644 doc/clapper-gtk/ctor.ToggleFullscreenButton.new.html create mode 100644 doc/clapper-gtk/ctor.TogglePlayButton.new.html create mode 100644 doc/clapper-gtk/ctor.Video.new.html create mode 100644 doc/clapper-gtk/ctor.WindowStateButtons.new.html create mode 100644 doc/clapper-gtk/flags.VideoActionMask.html create mode 100644 doc/clapper-gtk/fonts.css create mode 100644 doc/clapper-gtk/func.BILLBOARD_CAST.html create mode 100644 doc/clapper-gtk/func.BULLETIN_BOARD_CAST.html create mode 100644 doc/clapper-gtk/func.CHECK_VERSION.html create mode 100644 doc/clapper-gtk/func.CONTAINER_CAST.html create mode 100644 doc/clapper-gtk/func.ENCODE_VERSION.html create mode 100644 doc/clapper-gtk/func.ENGAGE_LAYER_CAST.html create mode 100644 doc/clapper-gtk/func.LEAD_CONTAINER_CAST.html create mode 100644 doc/clapper-gtk/func.NEXT_ITEM_BUTTON_CAST.html create mode 100644 doc/clapper-gtk/func.PREVIOUS_ITEM_BUTTON_CAST.html create mode 100644 doc/clapper-gtk/func.PROGRESS_BAR_CAST.html create mode 100644 doc/clapper-gtk/func.QUEUE_SELECTION_CAST.html create mode 100644 doc/clapper-gtk/func.SIMPLE_CONTROLS_CAST.html create mode 100644 doc/clapper-gtk/func.SKIP_ITEM_BUTTON_CAST.html create mode 100644 doc/clapper-gtk/func.TITLE_HEADER_CAST.html create mode 100644 doc/clapper-gtk/func.TOGGLE_FULLSCREEN_BUTTON_CAST.html create mode 100644 doc/clapper-gtk/func.TOGGLE_PLAY_BUTTON_CAST.html create mode 100644 doc/clapper-gtk/func.VIDEO_CAST.html create mode 100644 doc/clapper-gtk/func.WINDOW_STATE_BUTTONS_CAST.html create mode 100644 doc/clapper-gtk/func.get_player_from_ancestor.html create mode 100644 doc/clapper-gtk/func.get_resource.html create mode 100644 doc/clapper-gtk/fzy.js create mode 100644 doc/clapper-gtk/go-up-symbolic.png create mode 100644 doc/clapper-gtk/index.html create mode 100644 doc/clapper-gtk/index.json create mode 100644 doc/clapper-gtk/main.js create mode 100644 doc/clapper-gtk/method.Billboard.announce_speed.html create mode 100644 doc/clapper-gtk/method.Billboard.announce_volume.html create mode 100644 doc/clapper-gtk/method.Billboard.pin_message.html create mode 100644 doc/clapper-gtk/method.Billboard.post_message.html create mode 100644 doc/clapper-gtk/method.Billboard.unpin_pinned_message.html create mode 100644 doc/clapper-gtk/method.BulletinBoard.announce_speed.html create mode 100644 doc/clapper-gtk/method.BulletinBoard.announce_volume.html create mode 100644 doc/clapper-gtk/method.BulletinBoard.pin_message.html create mode 100644 doc/clapper-gtk/method.BulletinBoard.post_message.html create mode 100644 doc/clapper-gtk/method.BulletinBoard.unpin_pinned_message.html create mode 100644 doc/clapper-gtk/method.Container.get_adaptive_height.html create mode 100644 doc/clapper-gtk/method.Container.get_adaptive_width.html create mode 100644 doc/clapper-gtk/method.Container.get_child.html create mode 100644 doc/clapper-gtk/method.Container.get_height_target.html create mode 100644 doc/clapper-gtk/method.Container.get_width_target.html create mode 100644 doc/clapper-gtk/method.Container.set_adaptive_height.html create mode 100644 doc/clapper-gtk/method.Container.set_adaptive_width.html create mode 100644 doc/clapper-gtk/method.Container.set_child.html create mode 100644 doc/clapper-gtk/method.Container.set_height_target.html create mode 100644 doc/clapper-gtk/method.Container.set_width_target.html create mode 100644 doc/clapper-gtk/method.LeadContainer.get_blocked_actions.html create mode 100644 doc/clapper-gtk/method.LeadContainer.get_leading.html create mode 100644 doc/clapper-gtk/method.LeadContainer.set_blocked_actions.html create mode 100644 doc/clapper-gtk/method.LeadContainer.set_leading.html create mode 100644 doc/clapper-gtk/method.ProgressBar.get_reveal_labels.html create mode 100644 doc/clapper-gtk/method.ProgressBar.get_seek_method.html create mode 100644 doc/clapper-gtk/method.ProgressBar.set_reveal_labels.html create mode 100644 doc/clapper-gtk/method.ProgressBar.set_seek_method.html create mode 100644 doc/clapper-gtk/method.QueueSelection.get_queue.html create mode 100644 doc/clapper-gtk/method.QueueSelection.set_queue.html create mode 100644 doc/clapper-gtk/method.SimpleControls.get_fullscreenable.html create mode 100644 doc/clapper-gtk/method.SimpleControls.get_seek_method.html create mode 100644 doc/clapper-gtk/method.SimpleControls.set_fullscreenable.html create mode 100644 doc/clapper-gtk/method.SimpleControls.set_seek_method.html create mode 100644 doc/clapper-gtk/method.Video.add_fading_overlay.html create mode 100644 doc/clapper-gtk/method.Video.add_overlay.html create mode 100644 doc/clapper-gtk/method.Video.get_auto_inhibit.html create mode 100644 doc/clapper-gtk/method.Video.get_fade_delay.html create mode 100644 doc/clapper-gtk/method.Video.get_inhibited.html create mode 100644 doc/clapper-gtk/method.Video.get_player.html create mode 100644 doc/clapper-gtk/method.Video.get_touch_fade_delay.html create mode 100644 doc/clapper-gtk/method.Video.set_auto_inhibit.html create mode 100644 doc/clapper-gtk/method.Video.set_fade_delay.html create mode 100644 doc/clapper-gtk/method.Video.set_touch_fade_delay.html create mode 100644 doc/clapper-gtk/opensearch.xml create mode 100644 doc/clapper-gtk/property.Container.adaptive-height.html create mode 100644 doc/clapper-gtk/property.Container.adaptive-width.html create mode 100644 doc/clapper-gtk/property.Container.height-target.html create mode 100644 doc/clapper-gtk/property.Container.width-target.html create mode 100644 doc/clapper-gtk/property.LeadContainer.blocked-actions.html create mode 100644 doc/clapper-gtk/property.LeadContainer.leading.html create mode 100644 doc/clapper-gtk/property.ProgressBar.reveal-labels.html create mode 100644 doc/clapper-gtk/property.ProgressBar.seek-method.html create mode 100644 doc/clapper-gtk/property.QueueSelection.queue.html create mode 100644 doc/clapper-gtk/property.SimpleControls.fullscreenable.html create mode 100644 doc/clapper-gtk/property.SimpleControls.seek-method.html create mode 100644 doc/clapper-gtk/property.Video.auto-inhibit.html create mode 100644 doc/clapper-gtk/property.Video.fade-delay.html create mode 100644 doc/clapper-gtk/property.Video.inhibited.html create mode 100644 doc/clapper-gtk/property.Video.player.html create mode 100644 doc/clapper-gtk/property.Video.touch-fade-delay.html create mode 100644 doc/clapper-gtk/search.js create mode 100644 doc/clapper-gtk/signal.Container.adapt.html create mode 100644 doc/clapper-gtk/signal.QueueSelection.item-query.html create mode 100644 doc/clapper-gtk/signal.QueueSelection.item-selected.html create mode 100644 doc/clapper-gtk/signal.Video.toggle-fullscreen.html create mode 100644 doc/clapper-gtk/solarized-dark.css create mode 100644 doc/clapper-gtk/solarized-light.css create mode 100644 doc/clapper-gtk/style.css create mode 100644 doc/clapper-gtk/urlmap.js create mode 100644 doc/clapper-gtk/vfunc.SkipItemButton.can_skip.html create mode 100644 doc/clapper-gtk/vfunc.SkipItemButton.skip_item.html diff --git a/doc/clapper-gtk/clapper-gtk.devhelp2 b/doc/clapper-gtk/clapper-gtk.devhelp2 new file mode 100644 index 00000000..1175f391 --- /dev/null +++ b/doc/clapper-gtk/clapper-gtk.devhelp2 @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/doc/clapper-gtk/clapper-gtk.toml b/doc/clapper-gtk/clapper-gtk.toml new file mode 100644 index 00000000..a03b3240 --- /dev/null +++ b/doc/clapper-gtk/clapper-gtk.toml @@ -0,0 +1,58 @@ +[library] +version = "0.5.2" +browse_url = "https://github.com/Rafostar/clapper/" +repository_url = "https://github.com/Rafostar/clapper.git" +website_url = "https://rafostar.github.io/clapper/" +docs_url = "https://rafostar.github.io/clapper/doc/clapper-gtk/" +authors = "Rafał Dzięgiel" +logo_url = "clapper-logo.svg" +license = "LGPL-2.1-or-later" +description = "Clapper GTK integration library" +devhelp = true +search_index = true + +dependencies = ["Clapper-0.0", "Gtk-4.0"] + + [dependencies."Clapper-0.0"] + name = "Clapper" + description = "Clapper playback library" + docs_url = "https://rafostar.github.io/clapper/doc/clapper/" + + [dependencies."Gtk-4.0"] + name = "Gtk" + description = "The GTK toolkit" + docs_url = "https://docs.gtk.org/gtk4/" + +related = ["GLib-2.0", "GObject-2.0", "Gst-1.0"] + + [related."GLib-2.0"] + name = "GLib" + description = "A general-purpose, portable utility library" + docs_url = "https://docs.gtk.org/glib/" + + [related."GObject-2.0"] + name = "GObject" + description = "The base type system library" + docs_url = "https://docs.gtk.org/gobject/" + + [related."Gst-1.0"] + name = "Gst" + description = "GStreamer core library" + docs_url = "https://gstreamer.freedesktop.org/documentation/gstreamer/gi-index.html" + +[theme] +name = "basic" +show_index_summary = true +show_class_hierarchy = true + +[source-location] +base_url = "https://github.com/Rafostar/clapper/tree/master/" + +[extra] +# The same order will be used when generating the index +content_files = [ +] +content_images = [ + "images/clapper-logo.svg", +] +urlmap_file = "urlmap.js" diff --git a/doc/clapper-gtk/clapper-logo.svg b/doc/clapper-gtk/clapper-logo.svg new file mode 100644 index 00000000..2889584b --- /dev/null +++ b/doc/clapper-gtk/clapper-logo.svg @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/clapper-gtk/class.Billboard.html b/doc/clapper-gtk/class.Billboard.html new file mode 100644 index 00000000..4c0bf127 --- /dev/null +++ b/doc/clapper-gtk/class.Billboard.html @@ -0,0 +1,1301 @@ + + + + + + ClapperGtk.Billboard + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Class

+

ClapperGtkBillboard

+
+ +
+ +
+

+
+ +
+

+ Description + + + [src] + +

+ + 
final class ClapperGtk.Billboard : ClapperGtk.Container
+  implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget {
+  /* No available fields */
+}
+ +
+

A layer where various messages can be displayed.

+

ClapperGtkBillboard widget is meant to be overlaid on top of +ClapperGtkVideo as a normal (non-fading) overlay. It takes +care of displaying and later fading individual messages on its own.

+
+ +
+ + + +
+ + +
+ + + +
+

+ Hierarchy + +

+
+ + + + + + +hierarchy + + +this + + +ClapperGtkBillboard + + + + + +implements_0 + + +GtkAccessible + + + + + +this--implements_0 + + + + +implements_1 + + +GtkBuildable + + + + + +this--implements_1 + + + + +implements_2 + + +GtkConstraintTarget + + + + + +this--implements_2 + + + + +ancestor_0 + + +ClapperGtkContainer + + + + + +ancestor_0--this + + + + +ancestor_1 + + +GtkWidget + + + + + +ancestor_1--ancestor_0 + + + + +ancestor_2 + + +GInitiallyUnowned + + + + + +ancestor_2--ancestor_1 + + + + +ancestor_3 + + +GObject + + + + + +ancestor_3--ancestor_2 + + + + + +
+
+ + + +
+

+ Ancestors + +

+ +
+ +
+
+ + + + + +
+

+ Implements + +

+ +
+ +
+
+ + + +
+

+ Constructors + +

+ +
+ +
+
clapper_gtk_billboard_new
+
+

Creates a new ClapperGtkBillboard instance.

+
+
+

+
+
+ +
+
+ + + + + +
+

+ Instance methods + +

+ +
+ +
+
clapper_gtk_billboard_announce_speed
+
+ No description available. +
+
+

+
+
+ +
+
clapper_gtk_billboard_announce_volume
+
+ No description available. +
+
+

+
+
+ +
+
clapper_gtk_billboard_pin_message
+
+ No description available. +
+
+

+
+
+ +
+
clapper_gtk_billboard_post_message
+
+ No description available. +
+
+

+
+
+ +
+
clapper_gtk_billboard_unpin_pinned_message
+
+ No description available. +
+
+

+
+
+ +
+ + + +
+
Methods inherited from ClapperGtkContainer (10)
+ +
clapper_gtk_container_get_adaptive_height
+

Get a container adaptive height threshold.

+
+
+

+
+ +
clapper_gtk_container_get_adaptive_width
+

Get a container adaptive width threshold.

+
+
+

+
+ +
clapper_gtk_container_get_child
+

Get a child GtkWidget of container.

+
+
+

+
+ +
clapper_gtk_container_get_height_target
+

Get a container height target.

+
+
+

+
+ +
clapper_gtk_container_get_width_target
+

Get a container width target.

+
+
+

+
+ +
clapper_gtk_container_set_adaptive_height
+

Set an adaptive height threshold. When widget is resized to value or lower, +an ClapperGtkContainer::adapt signal will be emitted with TRUE to +notify implementation about mobile adaptation request, otherwise FALSE when +both threshold values are exceeded.

+
+
+

+
+ +
clapper_gtk_container_set_adaptive_width
+

Set an adaptive width threshold. When widget is resized to value or lower, +an ClapperGtkContainer::adapt signal will be emitted with TRUE to +notify implementation about mobile adaptation request, otherwise FALSE when +both threshold values are exceeded.

+
+
+

+
+ +
clapper_gtk_container_set_child
+

Set a child GtkWidget of container.

+
+
+

+
+ +
clapper_gtk_container_set_height_target
+

Same as clapper_gtk_container_set_width_target() but for widget height.

+
+
+

+
+ +
clapper_gtk_container_set_width_target
+

Set a width that container should target. When set container +will not stretch beyond set width while still expanding into +possible boundaries trying to reach its target.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkWidget (161)
+
+ +
+

Please see GtkWidget for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GObject (43)
+
+ +
+

Please see GObject for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GtkAccessible (18)
+
+
gtk_accessible_get_accessible_parent
+
+

Retrieves the accessible parent for an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_accessible_role
+
+

Retrieves the accessible role of an accessible object.

+
+
+

+
+
gtk_accessible_get_at_context
+
+

Retrieves the accessible implementation for the given GtkAccessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_bounds
+
+

Queries the coordinates and dimensions of this accessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_first_accessible_child
+
+

Retrieves the first accessible child of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_next_accessible_sibling
+
+

Retrieves the next accessible sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_platform_state
+
+

Query a platform state, such as focus.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_reset_property
+
+

Resets the accessible property to its default value.

+
+
+

+
+
gtk_accessible_reset_relation
+
+

Resets the accessible relation to its default value.

+
+
+

+
+
gtk_accessible_reset_state
+
+

Resets the accessible state to its default value.

+
+
+

+
+
gtk_accessible_set_accessible_parent
+
+

Sets the parent and sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_next_accessible_sibling
+
+

Updates the next accessible sibling of self.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_property
+
+

Updates a list of accessible properties.

+
+
+

+
+
gtk_accessible_update_property_value
+
+

Updates an array of accessible properties.

+
+
+

+
+
gtk_accessible_update_relation
+
+

Updates a list of accessible relations.

+
+
+

+
+
gtk_accessible_update_relation_value
+
+

Updates an array of accessible relations.

+
+
+

+
+
gtk_accessible_update_state
+
+

Updates a list of accessible states. See the GtkAccessibleState +documentation for the value types of accessible states.

+
+
+

+
+
gtk_accessible_update_state_value
+
+

Updates an array of accessible states.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkBuildable (1)
+
+
gtk_buildable_get_buildable_id
+
+

Gets the ID of the buildable object.

+
+
+

+
+ +
+
+ + + + +
+ + + +
+

+ Properties + +

+ + + + + +
+
Properties inherited from ClapperGtkContainer (4)
+ +
ClapperGtk.Container:adaptive-height
+

Adaptive height threshold that triggers ClapperGtkContainer::adapt signal.

+
+
+

+
+ +
ClapperGtk.Container:adaptive-width
+

Adaptive width threshold that triggers ClapperGtkContainer::adapt signal.

+
+
+

+
+ +
ClapperGtk.Container:height-target
+

Height that container should target.

+
+
+

+
+ +
ClapperGtk.Container:width-target
+

Width that container should target.

+
+
+

+
+ +
+
+ + + +
Properties inherited from GtkWidget (34)
+
+
Gtk.Widget:can-focus
+
+

Whether the widget or any of its descendents can accept +the input focus.

+
+
+

+
+
Gtk.Widget:can-target
+
+

Whether the widget can receive pointer events.

+
+
+

+
+
Gtk.Widget:css-classes
+
+

A list of css classes applied to this widget.

+
+
+

+
+
Gtk.Widget:css-name
+
+

The name of this widget in the CSS tree.

+
+
+

+
+
Gtk.Widget:cursor
+
+

The cursor used by widget.

+
+
+

+
+
Gtk.Widget:focus-on-click
+
+

Whether the widget should grab focus when it is clicked with the mouse.

+
+
+

+
+
Gtk.Widget:focusable
+
+

Whether this widget itself will accept the input focus.

+
+
+

+
+
Gtk.Widget:halign
+
+

How to distribute horizontal space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:has-default
+
+

Whether the widget is the default widget.

+
+
+

+
+
Gtk.Widget:has-focus
+
+

Whether the widget has the input focus.

+
+
+

+
+
Gtk.Widget:has-tooltip
+
+

Enables or disables the emission of the ::query-tooltip signal on widget.

+
+
+

+
+
Gtk.Widget:height-request
+
+

Override for height request of the widget.

+
+
+

+
+
Gtk.Widget:hexpand
+
+

Whether to expand horizontally.

+
+
+

+
+
Gtk.Widget:hexpand-set
+
+

Whether to use the hexpand property.

+
+
+

+
+
Gtk.Widget:layout-manager
+
+

The GtkLayoutManager instance to use to compute the preferred size +of the widget, and allocate its children.

+
+
+

+
+
Gtk.Widget:margin-bottom
+
+

Margin on bottom side of widget.

+
+
+

+
+
Gtk.Widget:margin-end
+
+

Margin on end of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-start
+
+

Margin on start of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-top
+
+

Margin on top side of widget.

+
+
+

+
+
Gtk.Widget:name
+
+

The name of the widget.

+
+
+

+
+
Gtk.Widget:opacity
+
+

The requested opacity of the widget.

+
+
+

+
+
Gtk.Widget:overflow
+
+

How content outside the widget’s content area is treated.

+
+
+

+
+
Gtk.Widget:parent
+
+

The parent widget of this widget.

+
+
+

+
+
Gtk.Widget:receives-default
+
+

Whether the widget will receive the default action when it is focused.

+
+
+

+
+
Gtk.Widget:root
+
+

The GtkRoot widget of the widget tree containing this widget.

+
+
+

+
+
Gtk.Widget:scale-factor
+
+

The scale factor of the widget.

+
+
+

+
+
Gtk.Widget:sensitive
+
+

Whether the widget responds to input.

+
+
+

+
+
Gtk.Widget:tooltip-markup
+
+

Sets the text of tooltip to be the given string, which is marked up +with Pango markup.

+
+
+

+
+
Gtk.Widget:tooltip-text
+
+

Sets the text of tooltip to be the given string.

+
+
+

+
+
Gtk.Widget:valign
+
+

How to distribute vertical space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:vexpand
+
+

Whether to expand vertically.

+
+
+

+
+
Gtk.Widget:vexpand-set
+
+

Whether to use the vexpand property.

+
+
+

+
+
Gtk.Widget:visible
+
+

Whether the widget is visible.

+
+
+

+
+
Gtk.Widget:width-request
+
+

Override for width request of the widget.

+
+
+

+
+ +
+
+ + + + + + + + + +
Properties inherited from GtkAccessible (1)
+
+
Gtk.Accessible:accessible-role
+
+

The accessible role of the given GtkAccessible implementation.

+
+
+

+
+ +
+
+ + + + + + + +
+ + + +
+

+ Signals + +

+ + + + + +
+
Signals inherited from ClapperGtkContainer (1)
+ +
ClapperGtkContainer::adapt
+

A helper signal for implementing mobile/narrow adaptive +behavior on descendants.

+
+
+

+
+ +
+
+ + + +
Signals inherited from GtkWidget (13)
+
+
GtkWidget::destroy
+
+

Signals that all holders of a reference to the widget should release +the reference that they hold.

+
+
+

+
+
GtkWidget::direction-changed
+
+

Emitted when the text direction of a widget changes.

+
+
+

+
+
GtkWidget::hide
+
+

Emitted when widget is hidden.

+
+
+

+
+
GtkWidget::keynav-failed
+
+

Emitted if keyboard navigation fails.

+
+
+

+
+
GtkWidget::map
+
+

Emitted when widget is going to be mapped.

+
+
+

+
+
GtkWidget::mnemonic-activate
+
+

Emitted when a widget is activated via a mnemonic.

+
+
+

+
+
GtkWidget::move-focus
+
+

Emitted when the focus is moved.

+
+
+

+
+
GtkWidget::query-tooltip
+
+

Emitted when the widget’s tooltip is about to be shown.

+
+
+

+
+
GtkWidget::realize
+
+

Emitted when widget is associated with a GdkSurface.

+
+
+

+
+
GtkWidget::show
+
+

Emitted when widget is shown.

+
+
+

+
+
GtkWidget::state-flags-changed
+
+

Emitted when the widget state changes.

+
+
+

+
+
GtkWidget::unmap
+
+

Emitted when widget is going to be unmapped.

+
+
+

+
+
GtkWidget::unrealize
+
+

Emitted when the GdkSurface associated with widget is destroyed.

+
+
+

+
+ +
+
+ + + + + +
Signals inherited from GObject (1)
+
+
GObject::notify
+
+

The notify signal is emitted on an object when one of its properties has +its value set through g_object_set_property(), g_object_set(), et al.

+
+
+

+
+ +
+
+ + + + + + + + + + + +
+ + + +
+

+ Class structure + +

+ +
+ 
struct ClapperGtkBillboardClass {
+  ClapperGtkContainerClass parent_class;
+  
+}
+
+ +
+ No description available. +
+ + +
+
Class members
+ +
+ +
parent_class: ClapperGtkContainerClass
+
No description available.
+ + +
+ +
+ + + + + + +
+
+ + + +
+ +
+ + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/class.BulletinBoard.html b/doc/clapper-gtk/class.BulletinBoard.html new file mode 100644 index 00000000..773a1c74 --- /dev/null +++ b/doc/clapper-gtk/class.BulletinBoard.html @@ -0,0 +1,1296 @@ + + + + + + ClapperGtk.BulletinBoard + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Class

+

ClapperGtkBulletinBoard

+
+ +
+ +
+

+
+ +
+

+ Description + + +

+ + 
final class ClapperGtk.BulletinBoard : ClapperGtk.Container
+  implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget {
+  /* No available fields */
+}
+ +
+ No description available. +
+ +
+ + + +
+ + +
+ + + +
+

+ Hierarchy + +

+
+ + + + + + +hierarchy + + +this + + +ClapperGtkBulletinBoard + + + + + +implements_0 + + +GtkAccessible + + + + + +this--implements_0 + + + + +implements_1 + + +GtkBuildable + + + + + +this--implements_1 + + + + +implements_2 + + +GtkConstraintTarget + + + + + +this--implements_2 + + + + +ancestor_0 + + +ClapperGtkContainer + + + + + +ancestor_0--this + + + + +ancestor_1 + + +GtkWidget + + + + + +ancestor_1--ancestor_0 + + + + +ancestor_2 + + +GInitiallyUnowned + + + + + +ancestor_2--ancestor_1 + + + + +ancestor_3 + + +GObject + + + + + +ancestor_3--ancestor_2 + + + + + +
+
+ + + +
+

+ Ancestors + +

+ +
+ +
+
+ + + + + +
+

+ Implements + +

+ +
+ +
+
+ + + +
+

+ Constructors + +

+ +
+ +
+
clapper_gtk_bulletin_board_new
+
+

Creates a new ClapperGtkBulletinBoard instance.

+
+
+

+
+
+ +
+
+ + + + + +
+

+ Instance methods + +

+ +
+ +
+
clapper_gtk_bulletin_board_announce_speed
+
+ No description available. +
+
+

+
+
+ +
+
clapper_gtk_bulletin_board_announce_volume
+
+ No description available. +
+
+

+
+
+ +
+
clapper_gtk_bulletin_board_pin_message
+
+ No description available. +
+
+

+
+
+ +
+
clapper_gtk_bulletin_board_post_message
+
+ No description available. +
+
+

+
+
+ +
+
clapper_gtk_bulletin_board_unpin_pinned_message
+
+ No description available. +
+
+

+
+
+ +
+ + + +
+
Methods inherited from ClapperGtkContainer (10)
+ +
clapper_gtk_container_get_adaptive_height
+

Get a container adaptive height threshold.

+
+
+

+
+ +
clapper_gtk_container_get_adaptive_width
+

Get a container adaptive width threshold.

+
+
+

+
+ +
clapper_gtk_container_get_child
+

Get a child GtkWidget of container.

+
+
+

+
+ +
clapper_gtk_container_get_height_target
+

Get a container height target.

+
+
+

+
+ +
clapper_gtk_container_get_width_target
+

Get a container width target.

+
+
+

+
+ +
clapper_gtk_container_set_adaptive_height
+

Set an adaptive height threshold. When widget is resized to value or lower, +an ClapperGtkContainer::adapt signal will be emitted with TRUE to notify +implementation about mobile adaptation request, otherwise FALSE when +both threshold values are exceeded.

+
+
+

+
+ +
clapper_gtk_container_set_adaptive_width
+

Set an adaptive width threshold. When widget is resized to value or lower, +an ClapperGtkContainer::adapt signal will be emitted with TRUE to notify +implementation about mobile adaptation request, otherwise FALSE when +both threshold values are exceeded.

+
+
+

+
+ +
clapper_gtk_container_set_child
+

Set a child GtkWidget of container.

+
+
+

+
+ +
clapper_gtk_container_set_height_target
+

Same as clapper_gtk_container_set_width_target() but for widget height.

+
+
+

+
+ +
clapper_gtk_container_set_width_target
+

Set a width that container should target. When set container +will not stretch beyond set width while still expanding into +possible boundaries trying to reach its target.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkWidget (161)
+
+ +
+

Please see GtkWidget for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GObject (43)
+
+ +
+

Please see GObject for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GtkAccessible (18)
+
+
gtk_accessible_get_accessible_parent
+
+

Retrieves the accessible parent for an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_accessible_role
+
+

Retrieves the accessible role of an accessible object.

+
+
+

+
+
gtk_accessible_get_at_context
+
+

Retrieves the accessible implementation for the given GtkAccessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_bounds
+
+

Queries the coordinates and dimensions of this accessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_first_accessible_child
+
+

Retrieves the first accessible child of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_next_accessible_sibling
+
+

Retrieves the next accessible sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_platform_state
+
+

Query a platform state, such as focus.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_reset_property
+
+

Resets the accessible property to its default value.

+
+
+

+
+
gtk_accessible_reset_relation
+
+

Resets the accessible relation to its default value.

+
+
+

+
+
gtk_accessible_reset_state
+
+

Resets the accessible state to its default value.

+
+
+

+
+
gtk_accessible_set_accessible_parent
+
+

Sets the parent and sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_next_accessible_sibling
+
+

Updates the next accessible sibling of self.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_property
+
+

Updates a list of accessible properties.

+
+
+

+
+
gtk_accessible_update_property_value
+
+

Updates an array of accessible properties.

+
+
+

+
+
gtk_accessible_update_relation
+
+

Updates a list of accessible relations.

+
+
+

+
+
gtk_accessible_update_relation_value
+
+

Updates an array of accessible relations.

+
+
+

+
+
gtk_accessible_update_state
+
+

Updates a list of accessible states. See the GtkAccessibleState +documentation for the value types of accessible states.

+
+
+

+
+
gtk_accessible_update_state_value
+
+

Updates an array of accessible states.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkBuildable (1)
+
+
gtk_buildable_get_buildable_id
+
+

Gets the ID of the buildable object.

+
+
+

+
+ +
+
+ + + + +
+ + + +
+

+ Properties + +

+ + + + + +
+
Properties inherited from ClapperGtkContainer (4)
+ +
ClapperGtk.Container:adaptive-height
+

Adaptive height threshold that triggers ClapperGtkContainer::adapt signal.

+
+
+

+
+ +
ClapperGtk.Container:adaptive-width
+

Adaptive width threshold that triggers ClapperGtkContainer::adapt signal.

+
+
+

+
+ +
ClapperGtk.Container:height-target
+

Height that container should target.

+
+
+

+
+ +
ClapperGtk.Container:width-target
+

Width that container should target.

+
+
+

+
+ +
+
+ + + +
Properties inherited from GtkWidget (34)
+
+
Gtk.Widget:can-focus
+
+

Whether the widget or any of its descendents can accept +the input focus.

+
+
+

+
+
Gtk.Widget:can-target
+
+

Whether the widget can receive pointer events.

+
+
+

+
+
Gtk.Widget:css-classes
+
+

A list of css classes applied to this widget.

+
+
+

+
+
Gtk.Widget:css-name
+
+

The name of this widget in the CSS tree.

+
+
+

+
+
Gtk.Widget:cursor
+
+

The cursor used by widget.

+
+
+

+
+
Gtk.Widget:focus-on-click
+
+

Whether the widget should grab focus when it is clicked with the mouse.

+
+
+

+
+
Gtk.Widget:focusable
+
+

Whether this widget itself will accept the input focus.

+
+
+

+
+
Gtk.Widget:halign
+
+

How to distribute horizontal space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:has-default
+
+

Whether the widget is the default widget.

+
+
+

+
+
Gtk.Widget:has-focus
+
+

Whether the widget has the input focus.

+
+
+

+
+
Gtk.Widget:has-tooltip
+
+

Enables or disables the emission of the ::query-tooltip signal on widget.

+
+
+

+
+
Gtk.Widget:height-request
+
+

Override for height request of the widget.

+
+
+

+
+
Gtk.Widget:hexpand
+
+

Whether to expand horizontally.

+
+
+

+
+
Gtk.Widget:hexpand-set
+
+

Whether to use the hexpand property.

+
+
+

+
+
Gtk.Widget:layout-manager
+
+

The GtkLayoutManager instance to use to compute the preferred size +of the widget, and allocate its children.

+
+
+

+
+
Gtk.Widget:margin-bottom
+
+

Margin on bottom side of widget.

+
+
+

+
+
Gtk.Widget:margin-end
+
+

Margin on end of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-start
+
+

Margin on start of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-top
+
+

Margin on top side of widget.

+
+
+

+
+
Gtk.Widget:name
+
+

The name of the widget.

+
+
+

+
+
Gtk.Widget:opacity
+
+

The requested opacity of the widget.

+
+
+

+
+
Gtk.Widget:overflow
+
+

How content outside the widget’s content area is treated.

+
+
+

+
+
Gtk.Widget:parent
+
+

The parent widget of this widget.

+
+
+

+
+
Gtk.Widget:receives-default
+
+

Whether the widget will receive the default action when it is focused.

+
+
+

+
+
Gtk.Widget:root
+
+

The GtkRoot widget of the widget tree containing this widget.

+
+
+

+
+
Gtk.Widget:scale-factor
+
+

The scale factor of the widget.

+
+
+

+
+
Gtk.Widget:sensitive
+
+

Whether the widget responds to input.

+
+
+

+
+
Gtk.Widget:tooltip-markup
+
+

Sets the text of tooltip to be the given string, which is marked up +with Pango markup.

+
+
+

+
+
Gtk.Widget:tooltip-text
+
+

Sets the text of tooltip to be the given string.

+
+
+

+
+
Gtk.Widget:valign
+
+

How to distribute vertical space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:vexpand
+
+

Whether to expand vertically.

+
+
+

+
+
Gtk.Widget:vexpand-set
+
+

Whether to use the vexpand property.

+
+
+

+
+
Gtk.Widget:visible
+
+

Whether the widget is visible.

+
+
+

+
+
Gtk.Widget:width-request
+
+

Override for width request of the widget.

+
+
+

+
+ +
+
+ + + + + + + + + +
Properties inherited from GtkAccessible (1)
+
+
Gtk.Accessible:accessible-role
+
+

The accessible role of the given GtkAccessible implementation.

+
+
+

+
+ +
+
+ + + + + + + +
+ + + +
+

+ Signals + +

+ + + + + +
+
Signals inherited from ClapperGtkContainer (1)
+ +
ClapperGtkContainer::adapt
+

A helper signal for implementing mobile/narrow adaptive +behavior on descendants.

+
+
+

+
+ +
+
+ + + +
Signals inherited from GtkWidget (13)
+
+
GtkWidget::destroy
+
+

Signals that all holders of a reference to the widget should release +the reference that they hold.

+
+
+

+
+
GtkWidget::direction-changed
+
+

Emitted when the text direction of a widget changes.

+
+
+

+
+
GtkWidget::hide
+
+

Emitted when widget is hidden.

+
+
+

+
+
GtkWidget::keynav-failed
+
+

Emitted if keyboard navigation fails.

+
+
+

+
+
GtkWidget::map
+
+

Emitted when widget is going to be mapped.

+
+
+

+
+
GtkWidget::mnemonic-activate
+
+

Emitted when a widget is activated via a mnemonic.

+
+
+

+
+
GtkWidget::move-focus
+
+

Emitted when the focus is moved.

+
+
+

+
+
GtkWidget::query-tooltip
+
+

Emitted when the widget’s tooltip is about to be shown.

+
+
+

+
+
GtkWidget::realize
+
+

Emitted when widget is associated with a GdkSurface.

+
+
+

+
+
GtkWidget::show
+
+

Emitted when widget is shown.

+
+
+

+
+
GtkWidget::state-flags-changed
+
+

Emitted when the widget state changes.

+
+
+

+
+
GtkWidget::unmap
+
+

Emitted when widget is going to be unmapped.

+
+
+

+
+
GtkWidget::unrealize
+
+

Emitted when the GdkSurface associated with widget is destroyed.

+
+
+

+
+ +
+
+ + + + + +
Signals inherited from GObject (1)
+
+
GObject::notify
+
+

The notify signal is emitted on an object when one of its properties has +its value set through g_object_set_property(), g_object_set(), et al.

+
+
+

+
+ +
+
+ + + + + + + + + + + +
+ + + +
+

+ Class structure + +

+ +
+ 
struct ClapperGtkBulletinBoardClass {
+  ClapperGtkContainerClass parent_class;
+  
+}
+
+ +
+ No description available. +
+ + +
+
Class members
+ +
+ +
parent_class: ClapperGtkContainerClass
+
No description available.
+ + +
+ +
+ + + + + + +
+
+ + + +
+ +
+ + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/class.Container.html b/doc/clapper-gtk/class.Container.html new file mode 100644 index 00000000..fb353483 --- /dev/null +++ b/doc/clapper-gtk/class.Container.html @@ -0,0 +1,1319 @@ + + + + + + ClapperGtk.Container + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Class

+

ClapperGtkContainer

+
+ +
+ +
+

+
+ +
+

+ Description + + + [src] + +

+ + 
class ClapperGtk.Container : Gtk.Widget
+  implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget {
+  /* No available fields */
+}
+ +
+

A simple container widget that holds just one child.

+

It is designed to work well with OSD overlay, adding some useful functionalities +to it, such as width and height that widget should target. This helps with +implementing simple adaptive widgets by observing its own width and signalling +when adaptive threshold is reached.

+

You can use this when you need to create a widget that is adaptive or should have +a limited maximal width/height.

+

If you need to have more then single widget as child, place a widget that +can hold multiple children such as GtkBox as a single conatiner child +and then your widgets into that child.

+
+ +
+ + + +
+ + +
+ + + +
+

+ Hierarchy + +

+
+ + + + + + +hierarchy + + +this + + +ClapperGtkContainer + + + + + +implements_0 + + +GtkAccessible + + + + + +this--implements_0 + + + + +implements_1 + + +GtkBuildable + + + + + +this--implements_1 + + + + +implements_2 + + +GtkConstraintTarget + + + + + +this--implements_2 + + + + +ancestor_0 + + +GtkWidget + + + + + +ancestor_0--this + + + + +ancestor_1 + + +GInitiallyUnowned + + + + + +ancestor_1--ancestor_0 + + + + +ancestor_2 + + +GObject + + + + + +ancestor_2--ancestor_1 + + + + + +
+
+ + + +
+

+ Ancestors + +

+ +
+ +
+
+ + + +
+

Descendants

+
+ +
+
+ + + +
+

+ Implements + +

+ +
+ +
+
+ + + +
+

+ Constructors + +

+ +
+ +
+
clapper_gtk_container_new
+
+

Creates a new ClapperGtkContainer instance.

+
+
+

+
+
+ +
+
+ + + + + +
+

+ Instance methods + +

+ +
+ +
+
clapper_gtk_container_get_adaptive_height
+
+

Get a container adaptive height threshold.

+
+
+

+
+
+ +
+
clapper_gtk_container_get_adaptive_width
+
+

Get a container adaptive width threshold.

+
+
+

+
+
+ +
+
clapper_gtk_container_get_child
+
+

Get a child GtkWidget of container.

+
+
+

+
+
+ +
+
clapper_gtk_container_get_height_target
+
+

Get a container height target.

+
+
+

+
+
+ +
+
clapper_gtk_container_get_width_target
+
+

Get a container width target.

+
+
+

+
+
+ +
+
clapper_gtk_container_set_adaptive_height
+
+

Set an adaptive height threshold. When widget is resized to value or lower, +an ClapperGtkContainer::adapt signal will be emitted with TRUE to +notify implementation about mobile adaptation request, otherwise FALSE when +both threshold values are exceeded.

+
+
+

+
+
+ +
+
clapper_gtk_container_set_adaptive_width
+
+

Set an adaptive width threshold. When widget is resized to value or lower, +an ClapperGtkContainer::adapt signal will be emitted with TRUE to +notify implementation about mobile adaptation request, otherwise FALSE when +both threshold values are exceeded.

+
+
+

+
+
+ +
+
clapper_gtk_container_set_child
+
+

Set a child GtkWidget of container.

+
+
+

+
+
+ +
+
clapper_gtk_container_set_height_target
+
+

Same as clapper_gtk_container_set_width_target() but for widget height.

+
+
+

+
+
+ +
+
clapper_gtk_container_set_width_target
+
+

Set a width that container should target. When set container +will not stretch beyond set width while still expanding into +possible boundaries trying to reach its target.

+
+
+

+
+
+ +
+ + + +
Methods inherited from GtkWidget (161)
+
+ +
+

Please see GtkWidget for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GObject (43)
+
+ +
+

Please see GObject for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GtkAccessible (18)
+
+
gtk_accessible_get_accessible_parent
+
+

Retrieves the accessible parent for an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_accessible_role
+
+

Retrieves the accessible role of an accessible object.

+
+
+

+
+
gtk_accessible_get_at_context
+
+

Retrieves the accessible implementation for the given GtkAccessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_bounds
+
+

Queries the coordinates and dimensions of this accessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_first_accessible_child
+
+

Retrieves the first accessible child of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_next_accessible_sibling
+
+

Retrieves the next accessible sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_platform_state
+
+

Query a platform state, such as focus.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_reset_property
+
+

Resets the accessible property to its default value.

+
+
+

+
+
gtk_accessible_reset_relation
+
+

Resets the accessible relation to its default value.

+
+
+

+
+
gtk_accessible_reset_state
+
+

Resets the accessible state to its default value.

+
+
+

+
+
gtk_accessible_set_accessible_parent
+
+

Sets the parent and sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_next_accessible_sibling
+
+

Updates the next accessible sibling of self.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_property
+
+

Updates a list of accessible properties.

+
+
+

+
+
gtk_accessible_update_property_value
+
+

Updates an array of accessible properties.

+
+
+

+
+
gtk_accessible_update_relation
+
+

Updates a list of accessible relations.

+
+
+

+
+
gtk_accessible_update_relation_value
+
+

Updates an array of accessible relations.

+
+
+

+
+
gtk_accessible_update_state
+
+

Updates a list of accessible states. See the GtkAccessibleState +documentation for the value types of accessible states.

+
+
+

+
+
gtk_accessible_update_state_value
+
+

Updates an array of accessible states.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkBuildable (1)
+
+
gtk_buildable_get_buildable_id
+
+

Gets the ID of the buildable object.

+
+
+

+
+ +
+
+ + + + +
+ + + +
+

+ Properties + +

+ + +
+ +
+
ClapperGtk.Container:adaptive-height
+
+

Adaptive height threshold that triggers ClapperGtkContainer::adapt signal.

+
+
+

+
+
+ +
+
ClapperGtk.Container:adaptive-width
+
+

Adaptive width threshold that triggers ClapperGtkContainer::adapt signal.

+
+
+

+
+
+ +
+
ClapperGtk.Container:height-target
+
+

Height that container should target.

+
+
+

+
+
+ +
+
ClapperGtk.Container:width-target
+
+

Width that container should target.

+
+
+

+
+
+ +
+ + + + +
Properties inherited from GtkWidget (34)
+
+
Gtk.Widget:can-focus
+
+

Whether the widget or any of its descendents can accept +the input focus.

+
+
+

+
+
Gtk.Widget:can-target
+
+

Whether the widget can receive pointer events.

+
+
+

+
+
Gtk.Widget:css-classes
+
+

A list of css classes applied to this widget.

+
+
+

+
+
Gtk.Widget:css-name
+
+

The name of this widget in the CSS tree.

+
+
+

+
+
Gtk.Widget:cursor
+
+

The cursor used by widget.

+
+
+

+
+
Gtk.Widget:focus-on-click
+
+

Whether the widget should grab focus when it is clicked with the mouse.

+
+
+

+
+
Gtk.Widget:focusable
+
+

Whether this widget itself will accept the input focus.

+
+
+

+
+
Gtk.Widget:halign
+
+

How to distribute horizontal space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:has-default
+
+

Whether the widget is the default widget.

+
+
+

+
+
Gtk.Widget:has-focus
+
+

Whether the widget has the input focus.

+
+
+

+
+
Gtk.Widget:has-tooltip
+
+

Enables or disables the emission of the ::query-tooltip signal on widget.

+
+
+

+
+
Gtk.Widget:height-request
+
+

Override for height request of the widget.

+
+
+

+
+
Gtk.Widget:hexpand
+
+

Whether to expand horizontally.

+
+
+

+
+
Gtk.Widget:hexpand-set
+
+

Whether to use the hexpand property.

+
+
+

+
+
Gtk.Widget:layout-manager
+
+

The GtkLayoutManager instance to use to compute the preferred size +of the widget, and allocate its children.

+
+
+

+
+
Gtk.Widget:margin-bottom
+
+

Margin on bottom side of widget.

+
+
+

+
+
Gtk.Widget:margin-end
+
+

Margin on end of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-start
+
+

Margin on start of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-top
+
+

Margin on top side of widget.

+
+
+

+
+
Gtk.Widget:name
+
+

The name of the widget.

+
+
+

+
+
Gtk.Widget:opacity
+
+

The requested opacity of the widget.

+
+
+

+
+
Gtk.Widget:overflow
+
+

How content outside the widget’s content area is treated.

+
+
+

+
+
Gtk.Widget:parent
+
+

The parent widget of this widget.

+
+
+

+
+
Gtk.Widget:receives-default
+
+

Whether the widget will receive the default action when it is focused.

+
+
+

+
+
Gtk.Widget:root
+
+

The GtkRoot widget of the widget tree containing this widget.

+
+
+

+
+
Gtk.Widget:scale-factor
+
+

The scale factor of the widget.

+
+
+

+
+
Gtk.Widget:sensitive
+
+

Whether the widget responds to input.

+
+
+

+
+
Gtk.Widget:tooltip-markup
+
+

Sets the text of tooltip to be the given string, which is marked up +with Pango markup.

+
+
+

+
+
Gtk.Widget:tooltip-text
+
+

Sets the text of tooltip to be the given string.

+
+
+

+
+
Gtk.Widget:valign
+
+

How to distribute vertical space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:vexpand
+
+

Whether to expand vertically.

+
+
+

+
+
Gtk.Widget:vexpand-set
+
+

Whether to use the vexpand property.

+
+
+

+
+
Gtk.Widget:visible
+
+

Whether the widget is visible.

+
+
+

+
+
Gtk.Widget:width-request
+
+

Override for width request of the widget.

+
+
+

+
+ +
+
+ + + + + + + + + +
Properties inherited from GtkAccessible (1)
+
+
Gtk.Accessible:accessible-role
+
+

The accessible role of the given GtkAccessible implementation.

+
+
+

+
+ +
+
+ + + + + + + +
+ + + +
+

+ Signals + +

+ + +
+ +
+
ClapperGtk.Container::adapt
+
+

A helper signal for implementing mobile/narrow adaptive +behavior on descendants.

+
+
+

+
+
+ +
+ + + + +
Signals inherited from GtkWidget (13)
+
+
GtkWidget::destroy
+
+

Signals that all holders of a reference to the widget should release +the reference that they hold.

+
+
+

+
+
GtkWidget::direction-changed
+
+

Emitted when the text direction of a widget changes.

+
+
+

+
+
GtkWidget::hide
+
+

Emitted when widget is hidden.

+
+
+

+
+
GtkWidget::keynav-failed
+
+

Emitted if keyboard navigation fails.

+
+
+

+
+
GtkWidget::map
+
+

Emitted when widget is going to be mapped.

+
+
+

+
+
GtkWidget::mnemonic-activate
+
+

Emitted when a widget is activated via a mnemonic.

+
+
+

+
+
GtkWidget::move-focus
+
+

Emitted when the focus is moved.

+
+
+

+
+
GtkWidget::query-tooltip
+
+

Emitted when the widget’s tooltip is about to be shown.

+
+
+

+
+
GtkWidget::realize
+
+

Emitted when widget is associated with a GdkSurface.

+
+
+

+
+
GtkWidget::show
+
+

Emitted when widget is shown.

+
+
+

+
+
GtkWidget::state-flags-changed
+
+

Emitted when the widget state changes.

+
+
+

+
+
GtkWidget::unmap
+
+

Emitted when widget is going to be unmapped.

+
+
+

+
+
GtkWidget::unrealize
+
+

Emitted when the GdkSurface associated with widget is destroyed.

+
+
+

+
+ +
+
+ + + + + +
Signals inherited from GObject (1)
+
+
GObject::notify
+
+

The notify signal is emitted on an object when one of its properties has +its value set through g_object_set_property(), g_object_set(), et al.

+
+
+

+
+ +
+
+ + + + + + + + + + + +
+ + + +
+

+ Class structure + +

+ +
+ 
struct ClapperGtkContainerClass {
+  GtkWidgetClass parent_class;
+  
+}
+
+ +
+ No description available. +
+ + +
+
Class members
+ +
+ +
parent_class: GtkWidgetClass
+
No description available.
+ + +
+ +
+ + + + + + +
+
+ + + +
+ +
+ + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/class.EngageLayer.html b/doc/clapper-gtk/class.EngageLayer.html new file mode 100644 index 00000000..24c7b48b --- /dev/null +++ b/doc/clapper-gtk/class.EngageLayer.html @@ -0,0 +1,1311 @@ + + + + + + ClapperGtk.EngageLayer + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Class

+

ClapperGtkEngageLayer

+
+ +
+ +
+

+
+ +
+

+ Description + + + [src] + +

+ + 
final class ClapperGtk.EngageLayer : ClapperGtk.LeadContainer
+  implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget {
+  /* No available fields */
+}
+ +
+

A layer with big play button, engaging user to start the playback.

+

ClapperGtkEngageLayer widget is meant to be overlaid on top of +ClapperGtkVideo as a normal (non-fading) overlay. It takes +care of fading itself once clicked and/or playback is started.

+
+ +
+ + + +
+ + +
+ + + +
+

+ Hierarchy + +

+
+ + + + + + +hierarchy + + +this + + +ClapperGtkEngageLayer + + + + + +implements_0 + + +GtkAccessible + + + + + +this--implements_0 + + + + +implements_1 + + +GtkBuildable + + + + + +this--implements_1 + + + + +implements_2 + + +GtkConstraintTarget + + + + + +this--implements_2 + + + + +ancestor_0 + + +ClapperGtkLeadContainer + + + + + +ancestor_0--this + + + + +ancestor_1 + + +ClapperGtkContainer + + + + + +ancestor_1--ancestor_0 + + + + +ancestor_2 + + +GtkWidget + + + + + +ancestor_2--ancestor_1 + + + + +ancestor_3 + + +GInitiallyUnowned + + + + + +ancestor_3--ancestor_2 + + + + +ancestor_4 + + +GObject + + + + + +ancestor_4--ancestor_3 + + + + + +
+
+ + + +
+

+ Ancestors + +

+ +
+ +
+
+ + + + + +
+

+ Implements + +

+ +
+ +
+
+ + + +
+

+ Constructors + +

+ +
+ +
+
clapper_gtk_engage_layer_new
+
+

Creates a new ClapperGtkEngageLayer instance.

+
+
+

+
+
+ +
+
+ + + + + +
+

+ Instance methods + +

+ +
+ +
+ + + +
+
Methods inherited from ClapperGtkLeadContainer (4)
+ +
clapper_gtk_lead_container_get_blocked_actions
+

Get actions that were set for this lead_container to block.

+
+
+

+
+ +
clapper_gtk_lead_container_get_leading
+

Get a whenever lead_container has leadership set.

+
+
+

+
+ +
clapper_gtk_lead_container_set_blocked_actions
+

Set actions that ClapperGtkVideo should skip when GdkEvent which +would normally trigger them happens inside lead_container.

+
+
+

+
+ +
clapper_gtk_lead_container_set_leading
+

Set if lead_container leadership should be enabled.

+
+
+

+
+ +
+
+ + + +
+
Methods inherited from ClapperGtkContainer (10)
+ +
clapper_gtk_container_get_adaptive_height
+

Get a container adaptive height threshold.

+
+
+

+
+ +
clapper_gtk_container_get_adaptive_width
+

Get a container adaptive width threshold.

+
+
+

+
+ +
clapper_gtk_container_get_child
+

Get a child GtkWidget of container.

+
+
+

+
+ +
clapper_gtk_container_get_height_target
+

Get a container height target.

+
+
+

+
+ +
clapper_gtk_container_get_width_target
+

Get a container width target.

+
+
+

+
+ +
clapper_gtk_container_set_adaptive_height
+

Set an adaptive height threshold. When widget is resized to value or lower, +an ClapperGtkContainer::adapt signal will be emitted with TRUE to +notify implementation about mobile adaptation request, otherwise FALSE when +both threshold values are exceeded.

+
+
+

+
+ +
clapper_gtk_container_set_adaptive_width
+

Set an adaptive width threshold. When widget is resized to value or lower, +an ClapperGtkContainer::adapt signal will be emitted with TRUE to +notify implementation about mobile adaptation request, otherwise FALSE when +both threshold values are exceeded.

+
+
+

+
+ +
clapper_gtk_container_set_child
+

Set a child GtkWidget of container.

+
+
+

+
+ +
clapper_gtk_container_set_height_target
+

Same as clapper_gtk_container_set_width_target() but for widget height.

+
+
+

+
+ +
clapper_gtk_container_set_width_target
+

Set a width that container should target. When set container +will not stretch beyond set width while still expanding into +possible boundaries trying to reach its target.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkWidget (161)
+
+ +
+

Please see GtkWidget for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GObject (43)
+
+ +
+

Please see GObject for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GtkAccessible (18)
+
+
gtk_accessible_get_accessible_parent
+
+

Retrieves the accessible parent for an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_accessible_role
+
+

Retrieves the accessible role of an accessible object.

+
+
+

+
+
gtk_accessible_get_at_context
+
+

Retrieves the accessible implementation for the given GtkAccessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_bounds
+
+

Queries the coordinates and dimensions of this accessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_first_accessible_child
+
+

Retrieves the first accessible child of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_next_accessible_sibling
+
+

Retrieves the next accessible sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_platform_state
+
+

Query a platform state, such as focus.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_reset_property
+
+

Resets the accessible property to its default value.

+
+
+

+
+
gtk_accessible_reset_relation
+
+

Resets the accessible relation to its default value.

+
+
+

+
+
gtk_accessible_reset_state
+
+

Resets the accessible state to its default value.

+
+
+

+
+
gtk_accessible_set_accessible_parent
+
+

Sets the parent and sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_next_accessible_sibling
+
+

Updates the next accessible sibling of self.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_property
+
+

Updates a list of accessible properties.

+
+
+

+
+
gtk_accessible_update_property_value
+
+

Updates an array of accessible properties.

+
+
+

+
+
gtk_accessible_update_relation
+
+

Updates a list of accessible relations.

+
+
+

+
+
gtk_accessible_update_relation_value
+
+

Updates an array of accessible relations.

+
+
+

+
+
gtk_accessible_update_state
+
+

Updates a list of accessible states. See the GtkAccessibleState +documentation for the value types of accessible states.

+
+
+

+
+
gtk_accessible_update_state_value
+
+

Updates an array of accessible states.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkBuildable (1)
+
+
gtk_buildable_get_buildable_id
+
+

Gets the ID of the buildable object.

+
+
+

+
+ +
+
+ + + + +
+ + + +
+

+ Properties + +

+ + + + + +
+
Properties inherited from ClapperGtkLeadContainer (2)
+ +
ClapperGtk.LeadContainer:blocked-actions
+

Mask of actions that container blocks from being triggered on video.

+
+
+

+
+ +
ClapperGtk.LeadContainer:leading
+

Width that container should target.

+
+
+

+
+ +
+
+ + + +
+
Properties inherited from ClapperGtkContainer (4)
+ +
ClapperGtk.Container:adaptive-height
+

Adaptive height threshold that triggers ClapperGtkContainer::adapt signal.

+
+
+

+
+ +
ClapperGtk.Container:adaptive-width
+

Adaptive width threshold that triggers ClapperGtkContainer::adapt signal.

+
+
+

+
+ +
ClapperGtk.Container:height-target
+

Height that container should target.

+
+
+

+
+ +
ClapperGtk.Container:width-target
+

Width that container should target.

+
+
+

+
+ +
+
+ + + +
Properties inherited from GtkWidget (34)
+
+
Gtk.Widget:can-focus
+
+

Whether the widget or any of its descendents can accept +the input focus.

+
+
+

+
+
Gtk.Widget:can-target
+
+

Whether the widget can receive pointer events.

+
+
+

+
+
Gtk.Widget:css-classes
+
+

A list of css classes applied to this widget.

+
+
+

+
+
Gtk.Widget:css-name
+
+

The name of this widget in the CSS tree.

+
+
+

+
+
Gtk.Widget:cursor
+
+

The cursor used by widget.

+
+
+

+
+
Gtk.Widget:focus-on-click
+
+

Whether the widget should grab focus when it is clicked with the mouse.

+
+
+

+
+
Gtk.Widget:focusable
+
+

Whether this widget itself will accept the input focus.

+
+
+

+
+
Gtk.Widget:halign
+
+

How to distribute horizontal space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:has-default
+
+

Whether the widget is the default widget.

+
+
+

+
+
Gtk.Widget:has-focus
+
+

Whether the widget has the input focus.

+
+
+

+
+
Gtk.Widget:has-tooltip
+
+

Enables or disables the emission of the ::query-tooltip signal on widget.

+
+
+

+
+
Gtk.Widget:height-request
+
+

Override for height request of the widget.

+
+
+

+
+
Gtk.Widget:hexpand
+
+

Whether to expand horizontally.

+
+
+

+
+
Gtk.Widget:hexpand-set
+
+

Whether to use the hexpand property.

+
+
+

+
+
Gtk.Widget:layout-manager
+
+

The GtkLayoutManager instance to use to compute the preferred size +of the widget, and allocate its children.

+
+
+

+
+
Gtk.Widget:margin-bottom
+
+

Margin on bottom side of widget.

+
+
+

+
+
Gtk.Widget:margin-end
+
+

Margin on end of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-start
+
+

Margin on start of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-top
+
+

Margin on top side of widget.

+
+
+

+
+
Gtk.Widget:name
+
+

The name of the widget.

+
+
+

+
+
Gtk.Widget:opacity
+
+

The requested opacity of the widget.

+
+
+

+
+
Gtk.Widget:overflow
+
+

How content outside the widget’s content area is treated.

+
+
+

+
+
Gtk.Widget:parent
+
+

The parent widget of this widget.

+
+
+

+
+
Gtk.Widget:receives-default
+
+

Whether the widget will receive the default action when it is focused.

+
+
+

+
+
Gtk.Widget:root
+
+

The GtkRoot widget of the widget tree containing this widget.

+
+
+

+
+
Gtk.Widget:scale-factor
+
+

The scale factor of the widget.

+
+
+

+
+
Gtk.Widget:sensitive
+
+

Whether the widget responds to input.

+
+
+

+
+
Gtk.Widget:tooltip-markup
+
+

Sets the text of tooltip to be the given string, which is marked up +with Pango markup.

+
+
+

+
+
Gtk.Widget:tooltip-text
+
+

Sets the text of tooltip to be the given string.

+
+
+

+
+
Gtk.Widget:valign
+
+

How to distribute vertical space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:vexpand
+
+

Whether to expand vertically.

+
+
+

+
+
Gtk.Widget:vexpand-set
+
+

Whether to use the vexpand property.

+
+
+

+
+
Gtk.Widget:visible
+
+

Whether the widget is visible.

+
+
+

+
+
Gtk.Widget:width-request
+
+

Override for width request of the widget.

+
+
+

+
+ +
+
+ + + + + + + + + +
Properties inherited from GtkAccessible (1)
+
+
Gtk.Accessible:accessible-role
+
+

The accessible role of the given GtkAccessible implementation.

+
+
+

+
+ +
+
+ + + + + + + +
+ + + +
+

+ Signals + +

+ + + + + + + +
+
Signals inherited from ClapperGtkContainer (1)
+ +
ClapperGtkContainer::adapt
+

A helper signal for implementing mobile/narrow adaptive +behavior on descendants.

+
+
+

+
+ +
+
+ + + +
Signals inherited from GtkWidget (13)
+
+
GtkWidget::destroy
+
+

Signals that all holders of a reference to the widget should release +the reference that they hold.

+
+
+

+
+
GtkWidget::direction-changed
+
+

Emitted when the text direction of a widget changes.

+
+
+

+
+
GtkWidget::hide
+
+

Emitted when widget is hidden.

+
+
+

+
+
GtkWidget::keynav-failed
+
+

Emitted if keyboard navigation fails.

+
+
+

+
+
GtkWidget::map
+
+

Emitted when widget is going to be mapped.

+
+
+

+
+
GtkWidget::mnemonic-activate
+
+

Emitted when a widget is activated via a mnemonic.

+
+
+

+
+
GtkWidget::move-focus
+
+

Emitted when the focus is moved.

+
+
+

+
+
GtkWidget::query-tooltip
+
+

Emitted when the widget’s tooltip is about to be shown.

+
+
+

+
+
GtkWidget::realize
+
+

Emitted when widget is associated with a GdkSurface.

+
+
+

+
+
GtkWidget::show
+
+

Emitted when widget is shown.

+
+
+

+
+
GtkWidget::state-flags-changed
+
+

Emitted when the widget state changes.

+
+
+

+
+
GtkWidget::unmap
+
+

Emitted when widget is going to be unmapped.

+
+
+

+
+
GtkWidget::unrealize
+
+

Emitted when the GdkSurface associated with widget is destroyed.

+
+
+

+
+ +
+
+ + + + + +
Signals inherited from GObject (1)
+
+
GObject::notify
+
+

The notify signal is emitted on an object when one of its properties has +its value set through g_object_set_property(), g_object_set(), et al.

+
+
+

+
+ +
+
+ + + + + + + + + + + +
+ + + +
+

+ Class structure + +

+ +
+ 
struct ClapperGtkEngageLayerClass {
+  ClapperGtkLeadContainerClass parent_class;
+  
+}
+
+ +
+ No description available. +
+ + +
+
Class members
+ +
+ +
parent_class: ClapperGtkLeadContainerClass
+
No description available.
+ + +
+ +
+ + + + + + +
+
+ + + +
+ +
+ + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/class.LeadContainer.html b/doc/clapper-gtk/class.LeadContainer.html new file mode 100644 index 00000000..71473c2f --- /dev/null +++ b/doc/clapper-gtk/class.LeadContainer.html @@ -0,0 +1,1343 @@ + + + + + + ClapperGtk.LeadContainer + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Class

+

ClapperGtkLeadContainer

+
+ +
+ +
+

+
+ +
+

+ Description + + + [src] + +

+ + 
class ClapperGtk.LeadContainer : ClapperGtk.Container
+  implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget {
+  /* No available fields */
+}
+ +
+

A ClapperGtkContainer that can take priority in user interactions with the ClapperGtkVideo.

+

ClapperGtkLeadContainer is a special type of ClapperGtkContainer that can +lead in interaction events. When “leading”, it is assumed that user interactions +over it which would normally trigger actions can be blocked/ignored when set in mask +of actions that this widget should block.

+

This kind of container is useful when creating some statically visible overlays +covering top of ClapperGtkVideo that you want to take priority instead of +triggering default actions such as toggle play on click or revealing fading overlays.

+

For more info how container widget works see ClapperGtkContainer documentation.

+
+ +
+ + + +
+ + +
+ + + +
+

+ Hierarchy + +

+
+ + + + + + +hierarchy + + +this + + +ClapperGtkLeadContainer + + + + + +implements_0 + + +GtkAccessible + + + + + +this--implements_0 + + + + +implements_1 + + +GtkBuildable + + + + + +this--implements_1 + + + + +implements_2 + + +GtkConstraintTarget + + + + + +this--implements_2 + + + + +ancestor_0 + + +ClapperGtkContainer + + + + + +ancestor_0--this + + + + +ancestor_1 + + +GtkWidget + + + + + +ancestor_1--ancestor_0 + + + + +ancestor_2 + + +GInitiallyUnowned + + + + + +ancestor_2--ancestor_1 + + + + +ancestor_3 + + +GObject + + + + + +ancestor_3--ancestor_2 + + + + + +
+
+ + + +
+

+ Ancestors + +

+ +
+ +
+
+ + + +
+

Descendants

+
+ +
+
+ + + +
+

+ Implements + +

+ +
+ +
+
+ + + +
+

+ Constructors + +

+ +
+ +
+
clapper_gtk_lead_container_new
+
+

Creates a new ClapperGtkLeadContainer instance.

+
+
+

+
+
+ +
+
+ + + + + +
+

+ Instance methods + +

+ +
+ +
+
clapper_gtk_lead_container_get_blocked_actions
+
+

Get actions that were set for this lead_container to block.

+
+
+

+
+
+ +
+
clapper_gtk_lead_container_get_leading
+
+

Get a whenever lead_container has leadership set.

+
+
+

+
+
+ +
+
clapper_gtk_lead_container_set_blocked_actions
+
+

Set actions that ClapperGtkVideo should skip when GdkEvent which +would normally trigger them happens inside lead_container.

+
+
+

+
+
+ +
+
clapper_gtk_lead_container_set_leading
+
+

Set if lead_container leadership should be enabled.

+
+
+

+
+
+ +
+ + + +
+
Methods inherited from ClapperGtkContainer (10)
+ +
clapper_gtk_container_get_adaptive_height
+

Get a container adaptive height threshold.

+
+
+

+
+ +
clapper_gtk_container_get_adaptive_width
+

Get a container adaptive width threshold.

+
+
+

+
+ +
clapper_gtk_container_get_child
+

Get a child GtkWidget of container.

+
+
+

+
+ +
clapper_gtk_container_get_height_target
+

Get a container height target.

+
+
+

+
+ +
clapper_gtk_container_get_width_target
+

Get a container width target.

+
+
+

+
+ +
clapper_gtk_container_set_adaptive_height
+

Set an adaptive height threshold. When widget is resized to value or lower, +an ClapperGtkContainer::adapt signal will be emitted with TRUE to +notify implementation about mobile adaptation request, otherwise FALSE when +both threshold values are exceeded.

+
+
+

+
+ +
clapper_gtk_container_set_adaptive_width
+

Set an adaptive width threshold. When widget is resized to value or lower, +an ClapperGtkContainer::adapt signal will be emitted with TRUE to +notify implementation about mobile adaptation request, otherwise FALSE when +both threshold values are exceeded.

+
+
+

+
+ +
clapper_gtk_container_set_child
+

Set a child GtkWidget of container.

+
+
+

+
+ +
clapper_gtk_container_set_height_target
+

Same as clapper_gtk_container_set_width_target() but for widget height.

+
+
+

+
+ +
clapper_gtk_container_set_width_target
+

Set a width that container should target. When set container +will not stretch beyond set width while still expanding into +possible boundaries trying to reach its target.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkWidget (161)
+
+ +
+

Please see GtkWidget for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GObject (43)
+
+ +
+

Please see GObject for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GtkAccessible (18)
+
+
gtk_accessible_get_accessible_parent
+
+

Retrieves the accessible parent for an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_accessible_role
+
+

Retrieves the accessible role of an accessible object.

+
+
+

+
+
gtk_accessible_get_at_context
+
+

Retrieves the accessible implementation for the given GtkAccessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_bounds
+
+

Queries the coordinates and dimensions of this accessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_first_accessible_child
+
+

Retrieves the first accessible child of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_next_accessible_sibling
+
+

Retrieves the next accessible sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_platform_state
+
+

Query a platform state, such as focus.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_reset_property
+
+

Resets the accessible property to its default value.

+
+
+

+
+
gtk_accessible_reset_relation
+
+

Resets the accessible relation to its default value.

+
+
+

+
+
gtk_accessible_reset_state
+
+

Resets the accessible state to its default value.

+
+
+

+
+
gtk_accessible_set_accessible_parent
+
+

Sets the parent and sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_next_accessible_sibling
+
+

Updates the next accessible sibling of self.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_property
+
+

Updates a list of accessible properties.

+
+
+

+
+
gtk_accessible_update_property_value
+
+

Updates an array of accessible properties.

+
+
+

+
+
gtk_accessible_update_relation
+
+

Updates a list of accessible relations.

+
+
+

+
+
gtk_accessible_update_relation_value
+
+

Updates an array of accessible relations.

+
+
+

+
+
gtk_accessible_update_state
+
+

Updates a list of accessible states. See the GtkAccessibleState +documentation for the value types of accessible states.

+
+
+

+
+
gtk_accessible_update_state_value
+
+

Updates an array of accessible states.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkBuildable (1)
+
+
gtk_buildable_get_buildable_id
+
+

Gets the ID of the buildable object.

+
+
+

+
+ +
+
+ + + + +
+ + + +
+

+ Properties + +

+ + +
+ +
+
ClapperGtk.LeadContainer:blocked-actions
+
+

Mask of actions that container blocks from being triggered on video.

+
+
+

+
+
+ +
+
ClapperGtk.LeadContainer:leading
+
+

Width that container should target.

+
+
+

+
+
+ +
+ + + + +
+
Properties inherited from ClapperGtkContainer (4)
+ +
ClapperGtk.Container:adaptive-height
+

Adaptive height threshold that triggers ClapperGtkContainer::adapt signal.

+
+
+

+
+ +
ClapperGtk.Container:adaptive-width
+

Adaptive width threshold that triggers ClapperGtkContainer::adapt signal.

+
+
+

+
+ +
ClapperGtk.Container:height-target
+

Height that container should target.

+
+
+

+
+ +
ClapperGtk.Container:width-target
+

Width that container should target.

+
+
+

+
+ +
+
+ + + +
Properties inherited from GtkWidget (34)
+
+
Gtk.Widget:can-focus
+
+

Whether the widget or any of its descendents can accept +the input focus.

+
+
+

+
+
Gtk.Widget:can-target
+
+

Whether the widget can receive pointer events.

+
+
+

+
+
Gtk.Widget:css-classes
+
+

A list of css classes applied to this widget.

+
+
+

+
+
Gtk.Widget:css-name
+
+

The name of this widget in the CSS tree.

+
+
+

+
+
Gtk.Widget:cursor
+
+

The cursor used by widget.

+
+
+

+
+
Gtk.Widget:focus-on-click
+
+

Whether the widget should grab focus when it is clicked with the mouse.

+
+
+

+
+
Gtk.Widget:focusable
+
+

Whether this widget itself will accept the input focus.

+
+
+

+
+
Gtk.Widget:halign
+
+

How to distribute horizontal space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:has-default
+
+

Whether the widget is the default widget.

+
+
+

+
+
Gtk.Widget:has-focus
+
+

Whether the widget has the input focus.

+
+
+

+
+
Gtk.Widget:has-tooltip
+
+

Enables or disables the emission of the ::query-tooltip signal on widget.

+
+
+

+
+
Gtk.Widget:height-request
+
+

Override for height request of the widget.

+
+
+

+
+
Gtk.Widget:hexpand
+
+

Whether to expand horizontally.

+
+
+

+
+
Gtk.Widget:hexpand-set
+
+

Whether to use the hexpand property.

+
+
+

+
+
Gtk.Widget:layout-manager
+
+

The GtkLayoutManager instance to use to compute the preferred size +of the widget, and allocate its children.

+
+
+

+
+
Gtk.Widget:margin-bottom
+
+

Margin on bottom side of widget.

+
+
+

+
+
Gtk.Widget:margin-end
+
+

Margin on end of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-start
+
+

Margin on start of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-top
+
+

Margin on top side of widget.

+
+
+

+
+
Gtk.Widget:name
+
+

The name of the widget.

+
+
+

+
+
Gtk.Widget:opacity
+
+

The requested opacity of the widget.

+
+
+

+
+
Gtk.Widget:overflow
+
+

How content outside the widget’s content area is treated.

+
+
+

+
+
Gtk.Widget:parent
+
+

The parent widget of this widget.

+
+
+

+
+
Gtk.Widget:receives-default
+
+

Whether the widget will receive the default action when it is focused.

+
+
+

+
+
Gtk.Widget:root
+
+

The GtkRoot widget of the widget tree containing this widget.

+
+
+

+
+
Gtk.Widget:scale-factor
+
+

The scale factor of the widget.

+
+
+

+
+
Gtk.Widget:sensitive
+
+

Whether the widget responds to input.

+
+
+

+
+
Gtk.Widget:tooltip-markup
+
+

Sets the text of tooltip to be the given string, which is marked up +with Pango markup.

+
+
+

+
+
Gtk.Widget:tooltip-text
+
+

Sets the text of tooltip to be the given string.

+
+
+

+
+
Gtk.Widget:valign
+
+

How to distribute vertical space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:vexpand
+
+

Whether to expand vertically.

+
+
+

+
+
Gtk.Widget:vexpand-set
+
+

Whether to use the vexpand property.

+
+
+

+
+
Gtk.Widget:visible
+
+

Whether the widget is visible.

+
+
+

+
+
Gtk.Widget:width-request
+
+

Override for width request of the widget.

+
+
+

+
+ +
+
+ + + + + + + + + +
Properties inherited from GtkAccessible (1)
+
+
Gtk.Accessible:accessible-role
+
+

The accessible role of the given GtkAccessible implementation.

+
+
+

+
+ +
+
+ + + + + + + +
+ + + +
+

+ Signals + +

+ + + + + +
+
Signals inherited from ClapperGtkContainer (1)
+ +
ClapperGtkContainer::adapt
+

A helper signal for implementing mobile/narrow adaptive +behavior on descendants.

+
+
+

+
+ +
+
+ + + +
Signals inherited from GtkWidget (13)
+
+
GtkWidget::destroy
+
+

Signals that all holders of a reference to the widget should release +the reference that they hold.

+
+
+

+
+
GtkWidget::direction-changed
+
+

Emitted when the text direction of a widget changes.

+
+
+

+
+
GtkWidget::hide
+
+

Emitted when widget is hidden.

+
+
+

+
+
GtkWidget::keynav-failed
+
+

Emitted if keyboard navigation fails.

+
+
+

+
+
GtkWidget::map
+
+

Emitted when widget is going to be mapped.

+
+
+

+
+
GtkWidget::mnemonic-activate
+
+

Emitted when a widget is activated via a mnemonic.

+
+
+

+
+
GtkWidget::move-focus
+
+

Emitted when the focus is moved.

+
+
+

+
+
GtkWidget::query-tooltip
+
+

Emitted when the widget’s tooltip is about to be shown.

+
+
+

+
+
GtkWidget::realize
+
+

Emitted when widget is associated with a GdkSurface.

+
+
+

+
+
GtkWidget::show
+
+

Emitted when widget is shown.

+
+
+

+
+
GtkWidget::state-flags-changed
+
+

Emitted when the widget state changes.

+
+
+

+
+
GtkWidget::unmap
+
+

Emitted when widget is going to be unmapped.

+
+
+

+
+
GtkWidget::unrealize
+
+

Emitted when the GdkSurface associated with widget is destroyed.

+
+
+

+
+ +
+
+ + + + + +
Signals inherited from GObject (1)
+
+
GObject::notify
+
+

The notify signal is emitted on an object when one of its properties has +its value set through g_object_set_property(), g_object_set(), et al.

+
+
+

+
+ +
+
+ + + + + + + + + + + +
+ + + +
+

+ Class structure + +

+ +
+ 
struct ClapperGtkLeadContainerClass {
+  ClapperGtkContainerClass parent_class;
+  
+}
+
+ +
+ No description available. +
+ + +
+
Class members
+ +
+ +
parent_class: ClapperGtkContainerClass
+
No description available.
+ + +
+ +
+ + + + + + +
+
+ + + +
+ +
+ + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/class.NextItemButton.html b/doc/clapper-gtk/class.NextItemButton.html new file mode 100644 index 00000000..8b5083ac --- /dev/null +++ b/doc/clapper-gtk/class.NextItemButton.html @@ -0,0 +1,1352 @@ + + + + + + ClapperGtk.NextItemButton + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Class

+

ClapperGtkNextItemButton

+
+ +
+ +
+

+
+ +
+

+ Description + + + [src] + +

+ + 
final class ClapperGtk.NextItemButton : ClapperGtk.SkipItemButton
+  implements Gtk.Accessible, Gtk.Actionable, Gtk.Buildable, Gtk.ConstraintTarget {
+  /* No available fields */
+}
+ +
+

A GtkButton for selecting next queue item.

+
+ +
+ + + +
+ + +
+ + + +
+

+ Hierarchy + +

+
+ + + + + + +hierarchy + + +this + + +ClapperGtkNextItemButton + + + + + +implements_0 + + +GtkAccessible + + + + + +this--implements_0 + + + + +implements_1 + + +GtkActionable + + + + + +this--implements_1 + + + + +implements_2 + + +GtkBuildable + + + + + +this--implements_2 + + + + +implements_3 + + +GtkConstraintTarget + + + + + +this--implements_3 + + + + +ancestor_0 + + +ClapperGtkSkipItemButton + + + + + +ancestor_0--this + + + + +ancestor_1 + + +GtkButton + + + + + +ancestor_1--ancestor_0 + + + + +ancestor_2 + + +GtkWidget + + + + + +ancestor_2--ancestor_1 + + + + +ancestor_3 + + +GInitiallyUnowned + + + + + +ancestor_3--ancestor_2 + + + + +ancestor_4 + + +GObject + + + + + +ancestor_4--ancestor_3 + + + + + +
+
+ + + +
+

+ Ancestors + +

+ +
+ +
+
+ + + + + +
+

+ Implements + +

+ +
+ +
+
+ + + +
+

+ Constructors + +

+ +
+ +
+
clapper_gtk_next_item_button_new
+
+

Creates a new GtkWidget with button to play next ClapperMediaItem.

+
+
+

+
+
+ +
+
+ + + + + +
+

+ Instance methods + +

+ +
+ +
+ + + + + +
Methods inherited from GtkButton (10)
+
+
gtk_button_get_child
+
+

Gets the child widget of button.

+
+
+

+
+
gtk_button_get_has_frame
+
+

Returns whether the button has a frame.

+
+
+

+
+
gtk_button_get_icon_name
+
+

Returns the icon name of the button.

+
+
+

+
+
gtk_button_get_label
+
+

Fetches the text from the label of the button.

+
+
+

+
+
gtk_button_get_use_underline
+
+

Gets whether underlines are interpreted as mnemonics.

+
+
+

+
+
gtk_button_set_child
+
+

Sets the child widget of button.

+
+
+

+
+
gtk_button_set_has_frame
+
+

Sets the style of the button.

+
+
+

+
+
gtk_button_set_icon_name
+
+

Adds a GtkImage with the given icon name as a child.

+
+
+

+
+
gtk_button_set_label
+
+

Sets the text of the label of the button to label.

+
+
+

+
+
gtk_button_set_use_underline
+
+

Sets whether to use underlines as mnemonics.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkWidget (161)
+
+ +
+

Please see GtkWidget for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GObject (43)
+
+ +
+

Please see GObject for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GtkAccessible (18)
+
+
gtk_accessible_get_accessible_parent
+
+

Retrieves the accessible parent for an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_accessible_role
+
+

Retrieves the accessible role of an accessible object.

+
+
+

+
+
gtk_accessible_get_at_context
+
+

Retrieves the accessible implementation for the given GtkAccessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_bounds
+
+

Queries the coordinates and dimensions of this accessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_first_accessible_child
+
+

Retrieves the first accessible child of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_next_accessible_sibling
+
+

Retrieves the next accessible sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_platform_state
+
+

Query a platform state, such as focus.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_reset_property
+
+

Resets the accessible property to its default value.

+
+
+

+
+
gtk_accessible_reset_relation
+
+

Resets the accessible relation to its default value.

+
+
+

+
+
gtk_accessible_reset_state
+
+

Resets the accessible state to its default value.

+
+
+

+
+
gtk_accessible_set_accessible_parent
+
+

Sets the parent and sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_next_accessible_sibling
+
+

Updates the next accessible sibling of self.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_property
+
+

Updates a list of accessible properties.

+
+
+

+
+
gtk_accessible_update_property_value
+
+

Updates an array of accessible properties.

+
+
+

+
+
gtk_accessible_update_relation
+
+

Updates a list of accessible relations.

+
+
+

+
+
gtk_accessible_update_relation_value
+
+

Updates an array of accessible relations.

+
+
+

+
+
gtk_accessible_update_state
+
+

Updates a list of accessible states. See the GtkAccessibleState +documentation for the value types of accessible states.

+
+
+

+
+
gtk_accessible_update_state_value
+
+

Updates an array of accessible states.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkActionable (6)
+
+
gtk_actionable_get_action_name
+
+

Gets the action name for actionable.

+
+
+

+
+
gtk_actionable_get_action_target_value
+
+

Gets the current target value of actionable.

+
+
+

+
+
gtk_actionable_set_action_name
+
+

Specifies the name of the action with which this widget should be associated.

+
+
+

+
+
gtk_actionable_set_action_target
+
+

Sets the target of an actionable widget.

+
+
+

+
+
gtk_actionable_set_action_target_value
+
+

Sets the target value of an actionable widget.

+
+
+

+
+
gtk_actionable_set_detailed_action_name
+
+

Sets the action-name and associated string target value of an +actionable widget.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkBuildable (1)
+
+
gtk_buildable_get_buildable_id
+
+

Gets the ID of the buildable object.

+
+
+

+
+ +
+
+ + + + +
+ + + +
+

+ Properties + +

+ + + + + + + +
Properties inherited from GtkButton (5)
+
+
Gtk.Button:child
+
+

The child widget.

+
+
+

+
+
Gtk.Button:has-frame
+
+

Whether the button has a frame.

+
+
+

+
+
Gtk.Button:icon-name
+
+

The name of the icon used to automatically populate the button.

+
+
+

+
+
Gtk.Button:label
+
+

Text of the label inside the button, if the button contains a label widget.

+
+
+

+
+
Gtk.Button:use-underline
+
+

If set, an underline in the text indicates that the following character is +to be used as mnemonic.

+
+
+

+
+ +
+
+ + + +
Properties inherited from GtkWidget (34)
+
+
Gtk.Widget:can-focus
+
+

Whether the widget or any of its descendents can accept +the input focus.

+
+
+

+
+
Gtk.Widget:can-target
+
+

Whether the widget can receive pointer events.

+
+
+

+
+
Gtk.Widget:css-classes
+
+

A list of css classes applied to this widget.

+
+
+

+
+
Gtk.Widget:css-name
+
+

The name of this widget in the CSS tree.

+
+
+

+
+
Gtk.Widget:cursor
+
+

The cursor used by widget.

+
+
+

+
+
Gtk.Widget:focus-on-click
+
+

Whether the widget should grab focus when it is clicked with the mouse.

+
+
+

+
+
Gtk.Widget:focusable
+
+

Whether this widget itself will accept the input focus.

+
+
+

+
+
Gtk.Widget:halign
+
+

How to distribute horizontal space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:has-default
+
+

Whether the widget is the default widget.

+
+
+

+
+
Gtk.Widget:has-focus
+
+

Whether the widget has the input focus.

+
+
+

+
+
Gtk.Widget:has-tooltip
+
+

Enables or disables the emission of the ::query-tooltip signal on widget.

+
+
+

+
+
Gtk.Widget:height-request
+
+

Override for height request of the widget.

+
+
+

+
+
Gtk.Widget:hexpand
+
+

Whether to expand horizontally.

+
+
+

+
+
Gtk.Widget:hexpand-set
+
+

Whether to use the hexpand property.

+
+
+

+
+
Gtk.Widget:layout-manager
+
+

The GtkLayoutManager instance to use to compute the preferred size +of the widget, and allocate its children.

+
+
+

+
+
Gtk.Widget:margin-bottom
+
+

Margin on bottom side of widget.

+
+
+

+
+
Gtk.Widget:margin-end
+
+

Margin on end of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-start
+
+

Margin on start of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-top
+
+

Margin on top side of widget.

+
+
+

+
+
Gtk.Widget:name
+
+

The name of the widget.

+
+
+

+
+
Gtk.Widget:opacity
+
+

The requested opacity of the widget.

+
+
+

+
+
Gtk.Widget:overflow
+
+

How content outside the widget’s content area is treated.

+
+
+

+
+
Gtk.Widget:parent
+
+

The parent widget of this widget.

+
+
+

+
+
Gtk.Widget:receives-default
+
+

Whether the widget will receive the default action when it is focused.

+
+
+

+
+
Gtk.Widget:root
+
+

The GtkRoot widget of the widget tree containing this widget.

+
+
+

+
+
Gtk.Widget:scale-factor
+
+

The scale factor of the widget.

+
+
+

+
+
Gtk.Widget:sensitive
+
+

Whether the widget responds to input.

+
+
+

+
+
Gtk.Widget:tooltip-markup
+
+

Sets the text of tooltip to be the given string, which is marked up +with Pango markup.

+
+
+

+
+
Gtk.Widget:tooltip-text
+
+

Sets the text of tooltip to be the given string.

+
+
+

+
+
Gtk.Widget:valign
+
+

How to distribute vertical space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:vexpand
+
+

Whether to expand vertically.

+
+
+

+
+
Gtk.Widget:vexpand-set
+
+

Whether to use the vexpand property.

+
+
+

+
+
Gtk.Widget:visible
+
+

Whether the widget is visible.

+
+
+

+
+
Gtk.Widget:width-request
+
+

Override for width request of the widget.

+
+
+

+
+ +
+
+ + + + + + + + + +
Properties inherited from GtkAccessible (1)
+
+
Gtk.Accessible:accessible-role
+
+

The accessible role of the given GtkAccessible implementation.

+
+
+

+
+ +
+
+ + + +
Properties inherited from GtkActionable (2)
+
+
Gtk.Actionable:action-name
+
+ No description available. +
+
+

+
+
Gtk.Actionable:action-target
+
+ No description available. +
+
+

+
+ +
+
+ + + + + + + +
+ + + +
+

+ Signals + +

+ + + + + + + +
Signals inherited from GtkButton (2)
+
+
GtkButton::activate
+
+

Emitted to animate press then release.

+
+
+

+
+
GtkButton::clicked
+
+

Emitted when the button has been activated (pressed and released).

+
+
+

+
+ +
+
+ + + +
Signals inherited from GtkWidget (13)
+
+
GtkWidget::destroy
+
+

Signals that all holders of a reference to the widget should release +the reference that they hold.

+
+
+

+
+
GtkWidget::direction-changed
+
+

Emitted when the text direction of a widget changes.

+
+
+

+
+
GtkWidget::hide
+
+

Emitted when widget is hidden.

+
+
+

+
+
GtkWidget::keynav-failed
+
+

Emitted if keyboard navigation fails.

+
+
+

+
+
GtkWidget::map
+
+

Emitted when widget is going to be mapped.

+
+
+

+
+
GtkWidget::mnemonic-activate
+
+

Emitted when a widget is activated via a mnemonic.

+
+
+

+
+
GtkWidget::move-focus
+
+

Emitted when the focus is moved.

+
+
+

+
+
GtkWidget::query-tooltip
+
+

Emitted when the widget’s tooltip is about to be shown.

+
+
+

+
+
GtkWidget::realize
+
+

Emitted when widget is associated with a GdkSurface.

+
+
+

+
+
GtkWidget::show
+
+

Emitted when widget is shown.

+
+
+

+
+
GtkWidget::state-flags-changed
+
+

Emitted when the widget state changes.

+
+
+

+
+
GtkWidget::unmap
+
+

Emitted when widget is going to be unmapped.

+
+
+

+
+
GtkWidget::unrealize
+
+

Emitted when the GdkSurface associated with widget is destroyed.

+
+
+

+
+ +
+
+ + + + + +
Signals inherited from GObject (1)
+
+
GObject::notify
+
+

The notify signal is emitted on an object when one of its properties has +its value set through g_object_set_property(), g_object_set(), et al.

+
+
+

+
+ +
+
+ + + + + + + + + + + + + +
+ + + +
+

+ Class structure + +

+ +
+ 
struct ClapperGtkNextItemButtonClass {
+  ClapperGtkSkipItemButtonClass parent_class;
+  
+}
+
+ +
+ No description available. +
+ + +
+
Class members
+ +
+ +
parent_class: ClapperGtkSkipItemButtonClass
+
No description available.
+ + +
+ +
+ + + + + + +
+
+ + + +
+ +
+ + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/class.PreviousItemButton.html b/doc/clapper-gtk/class.PreviousItemButton.html new file mode 100644 index 00000000..fad90e26 --- /dev/null +++ b/doc/clapper-gtk/class.PreviousItemButton.html @@ -0,0 +1,1352 @@ + + + + + + ClapperGtk.PreviousItemButton + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Class

+

ClapperGtkPreviousItemButton

+
+ +
+ +
+

+
+ +
+

+ Description + + + [src] + +

+ + 
final class ClapperGtk.PreviousItemButton : ClapperGtk.SkipItemButton
+  implements Gtk.Accessible, Gtk.Actionable, Gtk.Buildable, Gtk.ConstraintTarget {
+  /* No available fields */
+}
+ +
+

A GtkButton for selecting previous queue item.

+
+ +
+ + + +
+ + +
+ + + +
+

+ Hierarchy + +

+
+ + + + + + +hierarchy + + +this + + +ClapperGtkPreviousItemButton + + + + + +implements_0 + + +GtkAccessible + + + + + +this--implements_0 + + + + +implements_1 + + +GtkActionable + + + + + +this--implements_1 + + + + +implements_2 + + +GtkBuildable + + + + + +this--implements_2 + + + + +implements_3 + + +GtkConstraintTarget + + + + + +this--implements_3 + + + + +ancestor_0 + + +ClapperGtkSkipItemButton + + + + + +ancestor_0--this + + + + +ancestor_1 + + +GtkButton + + + + + +ancestor_1--ancestor_0 + + + + +ancestor_2 + + +GtkWidget + + + + + +ancestor_2--ancestor_1 + + + + +ancestor_3 + + +GInitiallyUnowned + + + + + +ancestor_3--ancestor_2 + + + + +ancestor_4 + + +GObject + + + + + +ancestor_4--ancestor_3 + + + + + +
+
+ + + +
+

+ Ancestors + +

+ +
+ +
+
+ + + + + +
+

+ Implements + +

+ +
+ +
+
+ + + +
+

+ Constructors + +

+ +
+ +
+
clapper_gtk_previous_item_button_new
+
+

Creates a new GtkWidget with button to play previous ClapperMediaItem.

+
+
+

+
+
+ +
+
+ + + + + +
+

+ Instance methods + +

+ +
+ +
+ + + + + +
Methods inherited from GtkButton (10)
+
+
gtk_button_get_child
+
+

Gets the child widget of button.

+
+
+

+
+
gtk_button_get_has_frame
+
+

Returns whether the button has a frame.

+
+
+

+
+
gtk_button_get_icon_name
+
+

Returns the icon name of the button.

+
+
+

+
+
gtk_button_get_label
+
+

Fetches the text from the label of the button.

+
+
+

+
+
gtk_button_get_use_underline
+
+

Gets whether underlines are interpreted as mnemonics.

+
+
+

+
+
gtk_button_set_child
+
+

Sets the child widget of button.

+
+
+

+
+
gtk_button_set_has_frame
+
+

Sets the style of the button.

+
+
+

+
+
gtk_button_set_icon_name
+
+

Adds a GtkImage with the given icon name as a child.

+
+
+

+
+
gtk_button_set_label
+
+

Sets the text of the label of the button to label.

+
+
+

+
+
gtk_button_set_use_underline
+
+

Sets whether to use underlines as mnemonics.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkWidget (161)
+
+ +
+

Please see GtkWidget for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GObject (43)
+
+ +
+

Please see GObject for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GtkAccessible (18)
+
+
gtk_accessible_get_accessible_parent
+
+

Retrieves the accessible parent for an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_accessible_role
+
+

Retrieves the accessible role of an accessible object.

+
+
+

+
+
gtk_accessible_get_at_context
+
+

Retrieves the accessible implementation for the given GtkAccessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_bounds
+
+

Queries the coordinates and dimensions of this accessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_first_accessible_child
+
+

Retrieves the first accessible child of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_next_accessible_sibling
+
+

Retrieves the next accessible sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_platform_state
+
+

Query a platform state, such as focus.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_reset_property
+
+

Resets the accessible property to its default value.

+
+
+

+
+
gtk_accessible_reset_relation
+
+

Resets the accessible relation to its default value.

+
+
+

+
+
gtk_accessible_reset_state
+
+

Resets the accessible state to its default value.

+
+
+

+
+
gtk_accessible_set_accessible_parent
+
+

Sets the parent and sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_next_accessible_sibling
+
+

Updates the next accessible sibling of self.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_property
+
+

Updates a list of accessible properties.

+
+
+

+
+
gtk_accessible_update_property_value
+
+

Updates an array of accessible properties.

+
+
+

+
+
gtk_accessible_update_relation
+
+

Updates a list of accessible relations.

+
+
+

+
+
gtk_accessible_update_relation_value
+
+

Updates an array of accessible relations.

+
+
+

+
+
gtk_accessible_update_state
+
+

Updates a list of accessible states. See the GtkAccessibleState +documentation for the value types of accessible states.

+
+
+

+
+
gtk_accessible_update_state_value
+
+

Updates an array of accessible states.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkActionable (6)
+
+
gtk_actionable_get_action_name
+
+

Gets the action name for actionable.

+
+
+

+
+
gtk_actionable_get_action_target_value
+
+

Gets the current target value of actionable.

+
+
+

+
+
gtk_actionable_set_action_name
+
+

Specifies the name of the action with which this widget should be associated.

+
+
+

+
+
gtk_actionable_set_action_target
+
+

Sets the target of an actionable widget.

+
+
+

+
+
gtk_actionable_set_action_target_value
+
+

Sets the target value of an actionable widget.

+
+
+

+
+
gtk_actionable_set_detailed_action_name
+
+

Sets the action-name and associated string target value of an +actionable widget.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkBuildable (1)
+
+
gtk_buildable_get_buildable_id
+
+

Gets the ID of the buildable object.

+
+
+

+
+ +
+
+ + + + +
+ + + +
+

+ Properties + +

+ + + + + + + +
Properties inherited from GtkButton (5)
+
+
Gtk.Button:child
+
+

The child widget.

+
+
+

+
+
Gtk.Button:has-frame
+
+

Whether the button has a frame.

+
+
+

+
+
Gtk.Button:icon-name
+
+

The name of the icon used to automatically populate the button.

+
+
+

+
+
Gtk.Button:label
+
+

Text of the label inside the button, if the button contains a label widget.

+
+
+

+
+
Gtk.Button:use-underline
+
+

If set, an underline in the text indicates that the following character is +to be used as mnemonic.

+
+
+

+
+ +
+
+ + + +
Properties inherited from GtkWidget (34)
+
+
Gtk.Widget:can-focus
+
+

Whether the widget or any of its descendents can accept +the input focus.

+
+
+

+
+
Gtk.Widget:can-target
+
+

Whether the widget can receive pointer events.

+
+
+

+
+
Gtk.Widget:css-classes
+
+

A list of css classes applied to this widget.

+
+
+

+
+
Gtk.Widget:css-name
+
+

The name of this widget in the CSS tree.

+
+
+

+
+
Gtk.Widget:cursor
+
+

The cursor used by widget.

+
+
+

+
+
Gtk.Widget:focus-on-click
+
+

Whether the widget should grab focus when it is clicked with the mouse.

+
+
+

+
+
Gtk.Widget:focusable
+
+

Whether this widget itself will accept the input focus.

+
+
+

+
+
Gtk.Widget:halign
+
+

How to distribute horizontal space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:has-default
+
+

Whether the widget is the default widget.

+
+
+

+
+
Gtk.Widget:has-focus
+
+

Whether the widget has the input focus.

+
+
+

+
+
Gtk.Widget:has-tooltip
+
+

Enables or disables the emission of the ::query-tooltip signal on widget.

+
+
+

+
+
Gtk.Widget:height-request
+
+

Override for height request of the widget.

+
+
+

+
+
Gtk.Widget:hexpand
+
+

Whether to expand horizontally.

+
+
+

+
+
Gtk.Widget:hexpand-set
+
+

Whether to use the hexpand property.

+
+
+

+
+
Gtk.Widget:layout-manager
+
+

The GtkLayoutManager instance to use to compute the preferred size +of the widget, and allocate its children.

+
+
+

+
+
Gtk.Widget:margin-bottom
+
+

Margin on bottom side of widget.

+
+
+

+
+
Gtk.Widget:margin-end
+
+

Margin on end of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-start
+
+

Margin on start of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-top
+
+

Margin on top side of widget.

+
+
+

+
+
Gtk.Widget:name
+
+

The name of the widget.

+
+
+

+
+
Gtk.Widget:opacity
+
+

The requested opacity of the widget.

+
+
+

+
+
Gtk.Widget:overflow
+
+

How content outside the widget’s content area is treated.

+
+
+

+
+
Gtk.Widget:parent
+
+

The parent widget of this widget.

+
+
+

+
+
Gtk.Widget:receives-default
+
+

Whether the widget will receive the default action when it is focused.

+
+
+

+
+
Gtk.Widget:root
+
+

The GtkRoot widget of the widget tree containing this widget.

+
+
+

+
+
Gtk.Widget:scale-factor
+
+

The scale factor of the widget.

+
+
+

+
+
Gtk.Widget:sensitive
+
+

Whether the widget responds to input.

+
+
+

+
+
Gtk.Widget:tooltip-markup
+
+

Sets the text of tooltip to be the given string, which is marked up +with Pango markup.

+
+
+

+
+
Gtk.Widget:tooltip-text
+
+

Sets the text of tooltip to be the given string.

+
+
+

+
+
Gtk.Widget:valign
+
+

How to distribute vertical space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:vexpand
+
+

Whether to expand vertically.

+
+
+

+
+
Gtk.Widget:vexpand-set
+
+

Whether to use the vexpand property.

+
+
+

+
+
Gtk.Widget:visible
+
+

Whether the widget is visible.

+
+
+

+
+
Gtk.Widget:width-request
+
+

Override for width request of the widget.

+
+
+

+
+ +
+
+ + + + + + + + + +
Properties inherited from GtkAccessible (1)
+
+
Gtk.Accessible:accessible-role
+
+

The accessible role of the given GtkAccessible implementation.

+
+
+

+
+ +
+
+ + + +
Properties inherited from GtkActionable (2)
+
+
Gtk.Actionable:action-name
+
+ No description available. +
+
+

+
+
Gtk.Actionable:action-target
+
+ No description available. +
+
+

+
+ +
+
+ + + + + + + +
+ + + +
+

+ Signals + +

+ + + + + + + +
Signals inherited from GtkButton (2)
+
+
GtkButton::activate
+
+

Emitted to animate press then release.

+
+
+

+
+
GtkButton::clicked
+
+

Emitted when the button has been activated (pressed and released).

+
+
+

+
+ +
+
+ + + +
Signals inherited from GtkWidget (13)
+
+
GtkWidget::destroy
+
+

Signals that all holders of a reference to the widget should release +the reference that they hold.

+
+
+

+
+
GtkWidget::direction-changed
+
+

Emitted when the text direction of a widget changes.

+
+
+

+
+
GtkWidget::hide
+
+

Emitted when widget is hidden.

+
+
+

+
+
GtkWidget::keynav-failed
+
+

Emitted if keyboard navigation fails.

+
+
+

+
+
GtkWidget::map
+
+

Emitted when widget is going to be mapped.

+
+
+

+
+
GtkWidget::mnemonic-activate
+
+

Emitted when a widget is activated via a mnemonic.

+
+
+

+
+
GtkWidget::move-focus
+
+

Emitted when the focus is moved.

+
+
+

+
+
GtkWidget::query-tooltip
+
+

Emitted when the widget’s tooltip is about to be shown.

+
+
+

+
+
GtkWidget::realize
+
+

Emitted when widget is associated with a GdkSurface.

+
+
+

+
+
GtkWidget::show
+
+

Emitted when widget is shown.

+
+
+

+
+
GtkWidget::state-flags-changed
+
+

Emitted when the widget state changes.

+
+
+

+
+
GtkWidget::unmap
+
+

Emitted when widget is going to be unmapped.

+
+
+

+
+
GtkWidget::unrealize
+
+

Emitted when the GdkSurface associated with widget is destroyed.

+
+
+

+
+ +
+
+ + + + + +
Signals inherited from GObject (1)
+
+
GObject::notify
+
+

The notify signal is emitted on an object when one of its properties has +its value set through g_object_set_property(), g_object_set(), et al.

+
+
+

+
+ +
+
+ + + + + + + + + + + + + +
+ + + +
+

+ Class structure + +

+ +
+ 
struct ClapperGtkPreviousItemButtonClass {
+  ClapperGtkSkipItemButtonClass parent_class;
+  
+}
+
+ +
+ No description available. +
+ + +
+
Class members
+ +
+ +
parent_class: ClapperGtkSkipItemButtonClass
+
No description available.
+ + +
+ +
+ + + + + + +
+
+ + + +
+ +
+ + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/class.ProgressBar.html b/doc/clapper-gtk/class.ProgressBar.html new file mode 100644 index 00000000..c0b9af83 --- /dev/null +++ b/doc/clapper-gtk/class.ProgressBar.html @@ -0,0 +1,1362 @@ + + + + + + ClapperGtk.ProgressBar + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Class

+

ClapperGtkProgressBar

+
+ +
+ +
+

+
+ +
+

+ Description + + + [src] + +

+ + 
final class ClapperGtk.ProgressBar : Gtk.Box
+  implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget, Gtk.Orientable {
+  /* No available fields */
+}
+ +
+

A progress bar for displaying playback position and seeking.

+
+ +
+ + + +
+ + +
+ + + +
+

+ Hierarchy + +

+
+ + + + + + +hierarchy + + +this + + +ClapperGtkProgressBar + + + + + +implements_0 + + +GtkAccessible + + + + + +this--implements_0 + + + + +implements_1 + + +GtkBuildable + + + + + +this--implements_1 + + + + +implements_2 + + +GtkConstraintTarget + + + + + +this--implements_2 + + + + +implements_3 + + +GtkOrientable + + + + + +this--implements_3 + + + + +ancestor_0 + + +GtkBox + + + + + +ancestor_0--this + + + + +ancestor_1 + + +GtkWidget + + + + + +ancestor_1--ancestor_0 + + + + +ancestor_2 + + +GInitiallyUnowned + + + + + +ancestor_2--ancestor_1 + + + + +ancestor_3 + + +GObject + + + + + +ancestor_3--ancestor_2 + + + + + +
+
+ + + +
+

+ Ancestors + +

+ +
+ +
+
+ + + + + +
+

+ Implements + +

+ +
+ +
+
+ + + +
+

+ Constructors + +

+ +
+ +
+
clapper_gtk_progress_bar_new
+
+

Creates a new GtkWidget with a progress bar.

+
+
+

+
+
+ +
+
+ + + + + +
+

+ Instance methods + +

+ +
+ +
+
clapper_gtk_progress_bar_get_reveal_labels
+
+

Get whether the position and duration labels are going to be revealed.

+
+
+

+
+
+ +
+
clapper_gtk_progress_bar_get_seek_method
+
+

Get ClapperPlayerSeekMethod used when seeking with progress bar.

+
+
+

+
+
+ +
+
clapper_gtk_progress_bar_set_reveal_labels
+
+

Set whether the position and duration labels should be revealed.

+
+
+

+
+
+ +
+
clapper_gtk_progress_bar_set_seek_method
+
+

Set ClapperPlayerSeekMethod to use when seeking with progress bar.

+
+
+

+
+
+ +
+ + + +
Methods inherited from GtkBox (11)
+
+
gtk_box_append
+
+

Adds child as the last child to box.

+
+
+

+
+
gtk_box_get_baseline_position
+
+

Gets the value set by gtk_box_set_baseline_position().

+
+
+

+
+
gtk_box_get_homogeneous
+
+

Returns whether the box is homogeneous (all children are the +same size).

+
+
+

+
+
gtk_box_get_spacing
+
+

Gets the value set by gtk_box_set_spacing().

+
+
+

+
+
gtk_box_insert_child_after
+
+

Inserts child in the position after sibling in the list +of box children.

+
+
+

+
+
gtk_box_prepend
+
+

Adds child as the first child to box.

+
+
+

+
+
gtk_box_remove
+
+

Removes a child widget from box.

+
+
+

+
+
gtk_box_reorder_child_after
+
+

Moves child to the position after sibling in the list +of box children.

+
+
+

+
+
gtk_box_set_baseline_position
+
+

Sets the baseline position of a box.

+
+
+

+
+
gtk_box_set_homogeneous
+
+

Sets whether or not all children of box are given equal space +in the box.

+
+
+

+
+
gtk_box_set_spacing
+
+

Sets the number of pixels to place between children of box.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkWidget (161)
+
+ +
+

Please see GtkWidget for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GObject (43)
+
+ +
+

Please see GObject for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GtkAccessible (18)
+
+
gtk_accessible_get_accessible_parent
+
+

Retrieves the accessible parent for an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_accessible_role
+
+

Retrieves the accessible role of an accessible object.

+
+
+

+
+
gtk_accessible_get_at_context
+
+

Retrieves the accessible implementation for the given GtkAccessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_bounds
+
+

Queries the coordinates and dimensions of this accessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_first_accessible_child
+
+

Retrieves the first accessible child of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_next_accessible_sibling
+
+

Retrieves the next accessible sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_platform_state
+
+

Query a platform state, such as focus.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_reset_property
+
+

Resets the accessible property to its default value.

+
+
+

+
+
gtk_accessible_reset_relation
+
+

Resets the accessible relation to its default value.

+
+
+

+
+
gtk_accessible_reset_state
+
+

Resets the accessible state to its default value.

+
+
+

+
+
gtk_accessible_set_accessible_parent
+
+

Sets the parent and sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_next_accessible_sibling
+
+

Updates the next accessible sibling of self.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_property
+
+

Updates a list of accessible properties.

+
+
+

+
+
gtk_accessible_update_property_value
+
+

Updates an array of accessible properties.

+
+
+

+
+
gtk_accessible_update_relation
+
+

Updates a list of accessible relations.

+
+
+

+
+
gtk_accessible_update_relation_value
+
+

Updates an array of accessible relations.

+
+
+

+
+
gtk_accessible_update_state
+
+

Updates a list of accessible states. See the GtkAccessibleState +documentation for the value types of accessible states.

+
+
+

+
+
gtk_accessible_update_state_value
+
+

Updates an array of accessible states.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkBuildable (1)
+
+
gtk_buildable_get_buildable_id
+
+

Gets the ID of the buildable object.

+
+
+

+
+ +
+
+ + + + + +
Methods inherited from GtkOrientable (2)
+
+
gtk_orientable_get_orientation
+
+

Retrieves the orientation of the orientable.

+
+
+

+
+
gtk_orientable_set_orientation
+
+

Sets the orientation of the orientable.

+
+
+

+
+ +
+
+ + +
+ + + +
+

+ Properties + +

+ + +
+ +
+
ClapperGtk.ProgressBar:reveal-labels
+
+

Reveal state of the position and duration labels.

+
+
+

+
+
+ +
+
ClapperGtk.ProgressBar:seek-method
+
+

Method used for seeking.

+
+
+

+
+
+ +
+ + + + +
Properties inherited from GtkBox (3)
+
+
Gtk.Box:baseline-position
+
+

The position of the baseline aligned widgets if extra space is available.

+
+
+

+
+
Gtk.Box:homogeneous
+
+

Whether the children should all be the same size.

+
+
+

+
+
Gtk.Box:spacing
+
+

The amount of space between children.

+
+
+

+
+ +
+
+ + + +
Properties inherited from GtkWidget (34)
+
+
Gtk.Widget:can-focus
+
+

Whether the widget or any of its descendents can accept +the input focus.

+
+
+

+
+
Gtk.Widget:can-target
+
+

Whether the widget can receive pointer events.

+
+
+

+
+
Gtk.Widget:css-classes
+
+

A list of css classes applied to this widget.

+
+
+

+
+
Gtk.Widget:css-name
+
+

The name of this widget in the CSS tree.

+
+
+

+
+
Gtk.Widget:cursor
+
+

The cursor used by widget.

+
+
+

+
+
Gtk.Widget:focus-on-click
+
+

Whether the widget should grab focus when it is clicked with the mouse.

+
+
+

+
+
Gtk.Widget:focusable
+
+

Whether this widget itself will accept the input focus.

+
+
+

+
+
Gtk.Widget:halign
+
+

How to distribute horizontal space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:has-default
+
+

Whether the widget is the default widget.

+
+
+

+
+
Gtk.Widget:has-focus
+
+

Whether the widget has the input focus.

+
+
+

+
+
Gtk.Widget:has-tooltip
+
+

Enables or disables the emission of the ::query-tooltip signal on widget.

+
+
+

+
+
Gtk.Widget:height-request
+
+

Override for height request of the widget.

+
+
+

+
+
Gtk.Widget:hexpand
+
+

Whether to expand horizontally.

+
+
+

+
+
Gtk.Widget:hexpand-set
+
+

Whether to use the hexpand property.

+
+
+

+
+
Gtk.Widget:layout-manager
+
+

The GtkLayoutManager instance to use to compute the preferred size +of the widget, and allocate its children.

+
+
+

+
+
Gtk.Widget:margin-bottom
+
+

Margin on bottom side of widget.

+
+
+

+
+
Gtk.Widget:margin-end
+
+

Margin on end of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-start
+
+

Margin on start of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-top
+
+

Margin on top side of widget.

+
+
+

+
+
Gtk.Widget:name
+
+

The name of the widget.

+
+
+

+
+
Gtk.Widget:opacity
+
+

The requested opacity of the widget.

+
+
+

+
+
Gtk.Widget:overflow
+
+

How content outside the widget’s content area is treated.

+
+
+

+
+
Gtk.Widget:parent
+
+

The parent widget of this widget.

+
+
+

+
+
Gtk.Widget:receives-default
+
+

Whether the widget will receive the default action when it is focused.

+
+
+

+
+
Gtk.Widget:root
+
+

The GtkRoot widget of the widget tree containing this widget.

+
+
+

+
+
Gtk.Widget:scale-factor
+
+

The scale factor of the widget.

+
+
+

+
+
Gtk.Widget:sensitive
+
+

Whether the widget responds to input.

+
+
+

+
+
Gtk.Widget:tooltip-markup
+
+

Sets the text of tooltip to be the given string, which is marked up +with Pango markup.

+
+
+

+
+
Gtk.Widget:tooltip-text
+
+

Sets the text of tooltip to be the given string.

+
+
+

+
+
Gtk.Widget:valign
+
+

How to distribute vertical space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:vexpand
+
+

Whether to expand vertically.

+
+
+

+
+
Gtk.Widget:vexpand-set
+
+

Whether to use the vexpand property.

+
+
+

+
+
Gtk.Widget:visible
+
+

Whether the widget is visible.

+
+
+

+
+
Gtk.Widget:width-request
+
+

Override for width request of the widget.

+
+
+

+
+ +
+
+ + + + + + + + + +
Properties inherited from GtkAccessible (1)
+
+
Gtk.Accessible:accessible-role
+
+

The accessible role of the given GtkAccessible implementation.

+
+
+

+
+ +
+
+ + + + + + + +
Properties inherited from GtkOrientable (1)
+
+
Gtk.Orientable:orientation
+
+

The orientation of the orientable.

+
+
+

+
+ +
+
+ + + +
+ + + +
+

+ Signals + +

+ + + + + + + +
Signals inherited from GtkWidget (13)
+
+
GtkWidget::destroy
+
+

Signals that all holders of a reference to the widget should release +the reference that they hold.

+
+
+

+
+
GtkWidget::direction-changed
+
+

Emitted when the text direction of a widget changes.

+
+
+

+
+
GtkWidget::hide
+
+

Emitted when widget is hidden.

+
+
+

+
+
GtkWidget::keynav-failed
+
+

Emitted if keyboard navigation fails.

+
+
+

+
+
GtkWidget::map
+
+

Emitted when widget is going to be mapped.

+
+
+

+
+
GtkWidget::mnemonic-activate
+
+

Emitted when a widget is activated via a mnemonic.

+
+
+

+
+
GtkWidget::move-focus
+
+

Emitted when the focus is moved.

+
+
+

+
+
GtkWidget::query-tooltip
+
+

Emitted when the widget’s tooltip is about to be shown.

+
+
+

+
+
GtkWidget::realize
+
+

Emitted when widget is associated with a GdkSurface.

+
+
+

+
+
GtkWidget::show
+
+

Emitted when widget is shown.

+
+
+

+
+
GtkWidget::state-flags-changed
+
+

Emitted when the widget state changes.

+
+
+

+
+
GtkWidget::unmap
+
+

Emitted when widget is going to be unmapped.

+
+
+

+
+
GtkWidget::unrealize
+
+

Emitted when the GdkSurface associated with widget is destroyed.

+
+
+

+
+ +
+
+ + + + + +
Signals inherited from GObject (1)
+
+
GObject::notify
+
+

The notify signal is emitted on an object when one of its properties has +its value set through g_object_set_property(), g_object_set(), et al.

+
+
+

+
+ +
+
+ + + + + + + + + + + + + +
+ + + +
+

+ Class structure + +

+ +
+ 
struct ClapperGtkProgressBarClass {
+  GtkBoxClass parent_class;
+  
+}
+
+ +
+ No description available. +
+ + +
+
Class members
+ +
+ +
parent_class: GtkBoxClass
+
No description available.
+ + +
+ +
+ + + + + + +
+
+ + + +
+ +
+ + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/class.QueueSelection.html b/doc/clapper-gtk/class.QueueSelection.html new file mode 100644 index 00000000..de508a67 --- /dev/null +++ b/doc/clapper-gtk/class.QueueSelection.html @@ -0,0 +1,737 @@ + + + + + + ClapperGtk.QueueSelection + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Class

+

ClapperGtkQueueSelection

+
+ +
+ +
+

+
+ +
+

+ Description + + + [src] + +

+ + 
final class ClapperGtk.QueueSelection : GObject.Object
+  implements Gio.ListModel, Gtk.SelectionModel {
+  /* No available fields */
+}
+ +
+

A GtkSelectionModel that considers current item of ClapperQueue as selected one.

+
+ +
+ + + +
+ + +
+ + + +
+

+ Hierarchy + +

+
+ + + + + + +hierarchy + + +this + + +ClapperGtkQueueSelection + + + + + +implements_0 + + +GListModel + + + + + +this--implements_0 + + + + +implements_1 + + +GtkSelectionModel + + + + + +this--implements_1 + + + + +ancestor_0 + + +GObject + + + + + +ancestor_0--this + + + + + +
+
+ + + +
+

+ Ancestors + +

+ +
+ +
+
+ + + + + +
+

+ Implements + +

+ +
+ +
+
+ + + +
+

+ Constructors + +

+ +
+ +
+
clapper_gtk_queue_selection_new
+
+

Creates a new ClapperGtkQueueSelection instance.

+
+
+

+
+
+ +
+
+ + + + + +
+

+ Instance methods + +

+ +
+ +
+
clapper_gtk_queue_selection_get_queue
+
+

Get ClapperQueue managed by this selection model.

+
+
+

+
+
+ +
+
clapper_gtk_queue_selection_set_queue
+
+

Set ClapperQueue to be managed by this selection model.

+
+
+

+
+
+ +
+ + + +
Methods inherited from GObject (43)
+
+ +
+

Please see GObject for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GListModel (5)
+
+
g_list_model_get_item
+
+

Get the item at position.

+
+
+

unstable since: 2.44

+
+
g_list_model_get_item_type
+
+

Gets the type of the items in list.

+
+
+

unstable since: 2.44

+
+
g_list_model_get_n_items
+
+

Gets the number of items in list.

+
+
+

unstable since: 2.44

+
+
g_list_model_get_object
+
+

Get the item at position.

+
+
+

unstable since: 2.44

+
+
g_list_model_items_changed
+
+

Emits the GListModel::items-changed signal on list.

+
+
+

unstable since: 2.44

+
+ +
+
+ + + +
Methods inherited from GtkSelectionModel (11)
+
+
gtk_selection_model_get_selection
+
+

Gets the set containing all currently selected items in the model.

+
+
+

+
+
gtk_selection_model_get_selection_in_range
+
+

Gets the set of selected items in a range.

+
+
+

+
+
gtk_selection_model_is_selected
+
+

Checks if the given item is selected.

+
+
+

+
+
gtk_selection_model_select_all
+
+

Requests to select all items in the model.

+
+
+

+
+
gtk_selection_model_select_item
+
+

Requests to select an item in the model.

+
+
+

+
+
gtk_selection_model_select_range
+
+

Requests to select a range of items in the model.

+
+
+

+
+
gtk_selection_model_selection_changed
+
+

Helper function for implementations of GtkSelectionModel.

+
+
+

+
+
gtk_selection_model_set_selection
+
+

Make selection changes.

+
+
+

+
+
gtk_selection_model_unselect_all
+
+

Requests to unselect all items in the model.

+
+
+

+
+
gtk_selection_model_unselect_item
+
+

Requests to unselect an item in the model.

+
+
+

+
+
gtk_selection_model_unselect_range
+
+

Requests to unselect a range of items in the model.

+
+
+

+
+ +
+
+ + +
+ + + +
+

+ Properties + +

+ + +
+ +
+
ClapperGtk.QueueSelection:queue
+
+

The queue being managed.

+
+
+

+
+
+ +
+ + + + + + + + + + + + +
+ + + +
+

+ Signals + +

+ + +
+ +
+
ClapperGtk.QueueSelection::item-query
+
+

Signals when the GtkSelectionModel is doing item query.

+
+
+

+
+
+ +
+
ClapperGtk.QueueSelection::item-selected
+
+

Signals when user selected item within the GtkSelectionModel. +Note that this signal is emitted only when item gets selected from +the GTK side. If item was changed internally by e.g. ClapperQueue +progression, this signal will not be emitted.

+
+
+

+
+
+ +
+ + + + +
Signals inherited from GObject (1)
+
+
GObject::notify
+
+

The notify signal is emitted on an object when one of its properties has +its value set through g_object_set_property(), g_object_set(), et al.

+
+
+

+
+ +
+
+ + + + + +
Signals inherited from GListModel (1)
+
+
GListModel::items-changed
+
+

This signal is emitted whenever items were added to or removed +from list. At position, removed items were removed and added +items were added in their place.

+
+
+

unstable since: 2.44

+
+ +
+
+ + + +
Signals inherited from GtkSelectionModel (1)
+
+
GtkSelectionModel::selection-changed
+
+

Emitted when the selection state of some of the items in model changes.

+
+
+

+
+ +
+
+ + + +
+ + + +
+

+ Class structure + +

+ +
+ 
struct ClapperGtkQueueSelectionClass {
+  GObjectClass parent_class;
+  
+}
+
+ +
+ No description available. +
+ + +
+
Class members
+ +
+ +
parent_class: GObjectClass
+
No description available.
+ + +
+ +
+ + + + + + +
+
+ + + +
+ +
+ + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/class.SimpleControls.html b/doc/clapper-gtk/class.SimpleControls.html new file mode 100644 index 00000000..bcfabf8b --- /dev/null +++ b/doc/clapper-gtk/class.SimpleControls.html @@ -0,0 +1,1330 @@ + + + + + + ClapperGtk.SimpleControls + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Class

+

ClapperGtkSimpleControls

+
+ +
+ +
+

+
+ +
+

+ Description + + + [src] + +

+ + 
final class ClapperGtk.SimpleControls : ClapperGtk.Container
+  implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget {
+  /* No available fields */
+}
+ +
+

A minimalistic playback controls panel widget.

+

ClapperGtkSimpleControls is a simple, ready to be used playback controls widget. +It is meant to be placed as an overlay (either fading or not) of ClapperGtkVideo +as-is, providing minimal yet universal playback controls for your app.

+

If you need a further customized controls, please use individual widgets this +widget consists of to build your own controls implementation instead.

+
+ +
+ + + +
+ + +
+ + + +
+

+ Hierarchy + +

+
+ + + + + + +hierarchy + + +this + + +ClapperGtkSimpleControls + + + + + +implements_0 + + +GtkAccessible + + + + + +this--implements_0 + + + + +implements_1 + + +GtkBuildable + + + + + +this--implements_1 + + + + +implements_2 + + +GtkConstraintTarget + + + + + +this--implements_2 + + + + +ancestor_0 + + +ClapperGtkContainer + + + + + +ancestor_0--this + + + + +ancestor_1 + + +GtkWidget + + + + + +ancestor_1--ancestor_0 + + + + +ancestor_2 + + +GInitiallyUnowned + + + + + +ancestor_2--ancestor_1 + + + + +ancestor_3 + + +GObject + + + + + +ancestor_3--ancestor_2 + + + + + +
+
+ + + +
+

+ Ancestors + +

+ +
+ +
+
+ + + + + +
+

+ Implements + +

+ +
+ +
+
+ + + +
+

+ Constructors + +

+ +
+ +
+
clapper_gtk_simple_controls_new
+
+

Creates a new GtkWidget with simple playback controls.

+
+
+

+
+
+ +
+
+ + + + + +
+

+ Instance methods + +

+ +
+ +
+
clapper_gtk_simple_controls_get_fullscreenable
+
+

Get whether ClapperGtkToggleFullscreenButton button in the controls +is set to be visible.

+
+
+

+
+
+ +
+
clapper_gtk_simple_controls_get_seek_method
+
+

Get ClapperPlayerSeekMethod used when seeking with progress bar.

+
+
+

+
+
+ +
+
clapper_gtk_simple_controls_set_fullscreenable
+
+

Set whether ClapperGtkToggleFullscreenButton button in the controls +should be visible.

+
+
+

+
+
+ +
+
clapper_gtk_simple_controls_set_seek_method
+
+

Set ClapperPlayerSeekMethod to use when seeking with progress bar.

+
+
+

+
+
+ +
+ + + +
+
Methods inherited from ClapperGtkContainer (10)
+ +
clapper_gtk_container_get_adaptive_height
+

Get a container adaptive height threshold.

+
+
+

+
+ +
clapper_gtk_container_get_adaptive_width
+

Get a container adaptive width threshold.

+
+
+

+
+ +
clapper_gtk_container_get_child
+

Get a child GtkWidget of container.

+
+
+

+
+ +
clapper_gtk_container_get_height_target
+

Get a container height target.

+
+
+

+
+ +
clapper_gtk_container_get_width_target
+

Get a container width target.

+
+
+

+
+ +
clapper_gtk_container_set_adaptive_height
+

Set an adaptive height threshold. When widget is resized to value or lower, +an ClapperGtkContainer::adapt signal will be emitted with TRUE to +notify implementation about mobile adaptation request, otherwise FALSE when +both threshold values are exceeded.

+
+
+

+
+ +
clapper_gtk_container_set_adaptive_width
+

Set an adaptive width threshold. When widget is resized to value or lower, +an ClapperGtkContainer::adapt signal will be emitted with TRUE to +notify implementation about mobile adaptation request, otherwise FALSE when +both threshold values are exceeded.

+
+
+

+
+ +
clapper_gtk_container_set_child
+

Set a child GtkWidget of container.

+
+
+

+
+ +
clapper_gtk_container_set_height_target
+

Same as clapper_gtk_container_set_width_target() but for widget height.

+
+
+

+
+ +
clapper_gtk_container_set_width_target
+

Set a width that container should target. When set container +will not stretch beyond set width while still expanding into +possible boundaries trying to reach its target.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkWidget (161)
+
+ +
+

Please see GtkWidget for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GObject (43)
+
+ +
+

Please see GObject for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GtkAccessible (18)
+
+
gtk_accessible_get_accessible_parent
+
+

Retrieves the accessible parent for an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_accessible_role
+
+

Retrieves the accessible role of an accessible object.

+
+
+

+
+
gtk_accessible_get_at_context
+
+

Retrieves the accessible implementation for the given GtkAccessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_bounds
+
+

Queries the coordinates and dimensions of this accessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_first_accessible_child
+
+

Retrieves the first accessible child of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_next_accessible_sibling
+
+

Retrieves the next accessible sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_platform_state
+
+

Query a platform state, such as focus.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_reset_property
+
+

Resets the accessible property to its default value.

+
+
+

+
+
gtk_accessible_reset_relation
+
+

Resets the accessible relation to its default value.

+
+
+

+
+
gtk_accessible_reset_state
+
+

Resets the accessible state to its default value.

+
+
+

+
+
gtk_accessible_set_accessible_parent
+
+

Sets the parent and sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_next_accessible_sibling
+
+

Updates the next accessible sibling of self.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_property
+
+

Updates a list of accessible properties.

+
+
+

+
+
gtk_accessible_update_property_value
+
+

Updates an array of accessible properties.

+
+
+

+
+
gtk_accessible_update_relation
+
+

Updates a list of accessible relations.

+
+
+

+
+
gtk_accessible_update_relation_value
+
+

Updates an array of accessible relations.

+
+
+

+
+
gtk_accessible_update_state
+
+

Updates a list of accessible states. See the GtkAccessibleState +documentation for the value types of accessible states.

+
+
+

+
+
gtk_accessible_update_state_value
+
+

Updates an array of accessible states.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkBuildable (1)
+
+
gtk_buildable_get_buildable_id
+
+

Gets the ID of the buildable object.

+
+
+

+
+ +
+
+ + + + +
+ + + +
+

+ Properties + +

+ + +
+ +
+
ClapperGtk.SimpleControls:fullscreenable
+
+

Whether toggle fullscreen button should be visible.

+
+
+

+
+
+ +
+
ClapperGtk.SimpleControls:seek-method
+
+

Method used for seeking.

+
+
+

+
+
+ +
+ + + + +
+
Properties inherited from ClapperGtkContainer (4)
+ +
ClapperGtk.Container:adaptive-height
+

Adaptive height threshold that triggers ClapperGtkContainer::adapt signal.

+
+
+

+
+ +
ClapperGtk.Container:adaptive-width
+

Adaptive width threshold that triggers ClapperGtkContainer::adapt signal.

+
+
+

+
+ +
ClapperGtk.Container:height-target
+

Height that container should target.

+
+
+

+
+ +
ClapperGtk.Container:width-target
+

Width that container should target.

+
+
+

+
+ +
+
+ + + +
Properties inherited from GtkWidget (34)
+
+
Gtk.Widget:can-focus
+
+

Whether the widget or any of its descendents can accept +the input focus.

+
+
+

+
+
Gtk.Widget:can-target
+
+

Whether the widget can receive pointer events.

+
+
+

+
+
Gtk.Widget:css-classes
+
+

A list of css classes applied to this widget.

+
+
+

+
+
Gtk.Widget:css-name
+
+

The name of this widget in the CSS tree.

+
+
+

+
+
Gtk.Widget:cursor
+
+

The cursor used by widget.

+
+
+

+
+
Gtk.Widget:focus-on-click
+
+

Whether the widget should grab focus when it is clicked with the mouse.

+
+
+

+
+
Gtk.Widget:focusable
+
+

Whether this widget itself will accept the input focus.

+
+
+

+
+
Gtk.Widget:halign
+
+

How to distribute horizontal space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:has-default
+
+

Whether the widget is the default widget.

+
+
+

+
+
Gtk.Widget:has-focus
+
+

Whether the widget has the input focus.

+
+
+

+
+
Gtk.Widget:has-tooltip
+
+

Enables or disables the emission of the ::query-tooltip signal on widget.

+
+
+

+
+
Gtk.Widget:height-request
+
+

Override for height request of the widget.

+
+
+

+
+
Gtk.Widget:hexpand
+
+

Whether to expand horizontally.

+
+
+

+
+
Gtk.Widget:hexpand-set
+
+

Whether to use the hexpand property.

+
+
+

+
+
Gtk.Widget:layout-manager
+
+

The GtkLayoutManager instance to use to compute the preferred size +of the widget, and allocate its children.

+
+
+

+
+
Gtk.Widget:margin-bottom
+
+

Margin on bottom side of widget.

+
+
+

+
+
Gtk.Widget:margin-end
+
+

Margin on end of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-start
+
+

Margin on start of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-top
+
+

Margin on top side of widget.

+
+
+

+
+
Gtk.Widget:name
+
+

The name of the widget.

+
+
+

+
+
Gtk.Widget:opacity
+
+

The requested opacity of the widget.

+
+
+

+
+
Gtk.Widget:overflow
+
+

How content outside the widget’s content area is treated.

+
+
+

+
+
Gtk.Widget:parent
+
+

The parent widget of this widget.

+
+
+

+
+
Gtk.Widget:receives-default
+
+

Whether the widget will receive the default action when it is focused.

+
+
+

+
+
Gtk.Widget:root
+
+

The GtkRoot widget of the widget tree containing this widget.

+
+
+

+
+
Gtk.Widget:scale-factor
+
+

The scale factor of the widget.

+
+
+

+
+
Gtk.Widget:sensitive
+
+

Whether the widget responds to input.

+
+
+

+
+
Gtk.Widget:tooltip-markup
+
+

Sets the text of tooltip to be the given string, which is marked up +with Pango markup.

+
+
+

+
+
Gtk.Widget:tooltip-text
+
+

Sets the text of tooltip to be the given string.

+
+
+

+
+
Gtk.Widget:valign
+
+

How to distribute vertical space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:vexpand
+
+

Whether to expand vertically.

+
+
+

+
+
Gtk.Widget:vexpand-set
+
+

Whether to use the vexpand property.

+
+
+

+
+
Gtk.Widget:visible
+
+

Whether the widget is visible.

+
+
+

+
+
Gtk.Widget:width-request
+
+

Override for width request of the widget.

+
+
+

+
+ +
+
+ + + + + + + + + +
Properties inherited from GtkAccessible (1)
+
+
Gtk.Accessible:accessible-role
+
+

The accessible role of the given GtkAccessible implementation.

+
+
+

+
+ +
+
+ + + + + + + +
+ + + +
+

+ Signals + +

+ + + + + +
+
Signals inherited from ClapperGtkContainer (1)
+ +
ClapperGtkContainer::adapt
+

A helper signal for implementing mobile/narrow adaptive +behavior on descendants.

+
+
+

+
+ +
+
+ + + +
Signals inherited from GtkWidget (13)
+
+
GtkWidget::destroy
+
+

Signals that all holders of a reference to the widget should release +the reference that they hold.

+
+
+

+
+
GtkWidget::direction-changed
+
+

Emitted when the text direction of a widget changes.

+
+
+

+
+
GtkWidget::hide
+
+

Emitted when widget is hidden.

+
+
+

+
+
GtkWidget::keynav-failed
+
+

Emitted if keyboard navigation fails.

+
+
+

+
+
GtkWidget::map
+
+

Emitted when widget is going to be mapped.

+
+
+

+
+
GtkWidget::mnemonic-activate
+
+

Emitted when a widget is activated via a mnemonic.

+
+
+

+
+
GtkWidget::move-focus
+
+

Emitted when the focus is moved.

+
+
+

+
+
GtkWidget::query-tooltip
+
+

Emitted when the widget’s tooltip is about to be shown.

+
+
+

+
+
GtkWidget::realize
+
+

Emitted when widget is associated with a GdkSurface.

+
+
+

+
+
GtkWidget::show
+
+

Emitted when widget is shown.

+
+
+

+
+
GtkWidget::state-flags-changed
+
+

Emitted when the widget state changes.

+
+
+

+
+
GtkWidget::unmap
+
+

Emitted when widget is going to be unmapped.

+
+
+

+
+
GtkWidget::unrealize
+
+

Emitted when the GdkSurface associated with widget is destroyed.

+
+
+

+
+ +
+
+ + + + + +
Signals inherited from GObject (1)
+
+
GObject::notify
+
+

The notify signal is emitted on an object when one of its properties has +its value set through g_object_set_property(), g_object_set(), et al.

+
+
+

+
+ +
+
+ + + + + + + + + + + +
+ + + +
+

+ Class structure + +

+ +
+ 
struct ClapperGtkSimpleControlsClass {
+  ClapperGtkContainerClass parent_class;
+  
+}
+
+ +
+ No description available. +
+ + +
+
Class members
+ +
+ +
parent_class: ClapperGtkContainerClass
+
No description available.
+ + +
+ +
+ + + + + + +
+
+ + + +
+ +
+ + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/class.SkipItemButton.html b/doc/clapper-gtk/class.SkipItemButton.html new file mode 100644 index 00000000..cb0996a1 --- /dev/null +++ b/doc/clapper-gtk/class.SkipItemButton.html @@ -0,0 +1,1374 @@ + + + + + + ClapperGtk.SkipItemButton + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Class

+

ClapperGtkSkipItemButton

+
+ +
+ +
+

+
+ +
+

+ Description + + + [src] + +

+ + 
class ClapperGtk.SkipItemButton : Gtk.Button
+  implements Gtk.Accessible, Gtk.Actionable, Gtk.Buildable, Gtk.ConstraintTarget {
+  /* No available fields */
+}
+ +
+

A base class for creating buttons that skip to previous/next queue item.

+

Unless you are in need to implement custom logic here by yourself, you should probably +just use one of this class descending widgets that ClapperGtk provides, that is: +ClapperGtkNextItemButton and ClapperGtkPreviousItemButton.

+
+ +
+ + + +
+ + +
+ + + +
+

+ Hierarchy + +

+
+ + + + + + +hierarchy + + +this + + +ClapperGtkSkipItemButton + + + + + +implements_0 + + +GtkAccessible + + + + + +this--implements_0 + + + + +implements_1 + + +GtkActionable + + + + + +this--implements_1 + + + + +implements_2 + + +GtkBuildable + + + + + +this--implements_2 + + + + +implements_3 + + +GtkConstraintTarget + + + + + +this--implements_3 + + + + +ancestor_0 + + +GtkButton + + + + + +ancestor_0--this + + + + +ancestor_1 + + +GtkWidget + + + + + +ancestor_1--ancestor_0 + + + + +ancestor_2 + + +GInitiallyUnowned + + + + + +ancestor_2--ancestor_1 + + + + +ancestor_3 + + +GObject + + + + + +ancestor_3--ancestor_2 + + + + + +
+
+ + + +
+

+ Ancestors + +

+ +
+ +
+
+ + + +
+

Descendants

+
+ +
+
+ + + +
+

+ Implements + +

+ +
+ +
+
+ + + + + + + +
+

+ Instance methods + +

+ +
+ +
+ + + +
Methods inherited from GtkButton (10)
+
+
gtk_button_get_child
+
+

Gets the child widget of button.

+
+
+

+
+
gtk_button_get_has_frame
+
+

Returns whether the button has a frame.

+
+
+

+
+
gtk_button_get_icon_name
+
+

Returns the icon name of the button.

+
+
+

+
+
gtk_button_get_label
+
+

Fetches the text from the label of the button.

+
+
+

+
+
gtk_button_get_use_underline
+
+

Gets whether underlines are interpreted as mnemonics.

+
+
+

+
+
gtk_button_set_child
+
+

Sets the child widget of button.

+
+
+

+
+
gtk_button_set_has_frame
+
+

Sets the style of the button.

+
+
+

+
+
gtk_button_set_icon_name
+
+

Adds a GtkImage with the given icon name as a child.

+
+
+

+
+
gtk_button_set_label
+
+

Sets the text of the label of the button to label.

+
+
+

+
+
gtk_button_set_use_underline
+
+

Sets whether to use underlines as mnemonics.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkWidget (161)
+
+ +
+

Please see GtkWidget for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GObject (43)
+
+ +
+

Please see GObject for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GtkAccessible (18)
+
+
gtk_accessible_get_accessible_parent
+
+

Retrieves the accessible parent for an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_accessible_role
+
+

Retrieves the accessible role of an accessible object.

+
+
+

+
+
gtk_accessible_get_at_context
+
+

Retrieves the accessible implementation for the given GtkAccessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_bounds
+
+

Queries the coordinates and dimensions of this accessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_first_accessible_child
+
+

Retrieves the first accessible child of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_next_accessible_sibling
+
+

Retrieves the next accessible sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_platform_state
+
+

Query a platform state, such as focus.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_reset_property
+
+

Resets the accessible property to its default value.

+
+
+

+
+
gtk_accessible_reset_relation
+
+

Resets the accessible relation to its default value.

+
+
+

+
+
gtk_accessible_reset_state
+
+

Resets the accessible state to its default value.

+
+
+

+
+
gtk_accessible_set_accessible_parent
+
+

Sets the parent and sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_next_accessible_sibling
+
+

Updates the next accessible sibling of self.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_property
+
+

Updates a list of accessible properties.

+
+
+

+
+
gtk_accessible_update_property_value
+
+

Updates an array of accessible properties.

+
+
+

+
+
gtk_accessible_update_relation
+
+

Updates a list of accessible relations.

+
+
+

+
+
gtk_accessible_update_relation_value
+
+

Updates an array of accessible relations.

+
+
+

+
+
gtk_accessible_update_state
+
+

Updates a list of accessible states. See the GtkAccessibleState +documentation for the value types of accessible states.

+
+
+

+
+
gtk_accessible_update_state_value
+
+

Updates an array of accessible states.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkActionable (6)
+
+
gtk_actionable_get_action_name
+
+

Gets the action name for actionable.

+
+
+

+
+
gtk_actionable_get_action_target_value
+
+

Gets the current target value of actionable.

+
+
+

+
+
gtk_actionable_set_action_name
+
+

Specifies the name of the action with which this widget should be associated.

+
+
+

+
+
gtk_actionable_set_action_target
+
+

Sets the target of an actionable widget.

+
+
+

+
+
gtk_actionable_set_action_target_value
+
+

Sets the target value of an actionable widget.

+
+
+

+
+
gtk_actionable_set_detailed_action_name
+
+

Sets the action-name and associated string target value of an +actionable widget.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkBuildable (1)
+
+
gtk_buildable_get_buildable_id
+
+

Gets the ID of the buildable object.

+
+
+

+
+ +
+
+ + + + +
+ + + +
+

+ Properties + +

+ + + + + +
Properties inherited from GtkButton (5)
+
+
Gtk.Button:child
+
+

The child widget.

+
+
+

+
+
Gtk.Button:has-frame
+
+

Whether the button has a frame.

+
+
+

+
+
Gtk.Button:icon-name
+
+

The name of the icon used to automatically populate the button.

+
+
+

+
+
Gtk.Button:label
+
+

Text of the label inside the button, if the button contains a label widget.

+
+
+

+
+
Gtk.Button:use-underline
+
+

If set, an underline in the text indicates that the following character is +to be used as mnemonic.

+
+
+

+
+ +
+
+ + + +
Properties inherited from GtkWidget (34)
+
+
Gtk.Widget:can-focus
+
+

Whether the widget or any of its descendents can accept +the input focus.

+
+
+

+
+
Gtk.Widget:can-target
+
+

Whether the widget can receive pointer events.

+
+
+

+
+
Gtk.Widget:css-classes
+
+

A list of css classes applied to this widget.

+
+
+

+
+
Gtk.Widget:css-name
+
+

The name of this widget in the CSS tree.

+
+
+

+
+
Gtk.Widget:cursor
+
+

The cursor used by widget.

+
+
+

+
+
Gtk.Widget:focus-on-click
+
+

Whether the widget should grab focus when it is clicked with the mouse.

+
+
+

+
+
Gtk.Widget:focusable
+
+

Whether this widget itself will accept the input focus.

+
+
+

+
+
Gtk.Widget:halign
+
+

How to distribute horizontal space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:has-default
+
+

Whether the widget is the default widget.

+
+
+

+
+
Gtk.Widget:has-focus
+
+

Whether the widget has the input focus.

+
+
+

+
+
Gtk.Widget:has-tooltip
+
+

Enables or disables the emission of the ::query-tooltip signal on widget.

+
+
+

+
+
Gtk.Widget:height-request
+
+

Override for height request of the widget.

+
+
+

+
+
Gtk.Widget:hexpand
+
+

Whether to expand horizontally.

+
+
+

+
+
Gtk.Widget:hexpand-set
+
+

Whether to use the hexpand property.

+
+
+

+
+
Gtk.Widget:layout-manager
+
+

The GtkLayoutManager instance to use to compute the preferred size +of the widget, and allocate its children.

+
+
+

+
+
Gtk.Widget:margin-bottom
+
+

Margin on bottom side of widget.

+
+
+

+
+
Gtk.Widget:margin-end
+
+

Margin on end of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-start
+
+

Margin on start of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-top
+
+

Margin on top side of widget.

+
+
+

+
+
Gtk.Widget:name
+
+

The name of the widget.

+
+
+

+
+
Gtk.Widget:opacity
+
+

The requested opacity of the widget.

+
+
+

+
+
Gtk.Widget:overflow
+
+

How content outside the widget’s content area is treated.

+
+
+

+
+
Gtk.Widget:parent
+
+

The parent widget of this widget.

+
+
+

+
+
Gtk.Widget:receives-default
+
+

Whether the widget will receive the default action when it is focused.

+
+
+

+
+
Gtk.Widget:root
+
+

The GtkRoot widget of the widget tree containing this widget.

+
+
+

+
+
Gtk.Widget:scale-factor
+
+

The scale factor of the widget.

+
+
+

+
+
Gtk.Widget:sensitive
+
+

Whether the widget responds to input.

+
+
+

+
+
Gtk.Widget:tooltip-markup
+
+

Sets the text of tooltip to be the given string, which is marked up +with Pango markup.

+
+
+

+
+
Gtk.Widget:tooltip-text
+
+

Sets the text of tooltip to be the given string.

+
+
+

+
+
Gtk.Widget:valign
+
+

How to distribute vertical space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:vexpand
+
+

Whether to expand vertically.

+
+
+

+
+
Gtk.Widget:vexpand-set
+
+

Whether to use the vexpand property.

+
+
+

+
+
Gtk.Widget:visible
+
+

Whether the widget is visible.

+
+
+

+
+
Gtk.Widget:width-request
+
+

Override for width request of the widget.

+
+
+

+
+ +
+
+ + + + + + + + + +
Properties inherited from GtkAccessible (1)
+
+
Gtk.Accessible:accessible-role
+
+

The accessible role of the given GtkAccessible implementation.

+
+
+

+
+ +
+
+ + + +
Properties inherited from GtkActionable (2)
+
+
Gtk.Actionable:action-name
+
+ No description available. +
+
+

+
+
Gtk.Actionable:action-target
+
+ No description available. +
+
+

+
+ +
+
+ + + + + + + +
+ + + +
+

+ Signals + +

+ + + + + +
Signals inherited from GtkButton (2)
+
+
GtkButton::activate
+
+

Emitted to animate press then release.

+
+
+

+
+
GtkButton::clicked
+
+

Emitted when the button has been activated (pressed and released).

+
+
+

+
+ +
+
+ + + +
Signals inherited from GtkWidget (13)
+
+
GtkWidget::destroy
+
+

Signals that all holders of a reference to the widget should release +the reference that they hold.

+
+
+

+
+
GtkWidget::direction-changed
+
+

Emitted when the text direction of a widget changes.

+
+
+

+
+
GtkWidget::hide
+
+

Emitted when widget is hidden.

+
+
+

+
+
GtkWidget::keynav-failed
+
+

Emitted if keyboard navigation fails.

+
+
+

+
+
GtkWidget::map
+
+

Emitted when widget is going to be mapped.

+
+
+

+
+
GtkWidget::mnemonic-activate
+
+

Emitted when a widget is activated via a mnemonic.

+
+
+

+
+
GtkWidget::move-focus
+
+

Emitted when the focus is moved.

+
+
+

+
+
GtkWidget::query-tooltip
+
+

Emitted when the widget’s tooltip is about to be shown.

+
+
+

+
+
GtkWidget::realize
+
+

Emitted when widget is associated with a GdkSurface.

+
+
+

+
+
GtkWidget::show
+
+

Emitted when widget is shown.

+
+
+

+
+
GtkWidget::state-flags-changed
+
+

Emitted when the widget state changes.

+
+
+

+
+
GtkWidget::unmap
+
+

Emitted when widget is going to be unmapped.

+
+
+

+
+
GtkWidget::unrealize
+
+

Emitted when the GdkSurface associated with widget is destroyed.

+
+
+

+
+ +
+
+ + + + + +
Signals inherited from GObject (1)
+
+
GObject::notify
+
+

The notify signal is emitted on an object when one of its properties has +its value set through g_object_set_property(), g_object_set(), et al.

+
+
+

+
+ +
+
+ + + + + + + + + + + + + +
+ + + +
+

+ Class structure + +

+ +
+ 
struct ClapperGtkSkipItemButtonClass {
+  GtkButtonClass parent_class;
+  gboolean (* can_skip) (
+    ClapperGtkSkipItemButton* skip_button,
+    ClapperQueue* queue
+  );
+  void (* skip_item) (
+    ClapperGtkSkipItemButton* skip_button,
+    ClapperQueue* queue
+  );
+  
+}
+
+ +
+ No description available. +
+ + +
+
Class members
+ +
+ +
parent_class: GtkButtonClass
+
No description available.
+ +
can_skip: gboolean (* can_skip) ( + ClapperGtkSkipItemButton* skip_button, + ClapperQueue* queue + )
+
No description available.
+ +
skip_item: void (* skip_item) ( + ClapperGtkSkipItemButton* skip_button, + ClapperQueue* queue + )
+
No description available.
+ + +
+ +
+ + + +
+

+ Virtual methods + +

+ +
+ +
+
ClapperGtk.SkipItemButtonClass.can_skip
+
+ No description available. +
+
+

+
+
+ +
+
ClapperGtk.SkipItemButtonClass.skip_item
+
+ No description available. +
+
+

+
+
+ +
+
+ + + + +
+
+ + + +
+ +
+ + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/class.TitleHeader.html b/doc/clapper-gtk/class.TitleHeader.html new file mode 100644 index 00000000..da68a871 --- /dev/null +++ b/doc/clapper-gtk/class.TitleHeader.html @@ -0,0 +1,1311 @@ + + + + + + ClapperGtk.TitleHeader + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Class

+

ClapperGtkTitleHeader

+
+ +
+ +
+

+
+ +
+

+ Description + + + [src] + +

+ + 
final class ClapperGtk.TitleHeader : ClapperGtk.LeadContainer
+  implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget {
+  /* No available fields */
+}
+ +
+

A header panel widget that displays current media title.

+

ClapperGtkTitleHeader is a simple, ready to be used header widget that +displays current media title. It can be placed as-is as a ClapperGtkVideo +overlay (either fading or not).

+
+ +
+ + + +
+ + +
+ + + +
+

+ Hierarchy + +

+
+ + + + + + +hierarchy + + +this + + +ClapperGtkTitleHeader + + + + + +implements_0 + + +GtkAccessible + + + + + +this--implements_0 + + + + +implements_1 + + +GtkBuildable + + + + + +this--implements_1 + + + + +implements_2 + + +GtkConstraintTarget + + + + + +this--implements_2 + + + + +ancestor_0 + + +ClapperGtkLeadContainer + + + + + +ancestor_0--this + + + + +ancestor_1 + + +ClapperGtkContainer + + + + + +ancestor_1--ancestor_0 + + + + +ancestor_2 + + +GtkWidget + + + + + +ancestor_2--ancestor_1 + + + + +ancestor_3 + + +GInitiallyUnowned + + + + + +ancestor_3--ancestor_2 + + + + +ancestor_4 + + +GObject + + + + + +ancestor_4--ancestor_3 + + + + + +
+
+ + + +
+

+ Ancestors + +

+ +
+ +
+
+ + + + + +
+

+ Implements + +

+ +
+ +
+
+ + + +
+

+ Constructors + +

+ +
+ +
+
clapper_gtk_title_header_new
+
+

Creates a new GtkWidget with title header.

+
+
+

+
+
+ +
+
+ + + + + +
+

+ Instance methods + +

+ +
+ +
+ + + +
+
Methods inherited from ClapperGtkLeadContainer (4)
+ +
clapper_gtk_lead_container_get_blocked_actions
+

Get actions that were set for this lead_container to block.

+
+
+

+
+ +
clapper_gtk_lead_container_get_leading
+

Get a whenever lead_container has leadership set.

+
+
+

+
+ +
clapper_gtk_lead_container_set_blocked_actions
+

Set actions that ClapperGtkVideo should skip when GdkEvent which +would normally trigger them happens inside lead_container.

+
+
+

+
+ +
clapper_gtk_lead_container_set_leading
+

Set if lead_container leadership should be enabled.

+
+
+

+
+ +
+
+ + + +
+
Methods inherited from ClapperGtkContainer (10)
+ +
clapper_gtk_container_get_adaptive_height
+

Get a container adaptive height threshold.

+
+
+

+
+ +
clapper_gtk_container_get_adaptive_width
+

Get a container adaptive width threshold.

+
+
+

+
+ +
clapper_gtk_container_get_child
+

Get a child GtkWidget of container.

+
+
+

+
+ +
clapper_gtk_container_get_height_target
+

Get a container height target.

+
+
+

+
+ +
clapper_gtk_container_get_width_target
+

Get a container width target.

+
+
+

+
+ +
clapper_gtk_container_set_adaptive_height
+

Set an adaptive height threshold. When widget is resized to value or lower, +an ClapperGtkContainer::adapt signal will be emitted with TRUE to +notify implementation about mobile adaptation request, otherwise FALSE when +both threshold values are exceeded.

+
+
+

+
+ +
clapper_gtk_container_set_adaptive_width
+

Set an adaptive width threshold. When widget is resized to value or lower, +an ClapperGtkContainer::adapt signal will be emitted with TRUE to +notify implementation about mobile adaptation request, otherwise FALSE when +both threshold values are exceeded.

+
+
+

+
+ +
clapper_gtk_container_set_child
+

Set a child GtkWidget of container.

+
+
+

+
+ +
clapper_gtk_container_set_height_target
+

Same as clapper_gtk_container_set_width_target() but for widget height.

+
+
+

+
+ +
clapper_gtk_container_set_width_target
+

Set a width that container should target. When set container +will not stretch beyond set width while still expanding into +possible boundaries trying to reach its target.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkWidget (161)
+
+ +
+

Please see GtkWidget for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GObject (43)
+
+ +
+

Please see GObject for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GtkAccessible (18)
+
+
gtk_accessible_get_accessible_parent
+
+

Retrieves the accessible parent for an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_accessible_role
+
+

Retrieves the accessible role of an accessible object.

+
+
+

+
+
gtk_accessible_get_at_context
+
+

Retrieves the accessible implementation for the given GtkAccessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_bounds
+
+

Queries the coordinates and dimensions of this accessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_first_accessible_child
+
+

Retrieves the first accessible child of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_next_accessible_sibling
+
+

Retrieves the next accessible sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_platform_state
+
+

Query a platform state, such as focus.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_reset_property
+
+

Resets the accessible property to its default value.

+
+
+

+
+
gtk_accessible_reset_relation
+
+

Resets the accessible relation to its default value.

+
+
+

+
+
gtk_accessible_reset_state
+
+

Resets the accessible state to its default value.

+
+
+

+
+
gtk_accessible_set_accessible_parent
+
+

Sets the parent and sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_next_accessible_sibling
+
+

Updates the next accessible sibling of self.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_property
+
+

Updates a list of accessible properties.

+
+
+

+
+
gtk_accessible_update_property_value
+
+

Updates an array of accessible properties.

+
+
+

+
+
gtk_accessible_update_relation
+
+

Updates a list of accessible relations.

+
+
+

+
+
gtk_accessible_update_relation_value
+
+

Updates an array of accessible relations.

+
+
+

+
+
gtk_accessible_update_state
+
+

Updates a list of accessible states. See the GtkAccessibleState +documentation for the value types of accessible states.

+
+
+

+
+
gtk_accessible_update_state_value
+
+

Updates an array of accessible states.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkBuildable (1)
+
+
gtk_buildable_get_buildable_id
+
+

Gets the ID of the buildable object.

+
+
+

+
+ +
+
+ + + + +
+ + + +
+

+ Properties + +

+ + + + + +
+
Properties inherited from ClapperGtkLeadContainer (2)
+ +
ClapperGtk.LeadContainer:blocked-actions
+

Mask of actions that container blocks from being triggered on video.

+
+
+

+
+ +
ClapperGtk.LeadContainer:leading
+

Width that container should target.

+
+
+

+
+ +
+
+ + + +
+
Properties inherited from ClapperGtkContainer (4)
+ +
ClapperGtk.Container:adaptive-height
+

Adaptive height threshold that triggers ClapperGtkContainer::adapt signal.

+
+
+

+
+ +
ClapperGtk.Container:adaptive-width
+

Adaptive width threshold that triggers ClapperGtkContainer::adapt signal.

+
+
+

+
+ +
ClapperGtk.Container:height-target
+

Height that container should target.

+
+
+

+
+ +
ClapperGtk.Container:width-target
+

Width that container should target.

+
+
+

+
+ +
+
+ + + +
Properties inherited from GtkWidget (34)
+
+
Gtk.Widget:can-focus
+
+

Whether the widget or any of its descendents can accept +the input focus.

+
+
+

+
+
Gtk.Widget:can-target
+
+

Whether the widget can receive pointer events.

+
+
+

+
+
Gtk.Widget:css-classes
+
+

A list of css classes applied to this widget.

+
+
+

+
+
Gtk.Widget:css-name
+
+

The name of this widget in the CSS tree.

+
+
+

+
+
Gtk.Widget:cursor
+
+

The cursor used by widget.

+
+
+

+
+
Gtk.Widget:focus-on-click
+
+

Whether the widget should grab focus when it is clicked with the mouse.

+
+
+

+
+
Gtk.Widget:focusable
+
+

Whether this widget itself will accept the input focus.

+
+
+

+
+
Gtk.Widget:halign
+
+

How to distribute horizontal space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:has-default
+
+

Whether the widget is the default widget.

+
+
+

+
+
Gtk.Widget:has-focus
+
+

Whether the widget has the input focus.

+
+
+

+
+
Gtk.Widget:has-tooltip
+
+

Enables or disables the emission of the ::query-tooltip signal on widget.

+
+
+

+
+
Gtk.Widget:height-request
+
+

Override for height request of the widget.

+
+
+

+
+
Gtk.Widget:hexpand
+
+

Whether to expand horizontally.

+
+
+

+
+
Gtk.Widget:hexpand-set
+
+

Whether to use the hexpand property.

+
+
+

+
+
Gtk.Widget:layout-manager
+
+

The GtkLayoutManager instance to use to compute the preferred size +of the widget, and allocate its children.

+
+
+

+
+
Gtk.Widget:margin-bottom
+
+

Margin on bottom side of widget.

+
+
+

+
+
Gtk.Widget:margin-end
+
+

Margin on end of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-start
+
+

Margin on start of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-top
+
+

Margin on top side of widget.

+
+
+

+
+
Gtk.Widget:name
+
+

The name of the widget.

+
+
+

+
+
Gtk.Widget:opacity
+
+

The requested opacity of the widget.

+
+
+

+
+
Gtk.Widget:overflow
+
+

How content outside the widget’s content area is treated.

+
+
+

+
+
Gtk.Widget:parent
+
+

The parent widget of this widget.

+
+
+

+
+
Gtk.Widget:receives-default
+
+

Whether the widget will receive the default action when it is focused.

+
+
+

+
+
Gtk.Widget:root
+
+

The GtkRoot widget of the widget tree containing this widget.

+
+
+

+
+
Gtk.Widget:scale-factor
+
+

The scale factor of the widget.

+
+
+

+
+
Gtk.Widget:sensitive
+
+

Whether the widget responds to input.

+
+
+

+
+
Gtk.Widget:tooltip-markup
+
+

Sets the text of tooltip to be the given string, which is marked up +with Pango markup.

+
+
+

+
+
Gtk.Widget:tooltip-text
+
+

Sets the text of tooltip to be the given string.

+
+
+

+
+
Gtk.Widget:valign
+
+

How to distribute vertical space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:vexpand
+
+

Whether to expand vertically.

+
+
+

+
+
Gtk.Widget:vexpand-set
+
+

Whether to use the vexpand property.

+
+
+

+
+
Gtk.Widget:visible
+
+

Whether the widget is visible.

+
+
+

+
+
Gtk.Widget:width-request
+
+

Override for width request of the widget.

+
+
+

+
+ +
+
+ + + + + + + + + +
Properties inherited from GtkAccessible (1)
+
+
Gtk.Accessible:accessible-role
+
+

The accessible role of the given GtkAccessible implementation.

+
+
+

+
+ +
+
+ + + + + + + +
+ + + +
+

+ Signals + +

+ + + + + + + +
+
Signals inherited from ClapperGtkContainer (1)
+ +
ClapperGtkContainer::adapt
+

A helper signal for implementing mobile/narrow adaptive +behavior on descendants.

+
+
+

+
+ +
+
+ + + +
Signals inherited from GtkWidget (13)
+
+
GtkWidget::destroy
+
+

Signals that all holders of a reference to the widget should release +the reference that they hold.

+
+
+

+
+
GtkWidget::direction-changed
+
+

Emitted when the text direction of a widget changes.

+
+
+

+
+
GtkWidget::hide
+
+

Emitted when widget is hidden.

+
+
+

+
+
GtkWidget::keynav-failed
+
+

Emitted if keyboard navigation fails.

+
+
+

+
+
GtkWidget::map
+
+

Emitted when widget is going to be mapped.

+
+
+

+
+
GtkWidget::mnemonic-activate
+
+

Emitted when a widget is activated via a mnemonic.

+
+
+

+
+
GtkWidget::move-focus
+
+

Emitted when the focus is moved.

+
+
+

+
+
GtkWidget::query-tooltip
+
+

Emitted when the widget’s tooltip is about to be shown.

+
+
+

+
+
GtkWidget::realize
+
+

Emitted when widget is associated with a GdkSurface.

+
+
+

+
+
GtkWidget::show
+
+

Emitted when widget is shown.

+
+
+

+
+
GtkWidget::state-flags-changed
+
+

Emitted when the widget state changes.

+
+
+

+
+
GtkWidget::unmap
+
+

Emitted when widget is going to be unmapped.

+
+
+

+
+
GtkWidget::unrealize
+
+

Emitted when the GdkSurface associated with widget is destroyed.

+
+
+

+
+ +
+
+ + + + + +
Signals inherited from GObject (1)
+
+
GObject::notify
+
+

The notify signal is emitted on an object when one of its properties has +its value set through g_object_set_property(), g_object_set(), et al.

+
+
+

+
+ +
+
+ + + + + + + + + + + +
+ + + +
+

+ Class structure + +

+ +
+ 
struct ClapperGtkTitleHeaderClass {
+  ClapperGtkLeadContainerClass parent_class;
+  
+}
+
+ +
+ No description available. +
+ + +
+
Class members
+ +
+ +
parent_class: ClapperGtkLeadContainerClass
+
No description available.
+ + +
+ +
+ + + + + + +
+
+ + + +
+ +
+ + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/class.ToggleFullscreenButton.html b/doc/clapper-gtk/class.ToggleFullscreenButton.html new file mode 100644 index 00000000..78391ca2 --- /dev/null +++ b/doc/clapper-gtk/class.ToggleFullscreenButton.html @@ -0,0 +1,1328 @@ + + + + + + ClapperGtk.ToggleFullscreenButton + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Class

+

ClapperGtkToggleFullscreenButton

+
+ +
+ +
+

+
+ +
+

+ Description + + + [src] + +

+ + 
final class ClapperGtk.ToggleFullscreenButton : Gtk.Button
+  implements Gtk.Accessible, Gtk.Actionable, Gtk.Buildable, Gtk.ConstraintTarget {
+  /* No available fields */
+}
+ +
+

A GtkButton for toggling fullscreen state.

+
+ +
+ + + +
+ + +
+ + + +
+

+ Hierarchy + +

+
+ + + + + + +hierarchy + + +this + + +ClapperGtkToggleFullscreenButton + + + + + +implements_0 + + +GtkAccessible + + + + + +this--implements_0 + + + + +implements_1 + + +GtkActionable + + + + + +this--implements_1 + + + + +implements_2 + + +GtkBuildable + + + + + +this--implements_2 + + + + +implements_3 + + +GtkConstraintTarget + + + + + +this--implements_3 + + + + +ancestor_0 + + +GtkButton + + + + + +ancestor_0--this + + + + +ancestor_1 + + +GtkWidget + + + + + +ancestor_1--ancestor_0 + + + + +ancestor_2 + + +GInitiallyUnowned + + + + + +ancestor_2--ancestor_1 + + + + +ancestor_3 + + +GObject + + + + + +ancestor_3--ancestor_2 + + + + + +
+
+ + + +
+

+ Ancestors + +

+ +
+ +
+
+ + + + + +
+

+ Implements + +

+ +
+ +
+
+ + + +
+

+ Constructors + +

+ +
+ +
+
clapper_gtk_toggle_fullscreen_button_new
+
+

Creates a new GtkWidget with button to toggle fullscreen state.

+
+
+

+
+
+ +
+
+ + + + + +
+

+ Instance methods + +

+ +
+ +
+ + + +
Methods inherited from GtkButton (10)
+
+
gtk_button_get_child
+
+

Gets the child widget of button.

+
+
+

+
+
gtk_button_get_has_frame
+
+

Returns whether the button has a frame.

+
+
+

+
+
gtk_button_get_icon_name
+
+

Returns the icon name of the button.

+
+
+

+
+
gtk_button_get_label
+
+

Fetches the text from the label of the button.

+
+
+

+
+
gtk_button_get_use_underline
+
+

Gets whether underlines are interpreted as mnemonics.

+
+
+

+
+
gtk_button_set_child
+
+

Sets the child widget of button.

+
+
+

+
+
gtk_button_set_has_frame
+
+

Sets the style of the button.

+
+
+

+
+
gtk_button_set_icon_name
+
+

Adds a GtkImage with the given icon name as a child.

+
+
+

+
+
gtk_button_set_label
+
+

Sets the text of the label of the button to label.

+
+
+

+
+
gtk_button_set_use_underline
+
+

Sets whether to use underlines as mnemonics.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkWidget (161)
+
+ +
+

Please see GtkWidget for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GObject (43)
+
+ +
+

Please see GObject for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GtkAccessible (18)
+
+
gtk_accessible_get_accessible_parent
+
+

Retrieves the accessible parent for an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_accessible_role
+
+

Retrieves the accessible role of an accessible object.

+
+
+

+
+
gtk_accessible_get_at_context
+
+

Retrieves the accessible implementation for the given GtkAccessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_bounds
+
+

Queries the coordinates and dimensions of this accessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_first_accessible_child
+
+

Retrieves the first accessible child of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_next_accessible_sibling
+
+

Retrieves the next accessible sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_platform_state
+
+

Query a platform state, such as focus.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_reset_property
+
+

Resets the accessible property to its default value.

+
+
+

+
+
gtk_accessible_reset_relation
+
+

Resets the accessible relation to its default value.

+
+
+

+
+
gtk_accessible_reset_state
+
+

Resets the accessible state to its default value.

+
+
+

+
+
gtk_accessible_set_accessible_parent
+
+

Sets the parent and sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_next_accessible_sibling
+
+

Updates the next accessible sibling of self.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_property
+
+

Updates a list of accessible properties.

+
+
+

+
+
gtk_accessible_update_property_value
+
+

Updates an array of accessible properties.

+
+
+

+
+
gtk_accessible_update_relation
+
+

Updates a list of accessible relations.

+
+
+

+
+
gtk_accessible_update_relation_value
+
+

Updates an array of accessible relations.

+
+
+

+
+
gtk_accessible_update_state
+
+

Updates a list of accessible states. See the GtkAccessibleState +documentation for the value types of accessible states.

+
+
+

+
+
gtk_accessible_update_state_value
+
+

Updates an array of accessible states.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkActionable (6)
+
+
gtk_actionable_get_action_name
+
+

Gets the action name for actionable.

+
+
+

+
+
gtk_actionable_get_action_target_value
+
+

Gets the current target value of actionable.

+
+
+

+
+
gtk_actionable_set_action_name
+
+

Specifies the name of the action with which this widget should be associated.

+
+
+

+
+
gtk_actionable_set_action_target
+
+

Sets the target of an actionable widget.

+
+
+

+
+
gtk_actionable_set_action_target_value
+
+

Sets the target value of an actionable widget.

+
+
+

+
+
gtk_actionable_set_detailed_action_name
+
+

Sets the action-name and associated string target value of an +actionable widget.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkBuildable (1)
+
+
gtk_buildable_get_buildable_id
+
+

Gets the ID of the buildable object.

+
+
+

+
+ +
+
+ + + + +
+ + + +
+

+ Properties + +

+ + + + + +
Properties inherited from GtkButton (5)
+
+
Gtk.Button:child
+
+

The child widget.

+
+
+

+
+
Gtk.Button:has-frame
+
+

Whether the button has a frame.

+
+
+

+
+
Gtk.Button:icon-name
+
+

The name of the icon used to automatically populate the button.

+
+
+

+
+
Gtk.Button:label
+
+

Text of the label inside the button, if the button contains a label widget.

+
+
+

+
+
Gtk.Button:use-underline
+
+

If set, an underline in the text indicates that the following character is +to be used as mnemonic.

+
+
+

+
+ +
+
+ + + +
Properties inherited from GtkWidget (34)
+
+
Gtk.Widget:can-focus
+
+

Whether the widget or any of its descendents can accept +the input focus.

+
+
+

+
+
Gtk.Widget:can-target
+
+

Whether the widget can receive pointer events.

+
+
+

+
+
Gtk.Widget:css-classes
+
+

A list of css classes applied to this widget.

+
+
+

+
+
Gtk.Widget:css-name
+
+

The name of this widget in the CSS tree.

+
+
+

+
+
Gtk.Widget:cursor
+
+

The cursor used by widget.

+
+
+

+
+
Gtk.Widget:focus-on-click
+
+

Whether the widget should grab focus when it is clicked with the mouse.

+
+
+

+
+
Gtk.Widget:focusable
+
+

Whether this widget itself will accept the input focus.

+
+
+

+
+
Gtk.Widget:halign
+
+

How to distribute horizontal space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:has-default
+
+

Whether the widget is the default widget.

+
+
+

+
+
Gtk.Widget:has-focus
+
+

Whether the widget has the input focus.

+
+
+

+
+
Gtk.Widget:has-tooltip
+
+

Enables or disables the emission of the ::query-tooltip signal on widget.

+
+
+

+
+
Gtk.Widget:height-request
+
+

Override for height request of the widget.

+
+
+

+
+
Gtk.Widget:hexpand
+
+

Whether to expand horizontally.

+
+
+

+
+
Gtk.Widget:hexpand-set
+
+

Whether to use the hexpand property.

+
+
+

+
+
Gtk.Widget:layout-manager
+
+

The GtkLayoutManager instance to use to compute the preferred size +of the widget, and allocate its children.

+
+
+

+
+
Gtk.Widget:margin-bottom
+
+

Margin on bottom side of widget.

+
+
+

+
+
Gtk.Widget:margin-end
+
+

Margin on end of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-start
+
+

Margin on start of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-top
+
+

Margin on top side of widget.

+
+
+

+
+
Gtk.Widget:name
+
+

The name of the widget.

+
+
+

+
+
Gtk.Widget:opacity
+
+

The requested opacity of the widget.

+
+
+

+
+
Gtk.Widget:overflow
+
+

How content outside the widget’s content area is treated.

+
+
+

+
+
Gtk.Widget:parent
+
+

The parent widget of this widget.

+
+
+

+
+
Gtk.Widget:receives-default
+
+

Whether the widget will receive the default action when it is focused.

+
+
+

+
+
Gtk.Widget:root
+
+

The GtkRoot widget of the widget tree containing this widget.

+
+
+

+
+
Gtk.Widget:scale-factor
+
+

The scale factor of the widget.

+
+
+

+
+
Gtk.Widget:sensitive
+
+

Whether the widget responds to input.

+
+
+

+
+
Gtk.Widget:tooltip-markup
+
+

Sets the text of tooltip to be the given string, which is marked up +with Pango markup.

+
+
+

+
+
Gtk.Widget:tooltip-text
+
+

Sets the text of tooltip to be the given string.

+
+
+

+
+
Gtk.Widget:valign
+
+

How to distribute vertical space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:vexpand
+
+

Whether to expand vertically.

+
+
+

+
+
Gtk.Widget:vexpand-set
+
+

Whether to use the vexpand property.

+
+
+

+
+
Gtk.Widget:visible
+
+

Whether the widget is visible.

+
+
+

+
+
Gtk.Widget:width-request
+
+

Override for width request of the widget.

+
+
+

+
+ +
+
+ + + + + + + + + +
Properties inherited from GtkAccessible (1)
+
+
Gtk.Accessible:accessible-role
+
+

The accessible role of the given GtkAccessible implementation.

+
+
+

+
+ +
+
+ + + +
Properties inherited from GtkActionable (2)
+
+
Gtk.Actionable:action-name
+
+ No description available. +
+
+

+
+
Gtk.Actionable:action-target
+
+ No description available. +
+
+

+
+ +
+
+ + + + + + + +
+ + + +
+

+ Signals + +

+ + + + + +
Signals inherited from GtkButton (2)
+
+
GtkButton::activate
+
+

Emitted to animate press then release.

+
+
+

+
+
GtkButton::clicked
+
+

Emitted when the button has been activated (pressed and released).

+
+
+

+
+ +
+
+ + + +
Signals inherited from GtkWidget (13)
+
+
GtkWidget::destroy
+
+

Signals that all holders of a reference to the widget should release +the reference that they hold.

+
+
+

+
+
GtkWidget::direction-changed
+
+

Emitted when the text direction of a widget changes.

+
+
+

+
+
GtkWidget::hide
+
+

Emitted when widget is hidden.

+
+
+

+
+
GtkWidget::keynav-failed
+
+

Emitted if keyboard navigation fails.

+
+
+

+
+
GtkWidget::map
+
+

Emitted when widget is going to be mapped.

+
+
+

+
+
GtkWidget::mnemonic-activate
+
+

Emitted when a widget is activated via a mnemonic.

+
+
+

+
+
GtkWidget::move-focus
+
+

Emitted when the focus is moved.

+
+
+

+
+
GtkWidget::query-tooltip
+
+

Emitted when the widget’s tooltip is about to be shown.

+
+
+

+
+
GtkWidget::realize
+
+

Emitted when widget is associated with a GdkSurface.

+
+
+

+
+
GtkWidget::show
+
+

Emitted when widget is shown.

+
+
+

+
+
GtkWidget::state-flags-changed
+
+

Emitted when the widget state changes.

+
+
+

+
+
GtkWidget::unmap
+
+

Emitted when widget is going to be unmapped.

+
+
+

+
+
GtkWidget::unrealize
+
+

Emitted when the GdkSurface associated with widget is destroyed.

+
+
+

+
+ +
+
+ + + + + +
Signals inherited from GObject (1)
+
+
GObject::notify
+
+

The notify signal is emitted on an object when one of its properties has +its value set through g_object_set_property(), g_object_set(), et al.

+
+
+

+
+ +
+
+ + + + + + + + + + + + + +
+ + + +
+

+ Class structure + +

+ +
+ 
struct ClapperGtkToggleFullscreenButtonClass {
+  GtkButtonClass parent_class;
+  
+}
+
+ +
+ No description available. +
+ + +
+
Class members
+ +
+ +
parent_class: GtkButtonClass
+
No description available.
+ + +
+ +
+ + + + + + +
+
+ + + +
+ +
+ + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/class.TogglePlayButton.html b/doc/clapper-gtk/class.TogglePlayButton.html new file mode 100644 index 00000000..3380dcfb --- /dev/null +++ b/doc/clapper-gtk/class.TogglePlayButton.html @@ -0,0 +1,1328 @@ + + + + + + ClapperGtk.TogglePlayButton + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Class

+

ClapperGtkTogglePlayButton

+
+ +
+ +
+

+
+ +
+

+ Description + + + [src] + +

+ + 
final class ClapperGtk.TogglePlayButton : Gtk.Button
+  implements Gtk.Accessible, Gtk.Actionable, Gtk.Buildable, Gtk.ConstraintTarget {
+  /* No available fields */
+}
+ +
+

A GtkButton for toggling play/pause of playback.

+
+ +
+ + + +
+ + +
+ + + +
+

+ Hierarchy + +

+
+ + + + + + +hierarchy + + +this + + +ClapperGtkTogglePlayButton + + + + + +implements_0 + + +GtkAccessible + + + + + +this--implements_0 + + + + +implements_1 + + +GtkActionable + + + + + +this--implements_1 + + + + +implements_2 + + +GtkBuildable + + + + + +this--implements_2 + + + + +implements_3 + + +GtkConstraintTarget + + + + + +this--implements_3 + + + + +ancestor_0 + + +GtkButton + + + + + +ancestor_0--this + + + + +ancestor_1 + + +GtkWidget + + + + + +ancestor_1--ancestor_0 + + + + +ancestor_2 + + +GInitiallyUnowned + + + + + +ancestor_2--ancestor_1 + + + + +ancestor_3 + + +GObject + + + + + +ancestor_3--ancestor_2 + + + + + +
+
+ + + +
+

+ Ancestors + +

+ +
+ +
+
+ + + + + +
+

+ Implements + +

+ +
+ +
+
+ + + +
+

+ Constructors + +

+ +
+ +
+
clapper_gtk_toggle_play_button_new
+
+

Creates a new GtkWidget with button to toggle playback.

+
+
+

+
+
+ +
+
+ + + + + +
+

+ Instance methods + +

+ +
+ +
+ + + +
Methods inherited from GtkButton (10)
+
+
gtk_button_get_child
+
+

Gets the child widget of button.

+
+
+

+
+
gtk_button_get_has_frame
+
+

Returns whether the button has a frame.

+
+
+

+
+
gtk_button_get_icon_name
+
+

Returns the icon name of the button.

+
+
+

+
+
gtk_button_get_label
+
+

Fetches the text from the label of the button.

+
+
+

+
+
gtk_button_get_use_underline
+
+

Gets whether underlines are interpreted as mnemonics.

+
+
+

+
+
gtk_button_set_child
+
+

Sets the child widget of button.

+
+
+

+
+
gtk_button_set_has_frame
+
+

Sets the style of the button.

+
+
+

+
+
gtk_button_set_icon_name
+
+

Adds a GtkImage with the given icon name as a child.

+
+
+

+
+
gtk_button_set_label
+
+

Sets the text of the label of the button to label.

+
+
+

+
+
gtk_button_set_use_underline
+
+

Sets whether to use underlines as mnemonics.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkWidget (161)
+
+ +
+

Please see GtkWidget for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GObject (43)
+
+ +
+

Please see GObject for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GtkAccessible (18)
+
+
gtk_accessible_get_accessible_parent
+
+

Retrieves the accessible parent for an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_accessible_role
+
+

Retrieves the accessible role of an accessible object.

+
+
+

+
+
gtk_accessible_get_at_context
+
+

Retrieves the accessible implementation for the given GtkAccessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_bounds
+
+

Queries the coordinates and dimensions of this accessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_first_accessible_child
+
+

Retrieves the first accessible child of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_next_accessible_sibling
+
+

Retrieves the next accessible sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_platform_state
+
+

Query a platform state, such as focus.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_reset_property
+
+

Resets the accessible property to its default value.

+
+
+

+
+
gtk_accessible_reset_relation
+
+

Resets the accessible relation to its default value.

+
+
+

+
+
gtk_accessible_reset_state
+
+

Resets the accessible state to its default value.

+
+
+

+
+
gtk_accessible_set_accessible_parent
+
+

Sets the parent and sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_next_accessible_sibling
+
+

Updates the next accessible sibling of self.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_property
+
+

Updates a list of accessible properties.

+
+
+

+
+
gtk_accessible_update_property_value
+
+

Updates an array of accessible properties.

+
+
+

+
+
gtk_accessible_update_relation
+
+

Updates a list of accessible relations.

+
+
+

+
+
gtk_accessible_update_relation_value
+
+

Updates an array of accessible relations.

+
+
+

+
+
gtk_accessible_update_state
+
+

Updates a list of accessible states. See the GtkAccessibleState +documentation for the value types of accessible states.

+
+
+

+
+
gtk_accessible_update_state_value
+
+

Updates an array of accessible states.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkActionable (6)
+
+
gtk_actionable_get_action_name
+
+

Gets the action name for actionable.

+
+
+

+
+
gtk_actionable_get_action_target_value
+
+

Gets the current target value of actionable.

+
+
+

+
+
gtk_actionable_set_action_name
+
+

Specifies the name of the action with which this widget should be associated.

+
+
+

+
+
gtk_actionable_set_action_target
+
+

Sets the target of an actionable widget.

+
+
+

+
+
gtk_actionable_set_action_target_value
+
+

Sets the target value of an actionable widget.

+
+
+

+
+
gtk_actionable_set_detailed_action_name
+
+

Sets the action-name and associated string target value of an +actionable widget.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkBuildable (1)
+
+
gtk_buildable_get_buildable_id
+
+

Gets the ID of the buildable object.

+
+
+

+
+ +
+
+ + + + +
+ + + +
+

+ Properties + +

+ + + + + +
Properties inherited from GtkButton (5)
+
+
Gtk.Button:child
+
+

The child widget.

+
+
+

+
+
Gtk.Button:has-frame
+
+

Whether the button has a frame.

+
+
+

+
+
Gtk.Button:icon-name
+
+

The name of the icon used to automatically populate the button.

+
+
+

+
+
Gtk.Button:label
+
+

Text of the label inside the button, if the button contains a label widget.

+
+
+

+
+
Gtk.Button:use-underline
+
+

If set, an underline in the text indicates that the following character is +to be used as mnemonic.

+
+
+

+
+ +
+
+ + + +
Properties inherited from GtkWidget (34)
+
+
Gtk.Widget:can-focus
+
+

Whether the widget or any of its descendents can accept +the input focus.

+
+
+

+
+
Gtk.Widget:can-target
+
+

Whether the widget can receive pointer events.

+
+
+

+
+
Gtk.Widget:css-classes
+
+

A list of css classes applied to this widget.

+
+
+

+
+
Gtk.Widget:css-name
+
+

The name of this widget in the CSS tree.

+
+
+

+
+
Gtk.Widget:cursor
+
+

The cursor used by widget.

+
+
+

+
+
Gtk.Widget:focus-on-click
+
+

Whether the widget should grab focus when it is clicked with the mouse.

+
+
+

+
+
Gtk.Widget:focusable
+
+

Whether this widget itself will accept the input focus.

+
+
+

+
+
Gtk.Widget:halign
+
+

How to distribute horizontal space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:has-default
+
+

Whether the widget is the default widget.

+
+
+

+
+
Gtk.Widget:has-focus
+
+

Whether the widget has the input focus.

+
+
+

+
+
Gtk.Widget:has-tooltip
+
+

Enables or disables the emission of the ::query-tooltip signal on widget.

+
+
+

+
+
Gtk.Widget:height-request
+
+

Override for height request of the widget.

+
+
+

+
+
Gtk.Widget:hexpand
+
+

Whether to expand horizontally.

+
+
+

+
+
Gtk.Widget:hexpand-set
+
+

Whether to use the hexpand property.

+
+
+

+
+
Gtk.Widget:layout-manager
+
+

The GtkLayoutManager instance to use to compute the preferred size +of the widget, and allocate its children.

+
+
+

+
+
Gtk.Widget:margin-bottom
+
+

Margin on bottom side of widget.

+
+
+

+
+
Gtk.Widget:margin-end
+
+

Margin on end of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-start
+
+

Margin on start of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-top
+
+

Margin on top side of widget.

+
+
+

+
+
Gtk.Widget:name
+
+

The name of the widget.

+
+
+

+
+
Gtk.Widget:opacity
+
+

The requested opacity of the widget.

+
+
+

+
+
Gtk.Widget:overflow
+
+

How content outside the widget’s content area is treated.

+
+
+

+
+
Gtk.Widget:parent
+
+

The parent widget of this widget.

+
+
+

+
+
Gtk.Widget:receives-default
+
+

Whether the widget will receive the default action when it is focused.

+
+
+

+
+
Gtk.Widget:root
+
+

The GtkRoot widget of the widget tree containing this widget.

+
+
+

+
+
Gtk.Widget:scale-factor
+
+

The scale factor of the widget.

+
+
+

+
+
Gtk.Widget:sensitive
+
+

Whether the widget responds to input.

+
+
+

+
+
Gtk.Widget:tooltip-markup
+
+

Sets the text of tooltip to be the given string, which is marked up +with Pango markup.

+
+
+

+
+
Gtk.Widget:tooltip-text
+
+

Sets the text of tooltip to be the given string.

+
+
+

+
+
Gtk.Widget:valign
+
+

How to distribute vertical space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:vexpand
+
+

Whether to expand vertically.

+
+
+

+
+
Gtk.Widget:vexpand-set
+
+

Whether to use the vexpand property.

+
+
+

+
+
Gtk.Widget:visible
+
+

Whether the widget is visible.

+
+
+

+
+
Gtk.Widget:width-request
+
+

Override for width request of the widget.

+
+
+

+
+ +
+
+ + + + + + + + + +
Properties inherited from GtkAccessible (1)
+
+
Gtk.Accessible:accessible-role
+
+

The accessible role of the given GtkAccessible implementation.

+
+
+

+
+ +
+
+ + + +
Properties inherited from GtkActionable (2)
+
+
Gtk.Actionable:action-name
+
+ No description available. +
+
+

+
+
Gtk.Actionable:action-target
+
+ No description available. +
+
+

+
+ +
+
+ + + + + + + +
+ + + +
+

+ Signals + +

+ + + + + +
Signals inherited from GtkButton (2)
+
+
GtkButton::activate
+
+

Emitted to animate press then release.

+
+
+

+
+
GtkButton::clicked
+
+

Emitted when the button has been activated (pressed and released).

+
+
+

+
+ +
+
+ + + +
Signals inherited from GtkWidget (13)
+
+
GtkWidget::destroy
+
+

Signals that all holders of a reference to the widget should release +the reference that they hold.

+
+
+

+
+
GtkWidget::direction-changed
+
+

Emitted when the text direction of a widget changes.

+
+
+

+
+
GtkWidget::hide
+
+

Emitted when widget is hidden.

+
+
+

+
+
GtkWidget::keynav-failed
+
+

Emitted if keyboard navigation fails.

+
+
+

+
+
GtkWidget::map
+
+

Emitted when widget is going to be mapped.

+
+
+

+
+
GtkWidget::mnemonic-activate
+
+

Emitted when a widget is activated via a mnemonic.

+
+
+

+
+
GtkWidget::move-focus
+
+

Emitted when the focus is moved.

+
+
+

+
+
GtkWidget::query-tooltip
+
+

Emitted when the widget’s tooltip is about to be shown.

+
+
+

+
+
GtkWidget::realize
+
+

Emitted when widget is associated with a GdkSurface.

+
+
+

+
+
GtkWidget::show
+
+

Emitted when widget is shown.

+
+
+

+
+
GtkWidget::state-flags-changed
+
+

Emitted when the widget state changes.

+
+
+

+
+
GtkWidget::unmap
+
+

Emitted when widget is going to be unmapped.

+
+
+

+
+
GtkWidget::unrealize
+
+

Emitted when the GdkSurface associated with widget is destroyed.

+
+
+

+
+ +
+
+ + + + + +
Signals inherited from GObject (1)
+
+
GObject::notify
+
+

The notify signal is emitted on an object when one of its properties has +its value set through g_object_set_property(), g_object_set(), et al.

+
+
+

+
+ +
+
+ + + + + + + + + + + + + +
+ + + +
+

+ Class structure + +

+ +
+ 
struct ClapperGtkTogglePlayButtonClass {
+  GtkButtonClass parent_class;
+  
+}
+
+ +
+ No description available. +
+ + +
+
Class members
+ +
+ +
parent_class: GtkButtonClass
+
No description available.
+ + +
+ +
+ + + + + + +
+
+ + + +
+ +
+ + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/class.Video.html b/doc/clapper-gtk/class.Video.html new file mode 100644 index 00000000..9c389f86 --- /dev/null +++ b/doc/clapper-gtk/class.Video.html @@ -0,0 +1,1315 @@ + + + + + + ClapperGtk.Video + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Class

+

ClapperGtkVideo

+
+ +
+ +
+

+
+ +
+

+ Description + + + [src] + +

+ + 
final class ClapperGtk.Video : Gtk.Widget
+  implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget {
+  /* No available fields */
+}
+ +
+

A ready to be used GTK video widget implementing Clapper API.

+

ClapperGtkVideo is the main widget exposed by ClapperGtk API. All other widgets +exposed by this library are meant to be overlaid on top of this widget.

+

For example a button type of widget once placed anywhere on video (can also be +nested within another widget like GtkBox) automatically works and controls +ClapperGtkVideo widget it was overlaid on top of. This allows freely creating custom +playback control panels best suited for specific application. Additionally, pre-made +widgets such as ClapperGtkSimpleControls are also available.

+
+ +
+ + + +
+ + +
+ + + +
+

+ Hierarchy + +

+
+ + + + + + +hierarchy + + +this + + +ClapperGtkVideo + + + + + +implements_0 + + +GtkAccessible + + + + + +this--implements_0 + + + + +implements_1 + + +GtkBuildable + + + + + +this--implements_1 + + + + +implements_2 + + +GtkConstraintTarget + + + + + +this--implements_2 + + + + +ancestor_0 + + +GtkWidget + + + + + +ancestor_0--this + + + + +ancestor_1 + + +GInitiallyUnowned + + + + + +ancestor_1--ancestor_0 + + + + +ancestor_2 + + +GObject + + + + + +ancestor_2--ancestor_1 + + + + + +
+
+ + + +
+

+ Ancestors + +

+ +
+ +
+
+ + + + + +
+

+ Implements + +

+ +
+ +
+
+ + + +
+

+ Constructors + +

+ +
+ +
+
clapper_gtk_video_new
+
+

Creates a new ClapperGtkVideo instance.

+
+
+

+
+
+ +
+
+ + + + + +
+

+ Instance methods + +

+ +
+ +
+
clapper_gtk_video_add_fading_overlay
+
+

Similiar as clapper_gtk_video_add_overlay() but will also automatically +add fading functionality to overlaid GtkWidget for convenience. This will +make widget reveal itself when interacting with video and fade otherwise. +Useful when placing widgets such as playback controls panels.

+
+
+

+
+
+ +
+
clapper_gtk_video_add_overlay
+
+

Add another GtkWidget to be overlaid on top of video.

+
+
+

+
+
+ +
+
clapper_gtk_video_get_auto_inhibit
+
+

Get whether automatic session inhibit is enabled.

+
+
+

+
+
+ +
+
clapper_gtk_video_get_fade_delay
+
+

Get time in milliseconds after which fading overlays should fade.

+
+
+

+
+
+ +
+
clapper_gtk_video_get_inhibited
+
+

Get whether session is currently inhibited by +ClapperGtkVideo:auto-inhibit.

+
+
+

+
+
+ +
+
clapper_gtk_video_get_player
+
+

Get ClapperPlayer used by this ClapperGtkVideo instance.

+
+
+

+
+
+ +
+
clapper_gtk_video_get_touch_fade_delay
+
+

Get time in milliseconds after which fading overlays should fade +when revealed using touch device.

+
+
+

+
+
+ +
+
clapper_gtk_video_set_auto_inhibit
+
+

Set whether video should try to automatically inhibit session +from idling (and possibly screen going black) when video is playing.

+
+
+

+
+
+ +
+
clapper_gtk_video_set_fade_delay
+
+

Set time in milliseconds after which fading overlays should fade.

+
+
+

+
+
+ +
+
clapper_gtk_video_set_touch_fade_delay
+
+

Set time in milliseconds after which fading overlays should fade +when using touchscreen.

+
+
+

+
+
+ +
+ + + +
Methods inherited from GtkWidget (161)
+
+ +
+

Please see GtkWidget for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GObject (43)
+
+ +
+

Please see GObject for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GtkAccessible (18)
+
+
gtk_accessible_get_accessible_parent
+
+

Retrieves the accessible parent for an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_accessible_role
+
+

Retrieves the accessible role of an accessible object.

+
+
+

+
+
gtk_accessible_get_at_context
+
+

Retrieves the accessible implementation for the given GtkAccessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_bounds
+
+

Queries the coordinates and dimensions of this accessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_first_accessible_child
+
+

Retrieves the first accessible child of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_next_accessible_sibling
+
+

Retrieves the next accessible sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_platform_state
+
+

Query a platform state, such as focus.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_reset_property
+
+

Resets the accessible property to its default value.

+
+
+

+
+
gtk_accessible_reset_relation
+
+

Resets the accessible relation to its default value.

+
+
+

+
+
gtk_accessible_reset_state
+
+

Resets the accessible state to its default value.

+
+
+

+
+
gtk_accessible_set_accessible_parent
+
+

Sets the parent and sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_next_accessible_sibling
+
+

Updates the next accessible sibling of self.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_property
+
+

Updates a list of accessible properties.

+
+
+

+
+
gtk_accessible_update_property_value
+
+

Updates an array of accessible properties.

+
+
+

+
+
gtk_accessible_update_relation
+
+

Updates a list of accessible relations.

+
+
+

+
+
gtk_accessible_update_relation_value
+
+

Updates an array of accessible relations.

+
+
+

+
+
gtk_accessible_update_state
+
+

Updates a list of accessible states. See the GtkAccessibleState +documentation for the value types of accessible states.

+
+
+

+
+
gtk_accessible_update_state_value
+
+

Updates an array of accessible states.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkBuildable (1)
+
+
gtk_buildable_get_buildable_id
+
+

Gets the ID of the buildable object.

+
+
+

+
+ +
+
+ + + + +
+ + + +
+

+ Properties + +

+ + +
+ +
+
ClapperGtk.Video:auto-inhibit
+
+

Try to automatically inhibit session when video is playing.

+
+
+

+
+
+ +
+
ClapperGtk.Video:fade-delay
+
+

A delay in milliseconds before trying to fade all fading overlays.

+
+
+

+
+
+ +
+
ClapperGtk.Video:inhibited
+
+

Get whether session is currently inhibited by the video.

+
+
+

+
+
+ +
+
ClapperGtk.Video:player
+
+

A ClapperPlayer used by video.

+
+
+

+
+
+ +
+
ClapperGtk.Video:touch-fade-delay
+
+

A delay in milliseconds before trying to fade all fading overlays +after revealed using touchscreen.

+
+
+

+
+
+ +
+ + + + +
Properties inherited from GtkWidget (34)
+
+
Gtk.Widget:can-focus
+
+

Whether the widget or any of its descendents can accept +the input focus.

+
+
+

+
+
Gtk.Widget:can-target
+
+

Whether the widget can receive pointer events.

+
+
+

+
+
Gtk.Widget:css-classes
+
+

A list of css classes applied to this widget.

+
+
+

+
+
Gtk.Widget:css-name
+
+

The name of this widget in the CSS tree.

+
+
+

+
+
Gtk.Widget:cursor
+
+

The cursor used by widget.

+
+
+

+
+
Gtk.Widget:focus-on-click
+
+

Whether the widget should grab focus when it is clicked with the mouse.

+
+
+

+
+
Gtk.Widget:focusable
+
+

Whether this widget itself will accept the input focus.

+
+
+

+
+
Gtk.Widget:halign
+
+

How to distribute horizontal space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:has-default
+
+

Whether the widget is the default widget.

+
+
+

+
+
Gtk.Widget:has-focus
+
+

Whether the widget has the input focus.

+
+
+

+
+
Gtk.Widget:has-tooltip
+
+

Enables or disables the emission of the ::query-tooltip signal on widget.

+
+
+

+
+
Gtk.Widget:height-request
+
+

Override for height request of the widget.

+
+
+

+
+
Gtk.Widget:hexpand
+
+

Whether to expand horizontally.

+
+
+

+
+
Gtk.Widget:hexpand-set
+
+

Whether to use the hexpand property.

+
+
+

+
+
Gtk.Widget:layout-manager
+
+

The GtkLayoutManager instance to use to compute the preferred size +of the widget, and allocate its children.

+
+
+

+
+
Gtk.Widget:margin-bottom
+
+

Margin on bottom side of widget.

+
+
+

+
+
Gtk.Widget:margin-end
+
+

Margin on end of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-start
+
+

Margin on start of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-top
+
+

Margin on top side of widget.

+
+
+

+
+
Gtk.Widget:name
+
+

The name of the widget.

+
+
+

+
+
Gtk.Widget:opacity
+
+

The requested opacity of the widget.

+
+
+

+
+
Gtk.Widget:overflow
+
+

How content outside the widget’s content area is treated.

+
+
+

+
+
Gtk.Widget:parent
+
+

The parent widget of this widget.

+
+
+

+
+
Gtk.Widget:receives-default
+
+

Whether the widget will receive the default action when it is focused.

+
+
+

+
+
Gtk.Widget:root
+
+

The GtkRoot widget of the widget tree containing this widget.

+
+
+

+
+
Gtk.Widget:scale-factor
+
+

The scale factor of the widget.

+
+
+

+
+
Gtk.Widget:sensitive
+
+

Whether the widget responds to input.

+
+
+

+
+
Gtk.Widget:tooltip-markup
+
+

Sets the text of tooltip to be the given string, which is marked up +with Pango markup.

+
+
+

+
+
Gtk.Widget:tooltip-text
+
+

Sets the text of tooltip to be the given string.

+
+
+

+
+
Gtk.Widget:valign
+
+

How to distribute vertical space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:vexpand
+
+

Whether to expand vertically.

+
+
+

+
+
Gtk.Widget:vexpand-set
+
+

Whether to use the vexpand property.

+
+
+

+
+
Gtk.Widget:visible
+
+

Whether the widget is visible.

+
+
+

+
+
Gtk.Widget:width-request
+
+

Override for width request of the widget.

+
+
+

+
+ +
+
+ + + + + + + + + +
Properties inherited from GtkAccessible (1)
+
+
Gtk.Accessible:accessible-role
+
+

The accessible role of the given GtkAccessible implementation.

+
+
+

+
+ +
+
+ + + + + + + +
+ + + +
+

+ Signals + +

+ + +
+ +
+
ClapperGtk.Video::toggle-fullscreen
+
+

A signal that user requested a change in fullscreen state of the video.

+
+
+

+
+
+ +
+ + + + +
Signals inherited from GtkWidget (13)
+
+
GtkWidget::destroy
+
+

Signals that all holders of a reference to the widget should release +the reference that they hold.

+
+
+

+
+
GtkWidget::direction-changed
+
+

Emitted when the text direction of a widget changes.

+
+
+

+
+
GtkWidget::hide
+
+

Emitted when widget is hidden.

+
+
+

+
+
GtkWidget::keynav-failed
+
+

Emitted if keyboard navigation fails.

+
+
+

+
+
GtkWidget::map
+
+

Emitted when widget is going to be mapped.

+
+
+

+
+
GtkWidget::mnemonic-activate
+
+

Emitted when a widget is activated via a mnemonic.

+
+
+

+
+
GtkWidget::move-focus
+
+

Emitted when the focus is moved.

+
+
+

+
+
GtkWidget::query-tooltip
+
+

Emitted when the widget’s tooltip is about to be shown.

+
+
+

+
+
GtkWidget::realize
+
+

Emitted when widget is associated with a GdkSurface.

+
+
+

+
+
GtkWidget::show
+
+

Emitted when widget is shown.

+
+
+

+
+
GtkWidget::state-flags-changed
+
+

Emitted when the widget state changes.

+
+
+

+
+
GtkWidget::unmap
+
+

Emitted when widget is going to be unmapped.

+
+
+

+
+
GtkWidget::unrealize
+
+

Emitted when the GdkSurface associated with widget is destroyed.

+
+
+

+
+ +
+
+ + + + + +
Signals inherited from GObject (1)
+
+
GObject::notify
+
+

The notify signal is emitted on an object when one of its properties has +its value set through g_object_set_property(), g_object_set(), et al.

+
+
+

+
+ +
+
+ + + + + + + + + + + +
+ + + +
+

+ Class structure + +

+ +
+ 
struct ClapperGtkVideoClass {
+  GtkWidgetClass parent_class;
+  
+}
+
+ +
+ No description available. +
+ + +
+
Class members
+ +
+ +
parent_class: GtkWidgetClass
+
No description available.
+ + +
+ +
+ + + + + + +
+
+ + + +
+ +
+ + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/class.WindowStateButtons.html b/doc/clapper-gtk/class.WindowStateButtons.html new file mode 100644 index 00000000..5c765a4b --- /dev/null +++ b/doc/clapper-gtk/class.WindowStateButtons.html @@ -0,0 +1,1266 @@ + + + + + + ClapperGtk.WindowStateButtons + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Class

+

ClapperGtkWindowStateButtons

+
+ +
+ +
+

+
+ +
+

+ Description + + +

+ + 
final class ClapperGtk.WindowStateButtons : Gtk.Box
+  implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget, Gtk.Orientable {
+  /* No available fields */
+}
+ +
+ No description available. +
+ +
+ + + +
+ + +
+ + + +
+

+ Hierarchy + +

+
+ + + + + + +hierarchy + + +this + + +ClapperGtkWindowStateButtons + + + + + +implements_0 + + +GtkAccessible + + + + + +this--implements_0 + + + + +implements_1 + + +GtkBuildable + + + + + +this--implements_1 + + + + +implements_2 + + +GtkConstraintTarget + + + + + +this--implements_2 + + + + +implements_3 + + +GtkOrientable + + + + + +this--implements_3 + + + + +ancestor_0 + + +GtkBox + + + + + +ancestor_0--this + + + + +ancestor_1 + + +GtkWidget + + + + + +ancestor_1--ancestor_0 + + + + +ancestor_2 + + +GInitiallyUnowned + + + + + +ancestor_2--ancestor_1 + + + + +ancestor_3 + + +GObject + + + + + +ancestor_3--ancestor_2 + + + + + +
+
+ + + +
+

+ Ancestors + +

+ +
+ +
+
+ + + + + +
+

+ Implements + +

+ +
+ +
+
+ + + +
+

+ Constructors + +

+ +
+ +
+
clapper_gtk_window_state_buttons_new
+
+

Creates a new GtkWidget with window state control buttons.

+
+
+

+
+
+ +
+
+ + + + + +
+

+ Instance methods + +

+ +
+ +
+ + + +
Methods inherited from GtkBox (11)
+
+
gtk_box_append
+
+

Adds child as the last child to box.

+
+
+

+
+
gtk_box_get_baseline_position
+
+

Gets the value set by gtk_box_set_baseline_position().

+
+
+

+
+
gtk_box_get_homogeneous
+
+

Returns whether the box is homogeneous (all children are the +same size).

+
+
+

+
+
gtk_box_get_spacing
+
+

Gets the value set by gtk_box_set_spacing().

+
+
+

+
+
gtk_box_insert_child_after
+
+

Inserts child in the position after sibling in the list +of box children.

+
+
+

+
+
gtk_box_prepend
+
+

Adds child as the first child to box.

+
+
+

+
+
gtk_box_remove
+
+

Removes a child widget from box.

+
+
+

+
+
gtk_box_reorder_child_after
+
+

Moves child to the position after sibling in the list +of box children.

+
+
+

+
+
gtk_box_set_baseline_position
+
+

Sets the baseline position of a box.

+
+
+

+
+
gtk_box_set_homogeneous
+
+

Sets whether or not all children of box are given equal space +in the box.

+
+
+

+
+
gtk_box_set_spacing
+
+

Sets the number of pixels to place between children of box.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkWidget (161)
+
+ +
+

Please see GtkWidget for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GObject (43)
+
+ +
+

Please see GObject for a full list of methods.

+
+ +
+
+ + + + + +
Methods inherited from GtkAccessible (18)
+
+
gtk_accessible_get_accessible_parent
+
+

Retrieves the accessible parent for an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_accessible_role
+
+

Retrieves the accessible role of an accessible object.

+
+
+

+
+
gtk_accessible_get_at_context
+
+

Retrieves the accessible implementation for the given GtkAccessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_bounds
+
+

Queries the coordinates and dimensions of this accessible.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_first_accessible_child
+
+

Retrieves the first accessible child of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_next_accessible_sibling
+
+

Retrieves the next accessible sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_get_platform_state
+
+

Query a platform state, such as focus.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_reset_property
+
+

Resets the accessible property to its default value.

+
+
+

+
+
gtk_accessible_reset_relation
+
+

Resets the accessible relation to its default value.

+
+
+

+
+
gtk_accessible_reset_state
+
+

Resets the accessible state to its default value.

+
+
+

+
+
gtk_accessible_set_accessible_parent
+
+

Sets the parent and sibling of an accessible object.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_next_accessible_sibling
+
+

Updates the next accessible sibling of self.

+
+
+

unstable since: 4.10

+
+
gtk_accessible_update_property
+
+

Updates a list of accessible properties.

+
+
+

+
+
gtk_accessible_update_property_value
+
+

Updates an array of accessible properties.

+
+
+

+
+
gtk_accessible_update_relation
+
+

Updates a list of accessible relations.

+
+
+

+
+
gtk_accessible_update_relation_value
+
+

Updates an array of accessible relations.

+
+
+

+
+
gtk_accessible_update_state
+
+

Updates a list of accessible states. See the GtkAccessibleState +documentation for the value types of accessible states.

+
+
+

+
+
gtk_accessible_update_state_value
+
+

Updates an array of accessible states.

+
+
+

+
+ +
+
+ + + +
Methods inherited from GtkBuildable (1)
+
+
gtk_buildable_get_buildable_id
+
+

Gets the ID of the buildable object.

+
+
+

+
+ +
+
+ + + + + +
Methods inherited from GtkOrientable (2)
+
+
gtk_orientable_get_orientation
+
+

Retrieves the orientation of the orientable.

+
+
+

+
+
gtk_orientable_set_orientation
+
+

Sets the orientation of the orientable.

+
+
+

+
+ +
+
+ + +
+ + + +
+

+ Properties + +

+ + + + + +
Properties inherited from GtkBox (3)
+
+
Gtk.Box:baseline-position
+
+

The position of the baseline aligned widgets if extra space is available.

+
+
+

+
+
Gtk.Box:homogeneous
+
+

Whether the children should all be the same size.

+
+
+

+
+
Gtk.Box:spacing
+
+

The amount of space between children.

+
+
+

+
+ +
+
+ + + +
Properties inherited from GtkWidget (34)
+
+
Gtk.Widget:can-focus
+
+

Whether the widget or any of its descendents can accept +the input focus.

+
+
+

+
+
Gtk.Widget:can-target
+
+

Whether the widget can receive pointer events.

+
+
+

+
+
Gtk.Widget:css-classes
+
+

A list of css classes applied to this widget.

+
+
+

+
+
Gtk.Widget:css-name
+
+

The name of this widget in the CSS tree.

+
+
+

+
+
Gtk.Widget:cursor
+
+

The cursor used by widget.

+
+
+

+
+
Gtk.Widget:focus-on-click
+
+

Whether the widget should grab focus when it is clicked with the mouse.

+
+
+

+
+
Gtk.Widget:focusable
+
+

Whether this widget itself will accept the input focus.

+
+
+

+
+
Gtk.Widget:halign
+
+

How to distribute horizontal space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:has-default
+
+

Whether the widget is the default widget.

+
+
+

+
+
Gtk.Widget:has-focus
+
+

Whether the widget has the input focus.

+
+
+

+
+
Gtk.Widget:has-tooltip
+
+

Enables or disables the emission of the ::query-tooltip signal on widget.

+
+
+

+
+
Gtk.Widget:height-request
+
+

Override for height request of the widget.

+
+
+

+
+
Gtk.Widget:hexpand
+
+

Whether to expand horizontally.

+
+
+

+
+
Gtk.Widget:hexpand-set
+
+

Whether to use the hexpand property.

+
+
+

+
+
Gtk.Widget:layout-manager
+
+

The GtkLayoutManager instance to use to compute the preferred size +of the widget, and allocate its children.

+
+
+

+
+
Gtk.Widget:margin-bottom
+
+

Margin on bottom side of widget.

+
+
+

+
+
Gtk.Widget:margin-end
+
+

Margin on end of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-start
+
+

Margin on start of widget, horizontally.

+
+
+

+
+
Gtk.Widget:margin-top
+
+

Margin on top side of widget.

+
+
+

+
+
Gtk.Widget:name
+
+

The name of the widget.

+
+
+

+
+
Gtk.Widget:opacity
+
+

The requested opacity of the widget.

+
+
+

+
+
Gtk.Widget:overflow
+
+

How content outside the widget’s content area is treated.

+
+
+

+
+
Gtk.Widget:parent
+
+

The parent widget of this widget.

+
+
+

+
+
Gtk.Widget:receives-default
+
+

Whether the widget will receive the default action when it is focused.

+
+
+

+
+
Gtk.Widget:root
+
+

The GtkRoot widget of the widget tree containing this widget.

+
+
+

+
+
Gtk.Widget:scale-factor
+
+

The scale factor of the widget.

+
+
+

+
+
Gtk.Widget:sensitive
+
+

Whether the widget responds to input.

+
+
+

+
+
Gtk.Widget:tooltip-markup
+
+

Sets the text of tooltip to be the given string, which is marked up +with Pango markup.

+
+
+

+
+
Gtk.Widget:tooltip-text
+
+

Sets the text of tooltip to be the given string.

+
+
+

+
+
Gtk.Widget:valign
+
+

How to distribute vertical space if widget gets extra space.

+
+
+

+
+
Gtk.Widget:vexpand
+
+

Whether to expand vertically.

+
+
+

+
+
Gtk.Widget:vexpand-set
+
+

Whether to use the vexpand property.

+
+
+

+
+
Gtk.Widget:visible
+
+

Whether the widget is visible.

+
+
+

+
+
Gtk.Widget:width-request
+
+

Override for width request of the widget.

+
+
+

+
+ +
+
+ + + + + + + + + +
Properties inherited from GtkAccessible (1)
+
+
Gtk.Accessible:accessible-role
+
+

The accessible role of the given GtkAccessible implementation.

+
+
+

+
+ +
+
+ + + + + + + +
Properties inherited from GtkOrientable (1)
+
+
Gtk.Orientable:orientation
+
+

The orientation of the orientable.

+
+
+

+
+ +
+
+ + + +
+ + + +
+

+ Signals + +

+ + + + + + + +
Signals inherited from GtkWidget (13)
+
+
GtkWidget::destroy
+
+

Signals that all holders of a reference to the widget should release +the reference that they hold.

+
+
+

+
+
GtkWidget::direction-changed
+
+

Emitted when the text direction of a widget changes.

+
+
+

+
+
GtkWidget::hide
+
+

Emitted when widget is hidden.

+
+
+

+
+
GtkWidget::keynav-failed
+
+

Emitted if keyboard navigation fails.

+
+
+

+
+
GtkWidget::map
+
+

Emitted when widget is going to be mapped.

+
+
+

+
+
GtkWidget::mnemonic-activate
+
+

Emitted when a widget is activated via a mnemonic.

+
+
+

+
+
GtkWidget::move-focus
+
+

Emitted when the focus is moved.

+
+
+

+
+
GtkWidget::query-tooltip
+
+

Emitted when the widget’s tooltip is about to be shown.

+
+
+

+
+
GtkWidget::realize
+
+

Emitted when widget is associated with a GdkSurface.

+
+
+

+
+
GtkWidget::show
+
+

Emitted when widget is shown.

+
+
+

+
+
GtkWidget::state-flags-changed
+
+

Emitted when the widget state changes.

+
+
+

+
+
GtkWidget::unmap
+
+

Emitted when widget is going to be unmapped.

+
+
+

+
+
GtkWidget::unrealize
+
+

Emitted when the GdkSurface associated with widget is destroyed.

+
+
+

+
+ +
+
+ + + + + +
Signals inherited from GObject (1)
+
+
GObject::notify
+
+

The notify signal is emitted on an object when one of its properties has +its value set through g_object_set_property(), g_object_set(), et al.

+
+
+

+
+ +
+
+ + + + + + + + + + + + + +
+ + + +
+

+ Class structure + +

+ +
+ 
struct ClapperGtkWindowStateButtonsClass {
+  GtkBoxClass parent_class;
+  
+}
+
+ +
+ No description available. +
+ + +
+
Class members
+ +
+ +
parent_class: GtkBoxClass
+
No description available.
+ + +
+ +
+ + + + + + +
+
+ + + +
+ +
+ + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/classes_hierarchy.html b/doc/clapper-gtk/classes_hierarchy.html new file mode 100644 index 00000000..00f6f2e1 --- /dev/null +++ b/doc/clapper-gtk/classes_hierarchy.html @@ -0,0 +1,181 @@ + + + + + + ClapperGtk – 0.0: Classes Hierarchy + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ +

+ Classes Hierarchy + + +

+ +
+
+

Classes Hierarchy

+
+ +
+
+
+
+ + + +
+ +
+ + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/const.MAJOR_VERSION.html b/doc/clapper-gtk/const.MAJOR_VERSION.html new file mode 100644 index 00000000..6836fa71 --- /dev/null +++ b/doc/clapper-gtk/const.MAJOR_VERSION.html @@ -0,0 +1,153 @@ + + + + + + ClapperGtk.MAJOR_VERSION + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Constant

+

ClapperGtkMAJOR_VERSION

+
+ +
+
+

+
+ +
+

+ Declaration + + +

+ +
+ 
#define CLAPPER_GTK_MAJOR_VERSION 0
+

+
+
+
+ +
+

+ Description + + +

+ +
+

ClapperGtk major version component.

+
+ +
+ + + +
+ + +
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/const.MICRO_VERSION.html b/doc/clapper-gtk/const.MICRO_VERSION.html new file mode 100644 index 00000000..6701245e --- /dev/null +++ b/doc/clapper-gtk/const.MICRO_VERSION.html @@ -0,0 +1,153 @@ + + + + + + ClapperGtk.MICRO_VERSION + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Constant

+

ClapperGtkMICRO_VERSION

+
+ +
+
+

+
+ +
+

+ Declaration + + +

+ +
+ 
#define CLAPPER_GTK_MICRO_VERSION 2
+

+
+
+
+ +
+

+ Description + + +

+ +
+

ClapperGtk micro version component.

+
+ +
+ + + +
+ + +
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/const.MINOR_VERSION.html b/doc/clapper-gtk/const.MINOR_VERSION.html new file mode 100644 index 00000000..5d0b9c52 --- /dev/null +++ b/doc/clapper-gtk/const.MINOR_VERSION.html @@ -0,0 +1,153 @@ + + + + + + ClapperGtk.MINOR_VERSION + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Constant

+

ClapperGtkMINOR_VERSION

+
+ +
+
+

+
+ +
+

+ Declaration + + +

+ +
+ 
#define CLAPPER_GTK_MINOR_VERSION 5
+

+
+
+
+ +
+

+ Description + + +

+ +
+

ClapperGtk minor version component.

+
+ +
+ + + +
+ + +
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/const.VERSION_S.html b/doc/clapper-gtk/const.VERSION_S.html new file mode 100644 index 00000000..ef99b91f --- /dev/null +++ b/doc/clapper-gtk/const.VERSION_S.html @@ -0,0 +1,153 @@ + + + + + + ClapperGtk.VERSION_S + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Constant

+

ClapperGtkVERSION_S

+
+ +
+
+

+
+ +
+

+ Declaration + + +

+ +
+ 
#define CLAPPER_GTK_VERSION_S "0.5.2"
+

+
+
+
+ +
+

+ Description + + +

+ +
+

ClapperGtk version, encoded as a string.

+
+ +
+ + + +
+ + +
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/ctor.Billboard.new.html b/doc/clapper-gtk/ctor.Billboard.new.html new file mode 100644 index 00000000..201f67e9 --- /dev/null +++ b/doc/clapper-gtk/ctor.Billboard.new.html @@ -0,0 +1,197 @@ + + + + + + ClapperGtk.Billboard.new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Constructor

+

ClapperGtkBillboardnew

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
GtkWidget*
+clapper_gtk_billboard_new (
+  void
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Creates a new ClapperGtkBillboard instance.

+
+ +
+ + + + +
+ + +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: GtkWidget

+

A new billboard GtkWidget.

+
+
+ + + + + + + +
The caller of the function takes ownership of the data, and is responsible for freeing it.
+
+
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/ctor.BulletinBoard.new.html b/doc/clapper-gtk/ctor.BulletinBoard.new.html new file mode 100644 index 00000000..e5321adb --- /dev/null +++ b/doc/clapper-gtk/ctor.BulletinBoard.new.html @@ -0,0 +1,197 @@ + + + + + + ClapperGtk.BulletinBoard.new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Constructor

+

ClapperGtkBulletinBoardnew

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
GtkWidget*
+clapper_gtk_bulletin_board_new (
+  void
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Creates a new ClapperGtkBulletinBoard instance.

+
+ +
+ + + + +
+ + +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: GtkWidget

+

A new bulletin board GtkWidget.

+
+
+ + + + + + + +
The caller of the function takes ownership of the data, and is responsible for freeing it.
+
+
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/ctor.Container.new.html b/doc/clapper-gtk/ctor.Container.new.html new file mode 100644 index 00000000..3a31048a --- /dev/null +++ b/doc/clapper-gtk/ctor.Container.new.html @@ -0,0 +1,197 @@ + + + + + + ClapperGtk.Container.new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Constructor

+

ClapperGtkContainernew

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
GtkWidget*
+clapper_gtk_container_new (
+  void
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Creates a new ClapperGtkContainer instance.

+
+ +
+ + + + +
+ + +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: GtkWidget

+

A new container GtkWidget.

+
+
+ + + + + + + +
The caller of the function takes ownership of the data, and is responsible for freeing it.
+
+
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/ctor.EngageLayer.new.html b/doc/clapper-gtk/ctor.EngageLayer.new.html new file mode 100644 index 00000000..38486139 --- /dev/null +++ b/doc/clapper-gtk/ctor.EngageLayer.new.html @@ -0,0 +1,197 @@ + + + + + + ClapperGtk.EngageLayer.new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Constructor

+

ClapperGtkEngageLayernew

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
GtkWidget*
+clapper_gtk_engage_layer_new (
+  void
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Creates a new ClapperGtkEngageLayer instance.

+
+ +
+ + + + +
+ + +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: GtkWidget

+

A new playback engage layer GtkWidget.

+
+
+ + + + + + + +
The caller of the function takes ownership of the data, and is responsible for freeing it.
+
+
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/ctor.LeadContainer.new.html b/doc/clapper-gtk/ctor.LeadContainer.new.html new file mode 100644 index 00000000..061a4b4b --- /dev/null +++ b/doc/clapper-gtk/ctor.LeadContainer.new.html @@ -0,0 +1,197 @@ + + + + + + ClapperGtk.LeadContainer.new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Constructor

+

ClapperGtkLeadContainernew

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
GtkWidget*
+clapper_gtk_lead_container_new (
+  void
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Creates a new ClapperGtkLeadContainer instance.

+
+ +
+ + + + +
+ + +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: GtkWidget

+

A new lead container GtkWidget.

+
+
+ + + + + + + +
The caller of the function takes ownership of the data, and is responsible for freeing it.
+
+
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/ctor.NextItemButton.new.html b/doc/clapper-gtk/ctor.NextItemButton.new.html new file mode 100644 index 00000000..1636a4e7 --- /dev/null +++ b/doc/clapper-gtk/ctor.NextItemButton.new.html @@ -0,0 +1,197 @@ + + + + + + ClapperGtk.NextItemButton.new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Constructor

+

ClapperGtkNextItemButtonnew

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
GtkWidget*
+clapper_gtk_next_item_button_new (
+  void
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Creates a new GtkWidget with button to play next ClapperMediaItem.

+
+ +
+ + + + +
+ + +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: GtkWidget

+

A new GtkWidget instance.

+
+
+ + + + + + + +
The caller of the function takes ownership of the data, and is responsible for freeing it.
+
+
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/ctor.PreviousItemButton.new.html b/doc/clapper-gtk/ctor.PreviousItemButton.new.html new file mode 100644 index 00000000..a73cb0dd --- /dev/null +++ b/doc/clapper-gtk/ctor.PreviousItemButton.new.html @@ -0,0 +1,197 @@ + + + + + + ClapperGtk.PreviousItemButton.new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Constructor

+

ClapperGtkPreviousItemButtonnew

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
GtkWidget*
+clapper_gtk_previous_item_button_new (
+  void
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Creates a new GtkWidget with button to play previous ClapperMediaItem.

+
+ +
+ + + + +
+ + +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: GtkWidget

+

A new GtkWidget instance.

+
+
+ + + + + + + +
The caller of the function takes ownership of the data, and is responsible for freeing it.
+
+
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/ctor.ProgressBar.new.html b/doc/clapper-gtk/ctor.ProgressBar.new.html new file mode 100644 index 00000000..af4433cf --- /dev/null +++ b/doc/clapper-gtk/ctor.ProgressBar.new.html @@ -0,0 +1,197 @@ + + + + + + ClapperGtk.ProgressBar.new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Constructor

+

ClapperGtkProgressBarnew

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
GtkWidget*
+clapper_gtk_progress_bar_new (
+  void
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Creates a new GtkWidget with a progress bar.

+
+ +
+ + + + +
+ + +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: GtkWidget

+

A new GtkWidget instance.

+
+
+ + + + + + + +
The caller of the function takes ownership of the data, and is responsible for freeing it.
+
+
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/ctor.QueueSelection.new.html b/doc/clapper-gtk/ctor.QueueSelection.new.html new file mode 100644 index 00000000..e6e7760a --- /dev/null +++ b/doc/clapper-gtk/ctor.QueueSelection.new.html @@ -0,0 +1,229 @@ + + + + + + ClapperGtk.QueueSelection.new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Constructor

+

ClapperGtkQueueSelectionnew

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
ClapperGtkQueueSelection*
+clapper_gtk_queue_selection_new (
+  ClapperQueue* queue
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Creates a new ClapperGtkQueueSelection instance.

+
+ +
+ + + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
queue
+
+

Type: ClapperQueue

+

A ClapperQueue.

+ + + + + + + + + + +
The argument can be NULL.
The data is owned by the caller of the function.
+
+ + + +
+
+
+ + + +
+

+ Return value + +

+ +
+
+
+

Type: ClapperGtkQueueSelection

+

A new ClapperGtkQueueSelection.

+
+
+ + + + + + + +
The caller of the function takes ownership of the data, and is responsible for freeing it.
+
+
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/ctor.SimpleControls.new.html b/doc/clapper-gtk/ctor.SimpleControls.new.html new file mode 100644 index 00000000..7eb843d3 --- /dev/null +++ b/doc/clapper-gtk/ctor.SimpleControls.new.html @@ -0,0 +1,197 @@ + + + + + + ClapperGtk.SimpleControls.new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Constructor

+

ClapperGtkSimpleControlsnew

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
GtkWidget*
+clapper_gtk_simple_controls_new (
+  void
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Creates a new GtkWidget with simple playback controls.

+
+ +
+ + + + +
+ + +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: GtkWidget

+

A new GtkWidget instance.

+
+
+ + + + + + + +
The caller of the function takes ownership of the data, and is responsible for freeing it.
+
+
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/ctor.TitleHeader.new.html b/doc/clapper-gtk/ctor.TitleHeader.new.html new file mode 100644 index 00000000..dd92db5c --- /dev/null +++ b/doc/clapper-gtk/ctor.TitleHeader.new.html @@ -0,0 +1,197 @@ + + + + + + ClapperGtk.TitleHeader.new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Constructor

+

ClapperGtkTitleHeadernew

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
GtkWidget*
+clapper_gtk_title_header_new (
+  void
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Creates a new GtkWidget with title header.

+
+ +
+ + + + +
+ + +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: GtkWidget

+

A new GtkWidget instance.

+
+
+ + + + + + + +
The caller of the function takes ownership of the data, and is responsible for freeing it.
+
+
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/ctor.ToggleFullscreenButton.new.html b/doc/clapper-gtk/ctor.ToggleFullscreenButton.new.html new file mode 100644 index 00000000..a7f5eeba --- /dev/null +++ b/doc/clapper-gtk/ctor.ToggleFullscreenButton.new.html @@ -0,0 +1,197 @@ + + + + + + ClapperGtk.ToggleFullscreenButton.new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Constructor

+

ClapperGtkToggleFullscreenButtonnew

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
GtkWidget*
+clapper_gtk_toggle_fullscreen_button_new (
+  void
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Creates a new GtkWidget with button to toggle fullscreen state.

+
+ +
+ + + + +
+ + +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: GtkWidget

+

A new GtkWidget instance.

+
+
+ + + + + + + +
The caller of the function takes ownership of the data, and is responsible for freeing it.
+
+
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/ctor.TogglePlayButton.new.html b/doc/clapper-gtk/ctor.TogglePlayButton.new.html new file mode 100644 index 00000000..53aa5a64 --- /dev/null +++ b/doc/clapper-gtk/ctor.TogglePlayButton.new.html @@ -0,0 +1,197 @@ + + + + + + ClapperGtk.TogglePlayButton.new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Constructor

+

ClapperGtkTogglePlayButtonnew

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
GtkWidget*
+clapper_gtk_toggle_play_button_new (
+  void
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Creates a new GtkWidget with button to toggle playback.

+
+ +
+ + + + +
+ + +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: GtkWidget

+

A new GtkWidget instance.

+
+
+ + + + + + + +
The caller of the function takes ownership of the data, and is responsible for freeing it.
+
+
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/ctor.Video.new.html b/doc/clapper-gtk/ctor.Video.new.html new file mode 100644 index 00000000..ea8628c0 --- /dev/null +++ b/doc/clapper-gtk/ctor.Video.new.html @@ -0,0 +1,197 @@ + + + + + + ClapperGtk.Video.new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Constructor

+

ClapperGtkVideonew

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
GtkWidget*
+clapper_gtk_video_new (
+  void
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Creates a new ClapperGtkVideo instance.

+
+ +
+ + + + +
+ + +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: GtkWidget

+

A new video GtkWidget.

+
+
+ + + + + + + +
The caller of the function takes ownership of the data, and is responsible for freeing it.
+
+
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/ctor.WindowStateButtons.new.html b/doc/clapper-gtk/ctor.WindowStateButtons.new.html new file mode 100644 index 00000000..db1e92f6 --- /dev/null +++ b/doc/clapper-gtk/ctor.WindowStateButtons.new.html @@ -0,0 +1,197 @@ + + + + + + ClapperGtk.WindowStateButtons.new + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Constructor

+

ClapperGtkWindowStateButtonsnew

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
GtkWidget*
+clapper_gtk_window_state_buttons_new (
+  void
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Creates a new GtkWidget with window state control buttons.

+
+ +
+ + + + +
+ + +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: GtkWidget

+

A new GtkWidget instance.

+
+
+ + + + + + + +
The caller of the function takes ownership of the data, and is responsible for freeing it.
+
+
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/flags.VideoActionMask.html b/doc/clapper-gtk/flags.VideoActionMask.html new file mode 100644 index 00000000..38f95e9e --- /dev/null +++ b/doc/clapper-gtk/flags.VideoActionMask.html @@ -0,0 +1,235 @@ + + + + + + ClapperGtk.VideoActionMask + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Enumeration

+

ClapperGtkVideoActionMask

+
+ +
+
+

+
+ +
+

+ Declaration + + +

+ +
+ 
flags ClapperGtk.VideoActionMask
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + +
+ + +
+ +
+

+ Members + +

+ +
+
+ +
CLAPPER_GTK_VIDEO_ACTION_NONE
+
+

No action.

+
    +
  • Value: 0
    • +
  • Nickname: none
    • +
  • Available since: 0.0
    • +
+
+ +
CLAPPER_GTK_VIDEO_ACTION_TOGGLE_PLAY
+
+

Toggle playback.

+
    +
  • Value: 1
    • +
  • Nickname: toggle-play
    • +
  • Available since: 0.0
    • +
+
+ +
CLAPPER_GTK_VIDEO_ACTION_TOGGLE_FULLSCREEN
+
+

Toggle fullscreen.

+
    +
  • Value: 2
    • +
  • Nickname: toggle-fullscreen
    • +
  • Available since: 0.0
    • +
+
+ +
CLAPPER_GTK_VIDEO_ACTION_REVEAL_OVERLAYS
+
+

Reveal fading overlays.

+
    +
  • Value: 4
    • +
  • Nickname: reveal-overlays
    • +
  • Available since: 0.0
    • +
+
+ +
CLAPPER_GTK_VIDEO_ACTION_ANY
+
+

All of the above.

+
    +
  • Value: 67108863
    • +
  • Nickname: any
    • +
  • Available since: 0.0
    • +
+
+ +
+
+
+ + + + + +
+
+ + + +
+ +
+ + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/fonts.css b/doc/clapper-gtk/fonts.css new file mode 100644 index 00000000..98f2ea45 --- /dev/null +++ b/doc/clapper-gtk/fonts.css @@ -0,0 +1,150 @@ +/* + * SPDX-FileCopyrightText: 2021 GNOME Foundation + * + * SPDX-License-Identifier: Apache-2.0 OR GPL-3.0-or-later + */ + +/** + * RedHat Fonts taken from https://github.com/RedHatOfficial/RedHatFont + * License: SIL Open Font License 1.1 http://scripts.sil.org/OFL + * + * SourceCodePro Fonts + * License: SIL Open Font License 1.1 https://scripts.sil.org/OFL + */ + +@font-face { + font-family: "Red Hat Display"; + src: local('RedHatDisplay-Regular'); + font-style: normal; + font-weight: 400; + font-display: fallback; +} + +@font-face { + font-family: "Red Hat Display"; + src: local('RedHatDisplay-RegularItalic'); + font-style: italic; + font-weight: 400; + font-display: fallback; +} + +@font-face { + font-family: "Red Hat Display"; + src: local('RedHatDisplay-Medium'); + font-style: normal; + font-weight: 500; + font-display: fallback; +} + +@font-face { + font-family: "Red Hat Display"; + src: local('RedHatDisplay-MediumItalic'); + font-style: italic; + font-weight: 500; + font-display: fallback; +} + +@font-face { + font-family: "Red Hat Display"; + src: local('RedHatDisplay-Bold'); + font-style: normal; + font-weight: 700; + font-display: fallback; +} + +@font-face { + font-family: "Red Hat Display"; + src: local('RedHatDisplay-BoldItalic'); + font-style: italic; + font-weight: 700; + font-display: fallback; +} + + +@font-face { + font-family: "Red Hat Display"; + src: local('RedHatDisplay-Black'); + font-style: normal; + font-weight: 900; + font-display: fallback; +} + +@font-face { + font-family: "Red Hat Display"; + src: local('RedHatDisplay-BlackItalic'); + font-style: italic; + font-weight: 900; + font-display: fallback; +} + +@font-face { + font-family: "Red Hat Text"; + src: local('RedHatText-Regular'); + font-style: normal; + font-weight: 400; + font-display: fallback; +} + +@font-face { + font-family: "Red Hat Text"; + src: local('RedHatText-Italic'); + font-style: italic; + font-weight: 400; + font-display: fallback; +} + +@font-face { + font-family: "Red Hat Text"; + src: local('RedHatText-Medium'); + font-style: normal; + font-weight: 700; + font-display: fallback; +} + +@font-face { + font-family: "Red Hat Text"; + src: local('RedHatText-MediumItalic'); + font-style: italic; + font-weight: 700; + font-display: fallback; +} + +@font-face { + font-family: "Red Hat Text"; + src: local('RedHatText-Bold'); + font-style: normal; + font-weight: 900; + font-display: fallback; +} + +@font-face { + font-family: "Red Hat Text"; + src: local('RedHatText-BoldItalic'); + font-style: italic; + font-weight: 900; + font-display: fallback; +} + +@font-face { + font-family: 'Source Code Pro'; + font-style: normal; + font-weight: 400; + src: local('SourceCodePro-Regular'); + font-display: swap; +} + +@font-face { + font-family: 'Source Code Pro'; + font-style: italic; + font-weight: 400; + src: local('SourceCodePro-It'); + font-display: swap; +} + +@font-face { + font-family: 'Source Code Pro'; + font-style: normal; + font-weight: 600; + src: local('SourceCodePro-Semibold'); + font-display: swap; +} diff --git a/doc/clapper-gtk/func.BILLBOARD_CAST.html b/doc/clapper-gtk/func.BILLBOARD_CAST.html new file mode 100644 index 00000000..e6796c9b --- /dev/null +++ b/doc/clapper-gtk/func.BILLBOARD_CAST.html @@ -0,0 +1,196 @@ + + + + + + ClapperGtk.BILLBOARD_CAST + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Function Macro

+

ClapperGtkBILLBOARD_CAST

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
#define CLAPPER_GTK_BILLBOARD_CAST (
+  obj
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + +

This function is not directly available to language bindings.

+ + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
obj
+
+

Type: -

+

No description available.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/func.BULLETIN_BOARD_CAST.html b/doc/clapper-gtk/func.BULLETIN_BOARD_CAST.html new file mode 100644 index 00000000..d5724a5c --- /dev/null +++ b/doc/clapper-gtk/func.BULLETIN_BOARD_CAST.html @@ -0,0 +1,196 @@ + + + + + + ClapperGtk.BULLETIN_BOARD_CAST + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Function Macro

+

ClapperGtkBULLETIN_BOARD_CAST

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
#define CLAPPER_GTK_BULLETIN_BOARD_CAST (
+  obj
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + +

This function is not directly available to language bindings.

+ + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
obj
+
+

Type: -

+

No description available.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/func.CHECK_VERSION.html b/doc/clapper-gtk/func.CHECK_VERSION.html new file mode 100644 index 00000000..127e9005 --- /dev/null +++ b/doc/clapper-gtk/func.CHECK_VERSION.html @@ -0,0 +1,232 @@ + + + + + + ClapperGtk.CHECK_VERSION + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Function Macro

+

ClapperGtkCHECK_VERSION

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
#define CLAPPER_GTK_CHECK_VERSION (
+  major,
+  minor,
+  micro
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + +

This function is not directly available to language bindings.

+ + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
major
+
+

Type: -

+

No description available.

+ + + + + + + + + + +
+
+ +
minor
+
+

Type: -

+

No description available.

+ + + + + + + + + + +
+
+ +
micro
+
+

Type: -

+

No description available.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/func.CONTAINER_CAST.html b/doc/clapper-gtk/func.CONTAINER_CAST.html new file mode 100644 index 00000000..75e777de --- /dev/null +++ b/doc/clapper-gtk/func.CONTAINER_CAST.html @@ -0,0 +1,196 @@ + + + + + + ClapperGtk.CONTAINER_CAST + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Function Macro

+

ClapperGtkCONTAINER_CAST

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
#define CLAPPER_GTK_CONTAINER_CAST (
+  obj
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + +

This function is not directly available to language bindings.

+ + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
obj
+
+

Type: -

+

No description available.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/func.ENCODE_VERSION.html b/doc/clapper-gtk/func.ENCODE_VERSION.html new file mode 100644 index 00000000..8b57a03f --- /dev/null +++ b/doc/clapper-gtk/func.ENCODE_VERSION.html @@ -0,0 +1,232 @@ + + + + + + ClapperGtk.ENCODE_VERSION + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Function Macro

+

ClapperGtkENCODE_VERSION

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
#define CLAPPER_GTK_ENCODE_VERSION (
+  major,
+  minor,
+  micro
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + +

This function is not directly available to language bindings.

+ + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
major
+
+

Type: -

+

No description available.

+ + + + + + + + + + +
+
+ +
minor
+
+

Type: -

+

No description available.

+ + + + + + + + + + +
+
+ +
micro
+
+

Type: -

+

No description available.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/func.ENGAGE_LAYER_CAST.html b/doc/clapper-gtk/func.ENGAGE_LAYER_CAST.html new file mode 100644 index 00000000..1f48652d --- /dev/null +++ b/doc/clapper-gtk/func.ENGAGE_LAYER_CAST.html @@ -0,0 +1,196 @@ + + + + + + ClapperGtk.ENGAGE_LAYER_CAST + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Function Macro

+

ClapperGtkENGAGE_LAYER_CAST

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
#define CLAPPER_GTK_ENGAGE_LAYER_CAST (
+  obj
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + +

This function is not directly available to language bindings.

+ + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
obj
+
+

Type: -

+

No description available.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/func.LEAD_CONTAINER_CAST.html b/doc/clapper-gtk/func.LEAD_CONTAINER_CAST.html new file mode 100644 index 00000000..91e33f8f --- /dev/null +++ b/doc/clapper-gtk/func.LEAD_CONTAINER_CAST.html @@ -0,0 +1,196 @@ + + + + + + ClapperGtk.LEAD_CONTAINER_CAST + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Function Macro

+

ClapperGtkLEAD_CONTAINER_CAST

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
#define CLAPPER_GTK_LEAD_CONTAINER_CAST (
+  obj
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + +

This function is not directly available to language bindings.

+ + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
obj
+
+

Type: -

+

No description available.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/func.NEXT_ITEM_BUTTON_CAST.html b/doc/clapper-gtk/func.NEXT_ITEM_BUTTON_CAST.html new file mode 100644 index 00000000..1f3ebaa6 --- /dev/null +++ b/doc/clapper-gtk/func.NEXT_ITEM_BUTTON_CAST.html @@ -0,0 +1,196 @@ + + + + + + ClapperGtk.NEXT_ITEM_BUTTON_CAST + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Function Macro

+

ClapperGtkNEXT_ITEM_BUTTON_CAST

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
#define CLAPPER_GTK_NEXT_ITEM_BUTTON_CAST (
+  obj
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + +

This function is not directly available to language bindings.

+ + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
obj
+
+

Type: -

+

No description available.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/func.PREVIOUS_ITEM_BUTTON_CAST.html b/doc/clapper-gtk/func.PREVIOUS_ITEM_BUTTON_CAST.html new file mode 100644 index 00000000..3b9a54a8 --- /dev/null +++ b/doc/clapper-gtk/func.PREVIOUS_ITEM_BUTTON_CAST.html @@ -0,0 +1,196 @@ + + + + + + ClapperGtk.PREVIOUS_ITEM_BUTTON_CAST + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Function Macro

+

ClapperGtkPREVIOUS_ITEM_BUTTON_CAST

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
#define CLAPPER_GTK_PREVIOUS_ITEM_BUTTON_CAST (
+  obj
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + +

This function is not directly available to language bindings.

+ + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
obj
+
+

Type: -

+

No description available.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/func.PROGRESS_BAR_CAST.html b/doc/clapper-gtk/func.PROGRESS_BAR_CAST.html new file mode 100644 index 00000000..50214bc0 --- /dev/null +++ b/doc/clapper-gtk/func.PROGRESS_BAR_CAST.html @@ -0,0 +1,196 @@ + + + + + + ClapperGtk.PROGRESS_BAR_CAST + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Function Macro

+

ClapperGtkPROGRESS_BAR_CAST

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
#define CLAPPER_GTK_PROGRESS_BAR_CAST (
+  obj
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + +

This function is not directly available to language bindings.

+ + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
obj
+
+

Type: -

+

No description available.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/func.QUEUE_SELECTION_CAST.html b/doc/clapper-gtk/func.QUEUE_SELECTION_CAST.html new file mode 100644 index 00000000..3af83880 --- /dev/null +++ b/doc/clapper-gtk/func.QUEUE_SELECTION_CAST.html @@ -0,0 +1,196 @@ + + + + + + ClapperGtk.QUEUE_SELECTION_CAST + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Function Macro

+

ClapperGtkQUEUE_SELECTION_CAST

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
#define CLAPPER_GTK_QUEUE_SELECTION_CAST (
+  obj
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + +

This function is not directly available to language bindings.

+ + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
obj
+
+

Type: -

+

No description available.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/func.SIMPLE_CONTROLS_CAST.html b/doc/clapper-gtk/func.SIMPLE_CONTROLS_CAST.html new file mode 100644 index 00000000..b75ae708 --- /dev/null +++ b/doc/clapper-gtk/func.SIMPLE_CONTROLS_CAST.html @@ -0,0 +1,196 @@ + + + + + + ClapperGtk.SIMPLE_CONTROLS_CAST + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Function Macro

+

ClapperGtkSIMPLE_CONTROLS_CAST

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
#define CLAPPER_GTK_SIMPLE_CONTROLS_CAST (
+  obj
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + +

This function is not directly available to language bindings.

+ + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
obj
+
+

Type: -

+

No description available.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/func.SKIP_ITEM_BUTTON_CAST.html b/doc/clapper-gtk/func.SKIP_ITEM_BUTTON_CAST.html new file mode 100644 index 00000000..933d332c --- /dev/null +++ b/doc/clapper-gtk/func.SKIP_ITEM_BUTTON_CAST.html @@ -0,0 +1,196 @@ + + + + + + ClapperGtk.SKIP_ITEM_BUTTON_CAST + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Function Macro

+

ClapperGtkSKIP_ITEM_BUTTON_CAST

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
#define CLAPPER_GTK_SKIP_ITEM_BUTTON_CAST (
+  obj
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + +

This function is not directly available to language bindings.

+ + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
obj
+
+

Type: -

+

No description available.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/func.TITLE_HEADER_CAST.html b/doc/clapper-gtk/func.TITLE_HEADER_CAST.html new file mode 100644 index 00000000..fb4f5c06 --- /dev/null +++ b/doc/clapper-gtk/func.TITLE_HEADER_CAST.html @@ -0,0 +1,196 @@ + + + + + + ClapperGtk.TITLE_HEADER_CAST + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Function Macro

+

ClapperGtkTITLE_HEADER_CAST

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
#define CLAPPER_GTK_TITLE_HEADER_CAST (
+  obj
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + +

This function is not directly available to language bindings.

+ + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
obj
+
+

Type: -

+

No description available.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/func.TOGGLE_FULLSCREEN_BUTTON_CAST.html b/doc/clapper-gtk/func.TOGGLE_FULLSCREEN_BUTTON_CAST.html new file mode 100644 index 00000000..cb3d1b35 --- /dev/null +++ b/doc/clapper-gtk/func.TOGGLE_FULLSCREEN_BUTTON_CAST.html @@ -0,0 +1,196 @@ + + + + + + ClapperGtk.TOGGLE_FULLSCREEN_BUTTON_CAST + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Function Macro

+

ClapperGtkTOGGLE_FULLSCREEN_BUTTON_CAST

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
#define CLAPPER_GTK_TOGGLE_FULLSCREEN_BUTTON_CAST (
+  obj
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + +

This function is not directly available to language bindings.

+ + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
obj
+
+

Type: -

+

No description available.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/func.TOGGLE_PLAY_BUTTON_CAST.html b/doc/clapper-gtk/func.TOGGLE_PLAY_BUTTON_CAST.html new file mode 100644 index 00000000..19b4c35b --- /dev/null +++ b/doc/clapper-gtk/func.TOGGLE_PLAY_BUTTON_CAST.html @@ -0,0 +1,196 @@ + + + + + + ClapperGtk.TOGGLE_PLAY_BUTTON_CAST + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Function Macro

+

ClapperGtkTOGGLE_PLAY_BUTTON_CAST

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
#define CLAPPER_GTK_TOGGLE_PLAY_BUTTON_CAST (
+  obj
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + +

This function is not directly available to language bindings.

+ + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
obj
+
+

Type: -

+

No description available.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/func.VIDEO_CAST.html b/doc/clapper-gtk/func.VIDEO_CAST.html new file mode 100644 index 00000000..d07038ba --- /dev/null +++ b/doc/clapper-gtk/func.VIDEO_CAST.html @@ -0,0 +1,196 @@ + + + + + + ClapperGtk.VIDEO_CAST + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Function Macro

+

ClapperGtkVIDEO_CAST

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
#define CLAPPER_GTK_VIDEO_CAST (
+  obj
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + +

This function is not directly available to language bindings.

+ + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
obj
+
+

Type: -

+

No description available.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/func.WINDOW_STATE_BUTTONS_CAST.html b/doc/clapper-gtk/func.WINDOW_STATE_BUTTONS_CAST.html new file mode 100644 index 00000000..78db768f --- /dev/null +++ b/doc/clapper-gtk/func.WINDOW_STATE_BUTTONS_CAST.html @@ -0,0 +1,196 @@ + + + + + + ClapperGtk.WINDOW_STATE_BUTTONS_CAST + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Function Macro

+

ClapperGtkWINDOW_STATE_BUTTONS_CAST

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
#define CLAPPER_GTK_WINDOW_STATE_BUTTONS_CAST (
+  obj
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + +

This function is not directly available to language bindings.

+ + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
obj
+
+

Type: -

+

No description available.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/func.get_player_from_ancestor.html b/doc/clapper-gtk/func.get_player_from_ancestor.html new file mode 100644 index 00000000..7f32c203 --- /dev/null +++ b/doc/clapper-gtk/func.get_player_from_ancestor.html @@ -0,0 +1,233 @@ + + + + + + ClapperGtk.get_player_from_ancestor + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Function

+

ClapperGtkget_player_from_ancestor

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
ClapperPlayer*
+clapper_gtk_get_player_from_ancestor (
+  GtkWidget* widget
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get ClapperPlayer used by ClapperGtkVideoPlayer ancestor of widget.

+

This utility is a convenience wrapper for calling gtk_widget_get_ancestor() +of type CLAPPER_GTK_TYPE_VIDEO and clapper_gtk_video_get_player() with +additional NULL checking and type casting.

+

This is meant to be used mainly for custom widget development as an easy access to the +underlying parent ClapperPlayer object. If you want to get the player from +ClapperGtkVideo widget itself, use clapper_gtk_video_get_player() instead.

+

Rememeber that this function will return NULL when widget does not have +a ClapperGtkVideo ancestor in widget hierarchy (widget is not yet placed).

+
+ +
+ + + + + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
widget
+
+

Type: GtkWidget

+

A GtkWidget.

+ + + + + + + + + + +
The data is owned by the caller of the function.
+
+ + + +
+
+
+ + + +
+

+ Return value + +

+ +
+
+
+

Type: ClapperPlayer

+

A ClapperPlayer from ancestor of a widget.

+
+
+ + + + + + + +
The data is owned by the called function.
The return value can be NULL.
+
+
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/func.get_resource.html b/doc/clapper-gtk/func.get_resource.html new file mode 100644 index 00000000..314a4115 --- /dev/null +++ b/doc/clapper-gtk/func.get_resource.html @@ -0,0 +1,191 @@ + + + + + + ClapperGtk.get_resource + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Function

+

ClapperGtkget_resource

+
+ +
+
+

+
+
+

+ Declaration + + + [src] + +

+ +
+ 
GResource*
+clapper_gtk_get_resource (
+  void
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + + + + +
+ + +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: GResource

+

No description available. +

+
+ + + + + + + +
The caller of the function takes ownership of the data, and is responsible for freeing it.
+
+
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/fzy.js b/doc/clapper-gtk/fzy.js new file mode 100644 index 00000000..89e4666d --- /dev/null +++ b/doc/clapper-gtk/fzy.js @@ -0,0 +1,222 @@ +// SPDX-FileCopyrightText: 2014 John Hawthorn +// +// SPDX-License-Identifier: MIT + +window.fzy = (function() { + var SCORE_MIN = -Infinity; + var SCORE_MAX = Infinity; + + var SCORE_GAP_LEADING = -0.005 + var SCORE_GAP_TRAILING = -0.005 + var SCORE_GAP_INNER = -0.01 + var SCORE_MATCH_CONSECUTIVE = 1.0 + var SCORE_MATCH_SLASH = 0.9 + var SCORE_MATCH_WORD = 0.8 + var SCORE_MATCH_CAPITAL = 0.7 + var SCORE_MATCH_DOT = 0.6 + + function islower(s) { + return s.toLowerCase() === s; + } + + function isupper(s) { + return s.toUpperCase() === s; + } + + function precompute_bonus(haystack) { + /* Which positions are beginning of words */ + var m = haystack.length; + var match_bonus = new Array(m); + + var last_ch = '/'; + for (var i = 0; i < m; i++) { + var ch = haystack[i]; + + if (last_ch === '/') { + match_bonus[i] = SCORE_MATCH_SLASH; + } else if (last_ch === '-' || last_ch === '_' || last_ch === ' ') { + match_bonus[i] = SCORE_MATCH_WORD; + } else if (last_ch === '.') { + match_bonus[i] = SCORE_MATCH_DOT; + } else if (islower(last_ch) && isupper(ch)) { + match_bonus[i] = SCORE_MATCH_CAPITAL; + } else { + match_bonus[i] = 0; + } + + last_ch = ch; + } + + return match_bonus; + } + + function compute(needle, haystack, D, M) { + var n = needle.length; + var m = haystack.length; + + var match_bonus = precompute_bonus(haystack, match_bonus); + + /* + * D[][] Stores the best score for this position ending with a match. + * M[][] Stores the best possible score at this position. + */ + + for (var i = 0; i < n; i++) { + D[i] = new Array(m); + M[i] = new Array(m); + + var prev_score = SCORE_MIN; + var gap_score = i === n - 1 ? SCORE_GAP_TRAILING : SCORE_GAP_INNER; + + for (var j = 0; j < m; j++) { + if (needle[i] === haystack[j]) { + var score = SCORE_MIN; + if (!i) { + score = (j * SCORE_GAP_LEADING) + match_bonus[j]; + } else if (j) { /* i > 0 && j > 0*/ + score = Math.max( + M[i - 1][j - 1] + match_bonus[j], + + /* consecutive match, doesn't stack with match_bonus */ + D[i - 1][j - 1] + SCORE_MATCH_CONSECUTIVE); + } + D[i][j] = score; + M[i][j] = prev_score = Math.max(score, prev_score + gap_score); + } else { + D[i][j] = SCORE_MIN; + M[i][j] = prev_score = prev_score + gap_score; + } + } + } + } + + function score(needle, haystack) { + var n = needle.length; + var m = haystack.length; + + if (!n || !m) + return SCORE_MIN; + + if (n === m) { + /* Since this method can only be called with a haystack which + * matches needle. If the lengths of the strings are equal the + * strings themselves must also be equal (ignoring case). + */ + return SCORE_MAX; + } + + if (m > 1024) { + /* + * Unreasonably large candidate: return no score + * If it is a valid match it will still be returned, it will + * just be ranked below any reasonably sized candidates + */ + return SCORE_MIN; + } + + var D = new Array(n); + var M = new Array(n); + + compute(needle, haystack, D, M) + + return M[n - 1][m - 1]; + } + + function positions(needle, haystack) { + var n = needle.length; + var m = haystack.length; + + var positions = new Array(n); + + if (!n || !m) + return positions; + + if (n === m) { + for (var i = 0; i < n; i++) + positions[i] = i; + return positions; + } + + if (m > 1024) { + return positions; + } + + var D = new Array(n); + var M = new Array(n); + + compute(needle, haystack, D, M) + + /* backtrack to find the positions of optimal matching */ + var match_required = false; + + for (var i = n - 1, j = m - 1; i >= 0; i--) { + for (; j >= 0; j--) { + /* + * There may be multiple paths which result in + * the optimal weight. + * + * For simplicity, we will pick the first one + * we encounter, the latest in the candidate + * string. + */ + if (D[i][j] !== SCORE_MIN && + (match_required || D[i][j] === M[i][j])) { + /* If this score was determined using + * SCORE_MATCH_CONSECUTIVE, the + * previous character MUST be a match + */ + match_required = + i && j && + M[i][j] === D[i - 1][j - 1] + SCORE_MATCH_CONSECUTIVE; + positions[i] = j--; + break; + } + } + } + + return positions; + } + + function hasMatch(needle, haystack) { + var l = needle.length + for (var i = 0, j = 0; i < l; i += 1) { + j = haystack.indexOf(needle[i], j) + 1 + if (j === 0) return false + } + return true + } + + function filter(needle, items, selector) { + const isCaseSensitive = needle.toLowerCase() !== needle; + const actualNeedle = isCaseSensitive ? needle : needle.toLowerCase(); + const filteredItems = items.reduce((results, item) => { + const haystack = isCaseSensitive ? selector(item) : selector(item).toLowerCase(); + if (hasMatch(actualNeedle, haystack)) + results.push({ item, score: score(needle, haystack) }) + return results; + }, []) + filteredItems.sort((a, b) => b.score - a.score) + return filteredItems; + } + + return { + /* constants */ + SCORE_MIN, + SCORE_MAX, + + SCORE_GAP_LEADING, + SCORE_GAP_TRAILING, + SCORE_GAP_INNER, + SCORE_MATCH_CONSECUTIVE, + SCORE_MATCH_SLASH, + SCORE_MATCH_WORD, + SCORE_MATCH_CAPITAL, + SCORE_MATCH_DOT, + + /* functions */ + score, + positions, + hasMatch, + filter, + } +})(); diff --git a/doc/clapper-gtk/go-up-symbolic.png b/doc/clapper-gtk/go-up-symbolic.png new file mode 100644 index 0000000000000000000000000000000000000000..a827b9ad259b24687a91aa7b4a7a403239fad247 GIT binary patch literal 471 zcmV;|0Vw{7P)> z000>>0k0ONkpKVy8FWQhbW?9;ba!ELWdL_~cP?peYja~^aAhuUa%Y?FJQ@H10c1%; zK~zYI?UBDq!(bG}&%Ly%Akwi|HwR070>wdUNMmW}YxoNGIXd|op%R)vtb=(4QAerH zS_;zPyDp7}O79nr5w3Duna}lw(VU2_W-J214MU*VRT&AohFxK z^?JRX`F!q)$cbjZ0cb8NUrt6ueH{cKN&^9a>$+2=l$}UeC8A4xE?MJI{1A~zrBXRh z1I6-ve + + + + + ClapperGtk – 0.0 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Namespace

+

ClapperGtk – 0.0

+ +
+

Clapper GTK integration library

+
+ +
+ + + + + + +
Version0.5.2
AuthorsRafał Dzięgiel
LicenseLGPL-2.1-or-later
Websitehttps://rafostar.github.io/clapper/
Sourcehttps://github.com/Rafostar/clapper/
+
+ + +
+

Build

+ +
+ + + + + + + +
C headersclapper-gtk/clapper-gtk.h
pkg-config filesclapper-gtk-0.0
+
+
+ +
+ + +
+
+

+ Dependencies + +

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Clapper—0.0Clapper playback library
Browse documentation
Gtk—4.0The GTK toolkit
Browse documentation
+
+
+
+ + + +
+
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
GLibA general-purpose, portable utility library
Browse documentation
GObjectThe base type system library
Browse documentation
GstGStreamer core library
Browse documentation
+
+
+
+ + + +
+
+

+ Additional documentation + +

+ +
+ +
+
+
+ + + + + +
+
+

+ Classes + +

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Billboard +

A layer where various messages can be displayed.

+

+
Container +

A simple container widget that holds just one child.

+

+
EngageLayer +

A layer with big play button, engaging user to start the playback.

+

+
LeadContainer +

A ClapperGtkContainer that can take priority in user interactions with the ClapperGtkVideo.

+

+
NextItemButton +

A GtkButton for selecting next queue item.

+

+
PreviousItemButton +

A GtkButton for selecting previous queue item.

+

+
ProgressBar +

A progress bar for displaying playback position and seeking.

+

+
QueueSelection +

A GtkSelectionModel that considers current item of ClapperQueue as selected one.

+

+
SimpleControls +

A minimalistic playback controls panel widget.

+

+
SkipItemButton +

A base class for creating buttons that skip to previous/next queue item.

+

+
TitleHeader +

A header panel widget that displays current media title.

+

+
ToggleFullscreenButton +

A GtkButton for toggling fullscreen state.

+

+
TogglePlayButton +

A GtkButton for toggling play/pause of playback.

+

+
Video +

A ready to be used GTK video widget implementing Clapper API.

+

+
+
+
+
+ + + + + + + +
+
+

+ Bitfields + +

+ +
+ + + + + + + + + + + +
VideoActionMask + +

+
+
+
+
+ + + + +
+
+

+ Functions + +

+ +
+ + + + + + + + + + + + + + + + + + +
get_player_from_ancestor +

Get ClapperPlayer used by ClapperGtkVideoPlayer ancestor of widget.

+

+
get_resource + +

+
+
+
+
+ + +
+
+

+ Function Macros + +

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BILLBOARD_CAST + +

+
CHECK_VERSION + +

+
CONTAINER_CAST + +

+
ENCODE_VERSION + +

+
ENGAGE_LAYER_CAST + +

+
LEAD_CONTAINER_CAST + +

+
NEXT_ITEM_BUTTON_CAST + +

+
PREVIOUS_ITEM_BUTTON_CAST + +

+
PROGRESS_BAR_CAST + +

+
QUEUE_SELECTION_CAST + +

+
SIMPLE_CONTROLS_CAST + +

+
SKIP_ITEM_BUTTON_CAST + +

+
TITLE_HEADER_CAST + +

+
TOGGLE_FULLSCREEN_BUTTON_CAST + +

+
TOGGLE_PLAY_BUTTON_CAST + +

+
VIDEO_CAST + +

+
+
+
+
+ + +
+
+

+ Constants + +

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MAJOR_VERSION +

ClapperGtk major version component.

+

+
MICRO_VERSION +

ClapperGtk micro version component.

+

+
MINOR_VERSION +

ClapperGtk minor version component.

+

+
VERSION_S +

ClapperGtk version, encoded as a string.

+

+
+
+
+
+ +
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/index.json b/doc/clapper-gtk/index.json new file mode 100644 index 00000000..88ffb34b --- /dev/null +++ b/doc/clapper-gtk/index.json @@ -0,0 +1 @@ +{"meta":{"ns":"ClapperGtk","version":"0.0","generator":"gi-docgen","generator-version":"2023.3"},"symbols":[{"type":"bitfield","name":"VideoActionMask","ctype":"ClapperGtkVideoActionMask","summary":"No description available.","deprecated":null},{"type":"class","name":"Billboard","ctype":"ClapperGtkBillboard","summary":"A layer where various messages can be displayed. #ClapperGtkBillboard widget is meant to be overlaid on top of ...","deprecated":null},{"type":"class","name":"Container","ctype":"ClapperGtkContainer","summary":"A simple container widget that holds just one child. It is designed to work well with OSD overlay, ...","deprecated":null},{"type":"class","name":"EngageLayer","ctype":"ClapperGtkEngageLayer","summary":"A layer with big `play` button, engaging user to start the playback. #ClapperGtkEngageLayer widget is meant to be ...","deprecated":null},{"type":"class","name":"LeadContainer","ctype":"ClapperGtkLeadContainer","summary":"A #ClapperGtkContainer that can take priority in user interactions with the #ClapperGtkVideo. #ClapperGtkLeadContainer is a special type of ...","deprecated":null},{"type":"class","name":"NextItemButton","ctype":"ClapperGtkNextItemButton","summary":"A #GtkButton for selecting next queue item.","deprecated":null},{"type":"class","name":"PreviousItemButton","ctype":"ClapperGtkPreviousItemButton","summary":"A #GtkButton for selecting previous queue item.","deprecated":null},{"type":"class","name":"ProgressBar","ctype":"ClapperGtkProgressBar","summary":"A progress bar for displaying playback position and seeking.","deprecated":null},{"type":"class","name":"QueueSelection","ctype":"ClapperGtkQueueSelection","summary":"A #GtkSelectionModel that considers current item of #ClapperQueue as selected one.","deprecated":null},{"type":"class","name":"SimpleControls","ctype":"ClapperGtkSimpleControls","summary":"A minimalistic playback controls panel widget. #ClapperGtkSimpleControls is a simple, ready to be used playback controls widget. It ...","deprecated":null},{"type":"class","name":"SkipItemButton","ctype":"ClapperGtkSkipItemButton","summary":"A base class for creating buttons that skip to previous/next queue item. Unless you are in need to ...","deprecated":null},{"type":"class","name":"TitleHeader","ctype":"ClapperGtkTitleHeader","summary":"A header panel widget that displays current media title. #ClapperGtkTitleHeader is a simple, ready to be used header ...","deprecated":null},{"type":"class","name":"ToggleFullscreenButton","ctype":"ClapperGtkToggleFullscreenButton","summary":"A #GtkButton for toggling fullscreen state.","deprecated":null},{"type":"class","name":"TogglePlayButton","ctype":"ClapperGtkTogglePlayButton","summary":"A #GtkButton for toggling play/pause of playback.","deprecated":null},{"type":"class","name":"Video","ctype":"ClapperGtkVideo","summary":"A ready to be used GTK video widget implementing Clapper API. #ClapperGtkVideo is the main widget exposed by ...","deprecated":null},{"type":"constant","name":"MAJOR_VERSION","ident":"CLAPPER_GTK_MAJOR_VERSION","summary":"ClapperGtk major version component","deprecated":null},{"type":"constant","name":"MICRO_VERSION","ident":"CLAPPER_GTK_MICRO_VERSION","summary":"ClapperGtk micro version component","deprecated":null},{"type":"constant","name":"MINOR_VERSION","ident":"CLAPPER_GTK_MINOR_VERSION","summary":"ClapperGtk minor version component","deprecated":null},{"type":"constant","name":"VERSION_S","ident":"CLAPPER_GTK_VERSION_S","summary":"ClapperGtk version, encoded as a string","deprecated":null},{"type":"ctor","name":"new","type_name":"Billboard","ident":"clapper_gtk_billboard_new","summary":"Creates a new #ClapperGtkBillboard instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"Container","ident":"clapper_gtk_container_new","summary":"Creates a new #ClapperGtkContainer instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"EngageLayer","ident":"clapper_gtk_engage_layer_new","summary":"Creates a new #ClapperGtkEngageLayer instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"LeadContainer","ident":"clapper_gtk_lead_container_new","summary":"Creates a new #ClapperGtkLeadContainer instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"NextItemButton","ident":"clapper_gtk_next_item_button_new","summary":"Creates a new #GtkWidget with button to play next #ClapperMediaItem.","deprecated":null},{"type":"ctor","name":"new","type_name":"PreviousItemButton","ident":"clapper_gtk_previous_item_button_new","summary":"Creates a new #GtkWidget with button to play previous #ClapperMediaItem.","deprecated":null},{"type":"ctor","name":"new","type_name":"ProgressBar","ident":"clapper_gtk_progress_bar_new","summary":"Creates a new #GtkWidget with a progress bar.","deprecated":null},{"type":"ctor","name":"new","type_name":"QueueSelection","ident":"clapper_gtk_queue_selection_new","summary":"Creates a new #ClapperGtkQueueSelection instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"SimpleControls","ident":"clapper_gtk_simple_controls_new","summary":"Creates a new #GtkWidget with simple playback controls.","deprecated":null},{"type":"ctor","name":"new","type_name":"TitleHeader","ident":"clapper_gtk_title_header_new","summary":"Creates a new #GtkWidget with title header.","deprecated":null},{"type":"ctor","name":"new","type_name":"ToggleFullscreenButton","ident":"clapper_gtk_toggle_fullscreen_button_new","summary":"Creates a new #GtkWidget with button to toggle fullscreen state.","deprecated":null},{"type":"ctor","name":"new","type_name":"TogglePlayButton","ident":"clapper_gtk_toggle_play_button_new","summary":"Creates a new #GtkWidget with button to toggle playback.","deprecated":null},{"type":"ctor","name":"new","type_name":"Video","ident":"clapper_gtk_video_new","summary":"Creates a new #ClapperGtkVideo instance.","deprecated":null},{"type":"function","name":"get_player_from_ancestor","ident":"clapper_gtk_get_player_from_ancestor","summary":"Get #ClapperPlayer used by #ClapperGtkVideoPlayer ancestor of @widget. This utility is a convenience wrapper for calling [method@Gtk.Widget.get_ancestor] of ...","deprecated":null},{"type":"function","name":"get_resource","ident":"clapper_gtk_get_resource","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"BILLBOARD_CAST","ident":"CLAPPER_GTK_BILLBOARD_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"CHECK_VERSION","ident":"CLAPPER_GTK_CHECK_VERSION","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"CONTAINER_CAST","ident":"CLAPPER_GTK_CONTAINER_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"ENCODE_VERSION","ident":"CLAPPER_GTK_ENCODE_VERSION","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"ENGAGE_LAYER_CAST","ident":"CLAPPER_GTK_ENGAGE_LAYER_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"LEAD_CONTAINER_CAST","ident":"CLAPPER_GTK_LEAD_CONTAINER_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"NEXT_ITEM_BUTTON_CAST","ident":"CLAPPER_GTK_NEXT_ITEM_BUTTON_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"PREVIOUS_ITEM_BUTTON_CAST","ident":"CLAPPER_GTK_PREVIOUS_ITEM_BUTTON_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"PROGRESS_BAR_CAST","ident":"CLAPPER_GTK_PROGRESS_BAR_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"QUEUE_SELECTION_CAST","ident":"CLAPPER_GTK_QUEUE_SELECTION_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"SIMPLE_CONTROLS_CAST","ident":"CLAPPER_GTK_SIMPLE_CONTROLS_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"SKIP_ITEM_BUTTON_CAST","ident":"CLAPPER_GTK_SKIP_ITEM_BUTTON_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"TITLE_HEADER_CAST","ident":"CLAPPER_GTK_TITLE_HEADER_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"TOGGLE_FULLSCREEN_BUTTON_CAST","ident":"CLAPPER_GTK_TOGGLE_FULLSCREEN_BUTTON_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"TOGGLE_PLAY_BUTTON_CAST","ident":"CLAPPER_GTK_TOGGLE_PLAY_BUTTON_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"VIDEO_CAST","ident":"CLAPPER_GTK_VIDEO_CAST","summary":"No description available.","deprecated":null},{"type":"method","name":"add_fading_overlay","type_name":"Video","ident":"clapper_gtk_video_add_fading_overlay","summary":"Similiar as clapper_gtk_video_add_overlay() but will also automatically add fading functionality to overlaid #GtkWidget for convenience. This will make widget ...","deprecated":null},{"type":"method","name":"add_overlay","type_name":"Video","ident":"clapper_gtk_video_add_overlay","summary":"Add another #GtkWidget to be overlaid on top of video. The position at which @widget is placed is ...","deprecated":null},{"type":"method","name":"announce_speed","type_name":"Billboard","ident":"clapper_gtk_billboard_announce_speed","summary":"No description available.","deprecated":null},{"type":"method","name":"announce_volume","type_name":"Billboard","ident":"clapper_gtk_billboard_announce_volume","summary":"No description available.","deprecated":null},{"type":"method","name":"get_adaptive_height","type_name":"Container","ident":"clapper_gtk_container_get_adaptive_height","summary":"Get a @container adaptive height threshold.","deprecated":null},{"type":"method","name":"get_adaptive_width","type_name":"Container","ident":"clapper_gtk_container_get_adaptive_width","summary":"Get a @container adaptive width threshold.","deprecated":null},{"type":"method","name":"get_auto_inhibit","type_name":"Video","ident":"clapper_gtk_video_get_auto_inhibit","summary":"Get whether automatic session inhibit is enabled.","deprecated":null},{"type":"method","name":"get_blocked_actions","type_name":"LeadContainer","ident":"clapper_gtk_lead_container_get_blocked_actions","summary":"Get @actions that were set for this @lead_container to block.","deprecated":null},{"type":"method","name":"get_child","type_name":"Container","ident":"clapper_gtk_container_get_child","summary":"Get a child #GtkWidget of @container.","deprecated":null},{"type":"method","name":"get_fade_delay","type_name":"Video","ident":"clapper_gtk_video_get_fade_delay","summary":"Get time in milliseconds after which fading overlays should fade.","deprecated":null},{"type":"method","name":"get_fullscreenable","type_name":"SimpleControls","ident":"clapper_gtk_simple_controls_get_fullscreenable","summary":"Get whether [class@ClapperGtk.ToggleFullscreenButton] button in the @controls is set to be visible.","deprecated":null},{"type":"method","name":"get_height_target","type_name":"Container","ident":"clapper_gtk_container_get_height_target","summary":"Get a @container height target.","deprecated":null},{"type":"method","name":"get_inhibited","type_name":"Video","ident":"clapper_gtk_video_get_inhibited","summary":"Get whether session is currently inhibited by [property@ClapperGtk.Video:auto-inhibit].","deprecated":null},{"type":"method","name":"get_leading","type_name":"LeadContainer","ident":"clapper_gtk_lead_container_get_leading","summary":"Get a whenever @lead_container has leadership set.","deprecated":null},{"type":"method","name":"get_player","type_name":"Video","ident":"clapper_gtk_video_get_player","summary":"Get #ClapperPlayer used by this #ClapperGtkVideo instance.","deprecated":null},{"type":"method","name":"get_queue","type_name":"QueueSelection","ident":"clapper_gtk_queue_selection_get_queue","summary":"Get #ClapperQueue managed by this selection model.","deprecated":null},{"type":"method","name":"get_reveal_labels","type_name":"ProgressBar","ident":"clapper_gtk_progress_bar_get_reveal_labels","summary":"Get whether the position and duration labels are going to be revealed.","deprecated":null},{"type":"method","name":"get_seek_method","type_name":"ProgressBar","ident":"clapper_gtk_progress_bar_get_seek_method","summary":"Get [enum@Clapper.PlayerSeekMethod] used when seeking with progress bar.","deprecated":null},{"type":"method","name":"get_seek_method","type_name":"SimpleControls","ident":"clapper_gtk_simple_controls_get_seek_method","summary":"Get [enum@Clapper.PlayerSeekMethod] used when seeking with progress bar.","deprecated":null},{"type":"method","name":"get_touch_fade_delay","type_name":"Video","ident":"clapper_gtk_video_get_touch_fade_delay","summary":"Get time in milliseconds after which fading overlays should fade when revealed using touch device.","deprecated":null},{"type":"method","name":"get_width_target","type_name":"Container","ident":"clapper_gtk_container_get_width_target","summary":"Get a @container width target.","deprecated":null},{"type":"method","name":"pin_message","type_name":"Billboard","ident":"clapper_gtk_billboard_pin_message","summary":"No description available.","deprecated":null},{"type":"method","name":"post_message","type_name":"Billboard","ident":"clapper_gtk_billboard_post_message","summary":"No description available.","deprecated":null},{"type":"method","name":"set_adaptive_height","type_name":"Container","ident":"clapper_gtk_container_set_adaptive_height","summary":"Set an adaptive height threshold. When widget is resized to value or lower, an [signal@ClapperGtk.Container::adapt] signal will be emitted ...","deprecated":null},{"type":"method","name":"set_adaptive_width","type_name":"Container","ident":"clapper_gtk_container_set_adaptive_width","summary":"Set an adaptive width threshold. When widget is resized to value or lower, an [signal@ClapperGtk.Container::adapt] signal will be emitted ...","deprecated":null},{"type":"method","name":"set_auto_inhibit","type_name":"Video","ident":"clapper_gtk_video_set_auto_inhibit","summary":"Set whether video should try to automatically inhibit session from idling (and possibly screen going black) when video is playing.","deprecated":null},{"type":"method","name":"set_blocked_actions","type_name":"LeadContainer","ident":"clapper_gtk_lead_container_set_blocked_actions","summary":"Set @actions that #ClapperGtkVideo should skip when #GdkEvent which would normally trigger them happens inside @lead_container.","deprecated":null},{"type":"method","name":"set_child","type_name":"Container","ident":"clapper_gtk_container_set_child","summary":"Set a child #GtkWidget of @container.","deprecated":null},{"type":"method","name":"set_fade_delay","type_name":"Video","ident":"clapper_gtk_video_set_fade_delay","summary":"Set time in milliseconds after which fading overlays should fade.","deprecated":null},{"type":"method","name":"set_fullscreenable","type_name":"SimpleControls","ident":"clapper_gtk_simple_controls_set_fullscreenable","summary":"Set whether [class@ClapperGtk.ToggleFullscreenButton] button in the @controls should be visible. You might want to consider setting this to ...","deprecated":null},{"type":"method","name":"set_height_target","type_name":"Container","ident":"clapper_gtk_container_set_height_target","summary":"Same as clapper_gtk_container_set_width_target() but for widget height.","deprecated":null},{"type":"method","name":"set_leading","type_name":"LeadContainer","ident":"clapper_gtk_lead_container_set_leading","summary":"Set if @lead_container leadership should be enabled. When enabled, interactions with @lead_container will not trigger their default behavior, ...","deprecated":null},{"type":"method","name":"set_queue","type_name":"QueueSelection","ident":"clapper_gtk_queue_selection_set_queue","summary":"Set #ClapperQueue to be managed by this selection model.","deprecated":null},{"type":"method","name":"set_reveal_labels","type_name":"ProgressBar","ident":"clapper_gtk_progress_bar_set_reveal_labels","summary":"Set whether the position and duration labels should be revealed.","deprecated":null},{"type":"method","name":"set_seek_method","type_name":"ProgressBar","ident":"clapper_gtk_progress_bar_set_seek_method","summary":"Set [enum@Clapper.PlayerSeekMethod] to use when seeking with progress bar.","deprecated":null},{"type":"method","name":"set_seek_method","type_name":"SimpleControls","ident":"clapper_gtk_simple_controls_set_seek_method","summary":"Set [enum@Clapper.PlayerSeekMethod] to use when seeking with progress bar.","deprecated":null},{"type":"method","name":"set_touch_fade_delay","type_name":"Video","ident":"clapper_gtk_video_set_touch_fade_delay","summary":"Set time in milliseconds after which fading overlays should fade when using touchscreen. It is often useful to ...","deprecated":null},{"type":"method","name":"set_width_target","type_name":"Container","ident":"clapper_gtk_container_set_width_target","summary":"Set a width that @container should target. When set container will not stretch beyond set @width while still expanding ...","deprecated":null},{"type":"method","name":"unpin_pinned_message","type_name":"Billboard","ident":"clapper_gtk_billboard_unpin_pinned_message","summary":"No description available.","deprecated":null},{"type":"property","name":"adaptive-height","type_name":"Container","summary":"Adaptive height threshold that triggers [signal@ClapperGtk.Container::adapt] signal.","deprecated":null},{"type":"property","name":"adaptive-width","type_name":"Container","summary":"Adaptive width threshold that triggers [signal@ClapperGtk.Container::adapt] signal.","deprecated":null},{"type":"property","name":"auto-inhibit","type_name":"Video","summary":"Try to automatically inhibit session when video is playing.","deprecated":null},{"type":"property","name":"blocked-actions","type_name":"LeadContainer","summary":"Mask of actions that container blocks from being triggered on video.","deprecated":null},{"type":"property","name":"fade-delay","type_name":"Video","summary":"A delay in milliseconds before trying to fade all fading overlays.","deprecated":null},{"type":"property","name":"fullscreenable","type_name":"SimpleControls","summary":"Whether toggle fullscreen button should be visible.","deprecated":null},{"type":"property","name":"height-target","type_name":"Container","summary":"Height that container should target.","deprecated":null},{"type":"property","name":"inhibited","type_name":"Video","summary":"Get whether session is currently inhibited by the video.","deprecated":null},{"type":"property","name":"leading","type_name":"LeadContainer","summary":"Width that container should target.","deprecated":null},{"type":"property","name":"player","type_name":"Video","summary":"A #ClapperPlayer used by video.","deprecated":null},{"type":"property","name":"queue","type_name":"QueueSelection","summary":"The queue being managed.","deprecated":null},{"type":"property","name":"reveal-labels","type_name":"ProgressBar","summary":"Reveal state of the position and duration labels.","deprecated":null},{"type":"property","name":"seek-method","type_name":"ProgressBar","summary":"Method used for seeking.","deprecated":null},{"type":"property","name":"seek-method","type_name":"SimpleControls","summary":"Method used for seeking.","deprecated":null},{"type":"property","name":"touch-fade-delay","type_name":"Video","summary":"A delay in milliseconds before trying to fade all fading overlays after revealed using touchscreen.","deprecated":null},{"type":"property","name":"width-target","type_name":"Container","summary":"Width that container should target.","deprecated":null},{"type":"signal","name":"adapt","type_name":"Container","summary":"A helper signal for implementing mobile/narrow adaptive behavior on descendants.","deprecated":null},{"type":"signal","name":"item-query","type_name":"QueueSelection","summary":"Signals when the #GtkSelectionModel is doing item query. Can be used to know that a widget is created ...","deprecated":null},{"type":"signal","name":"item-selected","type_name":"QueueSelection","summary":"Signals when user selected item within the #GtkSelectionModel. Note that this signal is emitted only when item gets selected ...","deprecated":null},{"type":"signal","name":"toggle-fullscreen","type_name":"Video","summary":"A signal that user requested a change in fullscreen state of the video. Note that when going fullscreen ...","deprecated":null},{"type":"vfunc","name":"can_skip","type_name":"SkipItemButton","summary":"No description available.","deprecated":null},{"type":"vfunc","name":"skip_item","type_name":"SkipItemButton","summary":"No description available.","deprecated":null}],"terms":{}} \ No newline at end of file diff --git a/doc/clapper-gtk/main.js b/doc/clapper-gtk/main.js new file mode 100644 index 00000000..4bb0582e --- /dev/null +++ b/doc/clapper-gtk/main.js @@ -0,0 +1,177 @@ +// SPDX-FileCopyrightText: 2021 GNOME Foundation +// +// SPDX-License-Identifier: Apache-2.0 OR GPL-3.0-or-later +"use strict"; + + +const urlMap = new Map(typeof baseURLs !== 'undefined' ? baseURLs : []); + +window.addEventListener("hashchange", onDidHashChange); +window.addEventListener("load", onDidLoad, false); +window.addEventListener("keydown", onKeyDown); + +function onDidLoad() { + attachScrollHandlers() + attachToggleHandlers() + attachCopyHandlers() + + if (window.onInitSearch) { + window.onInitSearch() + } +} + +function onDidHashChange() { + // When URL fragment changes to ID of a collapsible section, + // expand it when it is collapsed. + // This is useful for clicking section links in the sidebar on the index page. + const sectionHeader = document.querySelector(".section-header" + location.hash); + if (sectionHeader !== null) { + const parent = sectionHeader.parentNode; + if (hasClass(parent, "toggle-wrapper")) { + const toggle = parent.querySelector(".collapse-toggle"); + if (hasClass(toggle, "collapsed")) { + toggle.click(); + } + } + } +} + + +function attachScrollHandlers() { + const btnToTop = document.getElementById("btn-to-top"); + + btnToTop.addEventListener('click', onClick); + window.addEventListener('scroll', onScroll); + + function onClick(e) { + e.preventDefault(); + window.scroll({ top: 0, behavior: 'smooth' }); + } + + function onScroll() { + if (window.scrollY < 400) { + addClass(btnToTop, "hidden"); + } else { + removeClass(btnToTop, "hidden"); + } + } +} + +function attachToggleHandlers() { + function label(isCollapsed) { + return ( + "[" + + (isCollapsed ? "+" : "\u2212") + + "]" + ) + } + + function createToggle(isCollapsed) { + const toggle = document.createElement("a"); + toggle.href = "javascript:void(0)"; + toggle.className = "collapse-toggle"; + toggle.innerHTML = label(isCollapsed); + toggle.addEventListener('click', onClickToggle); + return toggle; + } + + function onClickToggle() { + if (hasClass(this, "collapsed")) { + removeClass(this, "collapsed"); + this.innerHTML = label(false); + forEach(this.parentNode.querySelectorAll(".docblock"), function(e) { + removeClass(e, "hidden"); + }); + } else { + addClass(this, "collapsed"); + this.innerHTML = label(true); + forEach(this.parentNode.querySelectorAll(".docblock"), function(e) { + addClass(e, "hidden"); + }); + } + } + + forEach(document.querySelectorAll(".toggle-wrapper"), function(e) { + const sectionHeader = e.querySelector(".section-header"); + const fragmentMatches = sectionHeader !== null && location.hash === "#" + sectionHeader.getAttribute('id'); + const collapsedByDefault = hasClass(e, "default-hide") && !fragmentMatches; + const toggle = createToggle(collapsedByDefault); + e.insertBefore(toggle, e.firstChild); + if (collapsedByDefault) { + addClass(toggle, "collapsed"); + forEach(e.querySelectorAll(".docblock"), function(d) { + addClass(d, "hidden"); + }); + } + }); + + function resolveNamespaceLink(namespace) { + return urlMap.get(namespace); + } + + forEach(document.querySelectorAll(".external"), function(e) { + if (e.tagName == "A" && e.dataset.hasOwnProperty('namespace')) { + var data_namespace = e.dataset.namespace + var data_link = e.dataset.link + var base_url = resolveNamespaceLink(data_namespace) + if (base_url !== undefined) { + e.href = base_url + data_link; + } else { + e.title = "No reference to the " + data_namespace + " namespace"; + } + } + }) +} + +function attachCopyHandlers() { + if (!navigator.clipboard) + return; + + forEach(document.querySelectorAll(".codehilite"), function(e) { + const button = document.createElement("button"); + button.className = "copy-button"; + button.innerText = "Copy"; + button.title = "Copy code to clipboard"; + + const text = e.innerText; + button.addEventListener("click", () => { + navigator.clipboard.writeText(text); + }); + + e.appendChild(button); + }) +} + +function onKeyDown(event) { + let search_input = document.querySelector("#search-input"); + // We don't want to try to focus the search input if it isn't visible. That way + // we avoid the preventDefault(), hence allowing devhelp to use S as mnemonic. + let potentially_hidden_parent = search_input.closest('.hidden, .devhelp-hidden'); + + if (window.getComputedStyle(potentially_hidden_parent).display !== 'none' && + (event.key === "s" || event.key === "S") && + document.activeElement !== search_input) { + event.preventDefault(); + search_input.focus(); + } +} + +// Helpers + +function hasClass(elem, className) { + return elem && elem.classList && elem.classList.contains(className); +} + +function addClass(elem, className) { + return elem && elem.classList && elem.classList.add(className); +} + +function removeClass(elem, className) { + return elem && elem.classList && elem.classList.remove(className); +} + +function forEach(arr, func) { + for (let i = 0; i < arr.length; ++i) { + func(arr[i]) + } +} diff --git a/doc/clapper-gtk/method.Billboard.announce_speed.html b/doc/clapper-gtk/method.Billboard.announce_speed.html new file mode 100644 index 00000000..aa3555e9 --- /dev/null +++ b/doc/clapper-gtk/method.Billboard.announce_speed.html @@ -0,0 +1,214 @@ + + + + + + ClapperGtk.Billboard.announce_speed + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkBillboardannounce_speed

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_billboard_announce_speed (
+  ClapperGtkBillboard* board,
+  gfloat speed
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + + + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
speed
+
+

Type: gfloat

+

No description available.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.Billboard.announce_volume.html b/doc/clapper-gtk/method.Billboard.announce_volume.html new file mode 100644 index 00000000..b64b4217 --- /dev/null +++ b/doc/clapper-gtk/method.Billboard.announce_volume.html @@ -0,0 +1,214 @@ + + + + + + ClapperGtk.Billboard.announce_volume + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkBillboardannounce_volume

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_billboard_announce_volume (
+  ClapperGtkBillboard* board,
+  gfloat volume
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + + + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
volume
+
+

Type: gfloat

+

No description available.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.Billboard.pin_message.html b/doc/clapper-gtk/method.Billboard.pin_message.html new file mode 100644 index 00000000..a955a96d --- /dev/null +++ b/doc/clapper-gtk/method.Billboard.pin_message.html @@ -0,0 +1,232 @@ + + + + + + ClapperGtk.Billboard.pin_message + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkBillboardpin_message

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_billboard_pin_message (
+  ClapperGtkBillboard* board,
+  const gchar* icon_name,
+  const gchar* message
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + + + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
icon_name
+
+

Type: const gchar*

+

No description available.

+ + + + + + + + + + +
The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
+
+ +
message
+
+

Type: const gchar*

+

No description available.

+ + + + + + + + + + +
The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.Billboard.post_message.html b/doc/clapper-gtk/method.Billboard.post_message.html new file mode 100644 index 00000000..00491799 --- /dev/null +++ b/doc/clapper-gtk/method.Billboard.post_message.html @@ -0,0 +1,232 @@ + + + + + + ClapperGtk.Billboard.post_message + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkBillboardpost_message

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_billboard_post_message (
+  ClapperGtkBillboard* board,
+  const gchar* icon_name,
+  const gchar* message
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + + + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
icon_name
+
+

Type: const gchar*

+

No description available.

+ + + + + + + + + + +
The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
+
+ +
message
+
+

Type: const gchar*

+

No description available.

+ + + + + + + + + + +
The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.Billboard.unpin_pinned_message.html b/doc/clapper-gtk/method.Billboard.unpin_pinned_message.html new file mode 100644 index 00000000..06ee14f9 --- /dev/null +++ b/doc/clapper-gtk/method.Billboard.unpin_pinned_message.html @@ -0,0 +1,181 @@ + + + + + + ClapperGtk.Billboard.unpin_pinned_message + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkBillboardunpin_pinned_message

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_billboard_unpin_pinned_message (
+  ClapperGtkBillboard* board
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + + + + +
+ + +
+ + + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.BulletinBoard.announce_speed.html b/doc/clapper-gtk/method.BulletinBoard.announce_speed.html new file mode 100644 index 00000000..ef6291c2 --- /dev/null +++ b/doc/clapper-gtk/method.BulletinBoard.announce_speed.html @@ -0,0 +1,214 @@ + + + + + + ClapperGtk.BulletinBoard.announce_speed + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkBulletinBoardannounce_speed

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_bulletin_board_announce_speed (
+  ClapperGtkBulletinBoard* board,
+  gfloat speed
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + + + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
speed
+
+

Type: gfloat

+

No description available.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.BulletinBoard.announce_volume.html b/doc/clapper-gtk/method.BulletinBoard.announce_volume.html new file mode 100644 index 00000000..f7c5bbfb --- /dev/null +++ b/doc/clapper-gtk/method.BulletinBoard.announce_volume.html @@ -0,0 +1,214 @@ + + + + + + ClapperGtk.BulletinBoard.announce_volume + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkBulletinBoardannounce_volume

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_bulletin_board_announce_volume (
+  ClapperGtkBulletinBoard* board,
+  gfloat volume
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + + + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
volume
+
+

Type: gfloat

+

No description available.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.BulletinBoard.pin_message.html b/doc/clapper-gtk/method.BulletinBoard.pin_message.html new file mode 100644 index 00000000..08805d49 --- /dev/null +++ b/doc/clapper-gtk/method.BulletinBoard.pin_message.html @@ -0,0 +1,232 @@ + + + + + + ClapperGtk.BulletinBoard.pin_message + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkBulletinBoardpin_message

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_bulletin_board_pin_message (
+  ClapperGtkBulletinBoard* board,
+  const gchar* icon_name,
+  const gchar* message
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + + + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
icon_name
+
+

Type: const gchar*

+

No description available.

+ + + + + + + + + + +
The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
+
+ +
message
+
+

Type: const gchar*

+

No description available.

+ + + + + + + + + + +
The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.BulletinBoard.post_message.html b/doc/clapper-gtk/method.BulletinBoard.post_message.html new file mode 100644 index 00000000..12efc3e0 --- /dev/null +++ b/doc/clapper-gtk/method.BulletinBoard.post_message.html @@ -0,0 +1,232 @@ + + + + + + ClapperGtk.BulletinBoard.post_message + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkBulletinBoardpost_message

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_bulletin_board_post_message (
+  ClapperGtkBulletinBoard* board,
+  const gchar* icon_name,
+  const gchar* message
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + + + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
icon_name
+
+

Type: const gchar*

+

No description available.

+ + + + + + + + + + +
The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
+
+ +
message
+
+

Type: const gchar*

+

No description available.

+ + + + + + + + + + +
The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.BulletinBoard.unpin_pinned_message.html b/doc/clapper-gtk/method.BulletinBoard.unpin_pinned_message.html new file mode 100644 index 00000000..4d9f266e --- /dev/null +++ b/doc/clapper-gtk/method.BulletinBoard.unpin_pinned_message.html @@ -0,0 +1,181 @@ + + + + + + ClapperGtk.BulletinBoard.unpin_pinned_message + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkBulletinBoardunpin_pinned_message

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_bulletin_board_unpin_pinned_message (
+  ClapperGtkBulletinBoard* board
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + + + + +
+ + +
+ + + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.Container.get_adaptive_height.html b/doc/clapper-gtk/method.Container.get_adaptive_height.html new file mode 100644 index 00000000..b1a5ed8e --- /dev/null +++ b/doc/clapper-gtk/method.Container.get_adaptive_height.html @@ -0,0 +1,227 @@ + + + + + + ClapperGtk.Container.get_adaptive_height + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkContainerget_adaptive_height

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
gint
+clapper_gtk_container_get_adaptive_height (
+  ClapperGtkContainer* container
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get a container adaptive height threshold.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapperGtk.Container:adaptive-height
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: gint

+

Adaptive height set by user or -1 when none.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.Container.get_adaptive_width.html b/doc/clapper-gtk/method.Container.get_adaptive_width.html new file mode 100644 index 00000000..b85c5dfa --- /dev/null +++ b/doc/clapper-gtk/method.Container.get_adaptive_width.html @@ -0,0 +1,227 @@ + + + + + + ClapperGtk.Container.get_adaptive_width + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkContainerget_adaptive_width

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
gint
+clapper_gtk_container_get_adaptive_width (
+  ClapperGtkContainer* container
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get a container adaptive width threshold.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapperGtk.Container:adaptive-width
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: gint

+

Adaptive width set by user or -1 when none.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.Container.get_child.html b/doc/clapper-gtk/method.Container.get_child.html new file mode 100644 index 00000000..e83c5ae2 --- /dev/null +++ b/doc/clapper-gtk/method.Container.get_child.html @@ -0,0 +1,219 @@ + + + + + + ClapperGtk.Container.get_child + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkContainerget_child

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
GtkWidget*
+clapper_gtk_container_get_child (
+  ClapperGtkContainer* container
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get a child GtkWidget of container.

+
+ +
+ + + + + + +
+ + +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: GtkWidget

+

GtkWidget set as child.

+
+
+ + + + + + + +
The data is owned by the instance.
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.Container.get_height_target.html b/doc/clapper-gtk/method.Container.get_height_target.html new file mode 100644 index 00000000..215b8333 --- /dev/null +++ b/doc/clapper-gtk/method.Container.get_height_target.html @@ -0,0 +1,227 @@ + + + + + + ClapperGtk.Container.get_height_target + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkContainerget_height_target

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
gint
+clapper_gtk_container_get_height_target (
+  ClapperGtkContainer* container
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get a container height target.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapperGtk.Container:height-target
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: gint

+

Height target set by user or -1 when none.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.Container.get_width_target.html b/doc/clapper-gtk/method.Container.get_width_target.html new file mode 100644 index 00000000..6e3802ae --- /dev/null +++ b/doc/clapper-gtk/method.Container.get_width_target.html @@ -0,0 +1,227 @@ + + + + + + ClapperGtk.Container.get_width_target + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkContainerget_width_target

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
gint
+clapper_gtk_container_get_width_target (
+  ClapperGtkContainer* container
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get a container width target.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapperGtk.Container:width-target
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: gint

+

Width target set by user or -1 when none.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.Container.set_adaptive_height.html b/doc/clapper-gtk/method.Container.set_adaptive_height.html new file mode 100644 index 00000000..d04b0150 --- /dev/null +++ b/doc/clapper-gtk/method.Container.set_adaptive_height.html @@ -0,0 +1,237 @@ + + + + + + ClapperGtk.Container.set_adaptive_height + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkContainerset_adaptive_height

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_container_set_adaptive_height (
+  ClapperGtkContainer* container,
+  gint height
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Set an adaptive height threshold. When widget is resized to value or lower, +an ClapperGtkContainer::adapt signal will be emitted with TRUE to +notify implementation about mobile adaptation request, otherwise FALSE when +both threshold values are exceeded.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Sets propertyClapperGtk.Container:adaptive-height
+
+ +
+ + +
+

+ Parameters + +

+ +
+
+ +
height
+
+

Type: gint

+

A threshold on which adapt signal should be triggered or -1 to disable.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.Container.set_adaptive_width.html b/doc/clapper-gtk/method.Container.set_adaptive_width.html new file mode 100644 index 00000000..b97df472 --- /dev/null +++ b/doc/clapper-gtk/method.Container.set_adaptive_width.html @@ -0,0 +1,237 @@ + + + + + + ClapperGtk.Container.set_adaptive_width + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkContainerset_adaptive_width

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_container_set_adaptive_width (
+  ClapperGtkContainer* container,
+  gint width
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Set an adaptive width threshold. When widget is resized to value or lower, +an ClapperGtkContainer::adapt signal will be emitted with TRUE to +notify implementation about mobile adaptation request, otherwise FALSE when +both threshold values are exceeded.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Sets propertyClapperGtk.Container:adaptive-width
+
+ +
+ + +
+

+ Parameters + +

+ +
+
+ +
width
+
+

Type: gint

+

A threshold on which adapt signal should be triggered or -1 to disable.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.Container.set_child.html b/doc/clapper-gtk/method.Container.set_child.html new file mode 100644 index 00000000..4efaa008 --- /dev/null +++ b/doc/clapper-gtk/method.Container.set_child.html @@ -0,0 +1,226 @@ + + + + + + ClapperGtk.Container.set_child + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkContainerset_child

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_container_set_child (
+  ClapperGtkContainer* container,
+  GtkWidget* child
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Set a child GtkWidget of container.

+
+ +
+ + + + + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
child
+
+

Type: GtkWidget

+

No description available.

+ + + + + + + + + + +
The data is owned by the caller of the method.
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.Container.set_height_target.html b/doc/clapper-gtk/method.Container.set_height_target.html new file mode 100644 index 00000000..7c784b18 --- /dev/null +++ b/doc/clapper-gtk/method.Container.set_height_target.html @@ -0,0 +1,234 @@ + + + + + + ClapperGtk.Container.set_height_target + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkContainerset_height_target

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_container_set_height_target (
+  ClapperGtkContainer* container,
+  gint height
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Same as clapper_gtk_container_set_width_target() but for widget height.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Sets propertyClapperGtk.Container:height-target
+
+ +
+ + +
+

+ Parameters + +

+ +
+
+ +
height
+
+

Type: gint

+

Height to target or -1 to restore default behavior.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.Container.set_width_target.html b/doc/clapper-gtk/method.Container.set_width_target.html new file mode 100644 index 00000000..cebea8c4 --- /dev/null +++ b/doc/clapper-gtk/method.Container.set_width_target.html @@ -0,0 +1,236 @@ + + + + + + ClapperGtk.Container.set_width_target + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkContainerset_width_target

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_container_set_width_target (
+  ClapperGtkContainer* container,
+  gint width
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Set a width that container should target. When set container +will not stretch beyond set width while still expanding into +possible boundaries trying to reach its target.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Sets propertyClapperGtk.Container:width-target
+
+ +
+ + +
+

+ Parameters + +

+ +
+
+ +
width
+
+

Type: gint

+

Width to target -1 to restore default behavior.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.LeadContainer.get_blocked_actions.html b/doc/clapper-gtk/method.LeadContainer.get_blocked_actions.html new file mode 100644 index 00000000..68e246db --- /dev/null +++ b/doc/clapper-gtk/method.LeadContainer.get_blocked_actions.html @@ -0,0 +1,215 @@ + + + + + + ClapperGtk.LeadContainer.get_blocked_actions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkLeadContainerget_blocked_actions

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
ClapperGtkVideoActionMask
+clapper_gtk_lead_container_get_blocked_actions (
+  ClapperGtkLeadContainer* lead_container
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get actions that were set for this lead_container to block.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapperGtk.LeadContainer:blocked-actions
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: ClapperGtkVideoActionMask

+

A mask of actions that container blocks from being triggered on video.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.LeadContainer.get_leading.html b/doc/clapper-gtk/method.LeadContainer.get_leading.html new file mode 100644 index 00000000..d9afcda6 --- /dev/null +++ b/doc/clapper-gtk/method.LeadContainer.get_leading.html @@ -0,0 +1,215 @@ + + + + + + ClapperGtk.LeadContainer.get_leading + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkLeadContainerget_leading

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
gboolean
+clapper_gtk_lead_container_get_leading (
+  ClapperGtkLeadContainer* lead_container
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get a whenever lead_container has leadership set.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapperGtk.LeadContainer:leading
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: gboolean

+

TRUE if container is leading, FALSE otherwise.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.LeadContainer.set_blocked_actions.html b/doc/clapper-gtk/method.LeadContainer.set_blocked_actions.html new file mode 100644 index 00000000..bed33de2 --- /dev/null +++ b/doc/clapper-gtk/method.LeadContainer.set_blocked_actions.html @@ -0,0 +1,223 @@ + + + + + + ClapperGtk.LeadContainer.set_blocked_actions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkLeadContainerset_blocked_actions

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_lead_container_set_blocked_actions (
+  ClapperGtkLeadContainer* lead_container,
+  ClapperGtkVideoActionMask actions
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Set actions that ClapperGtkVideo should skip when GdkEvent which +would normally trigger them happens inside lead_container.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Sets propertyClapperGtk.LeadContainer:blocked-actions
+
+ +
+ + +
+

+ Parameters + +

+ +
+
+ +
actions
+
+

Type: ClapperGtkVideoActionMask

+

A ClapperGtkVideoActionMask of actions to block.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.LeadContainer.set_leading.html b/doc/clapper-gtk/method.LeadContainer.set_leading.html new file mode 100644 index 00000000..39093dbd --- /dev/null +++ b/doc/clapper-gtk/method.LeadContainer.set_leading.html @@ -0,0 +1,224 @@ + + + + + + ClapperGtk.LeadContainer.set_leading + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkLeadContainerset_leading

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_lead_container_set_leading (
+  ClapperGtkLeadContainer* lead_container,
+  gboolean leading
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Set if lead_container leadership should be enabled.

+

When enabled, interactions with lead_container will not trigger +their default behavior, instead container and its contents will take priority.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Sets propertyClapperGtk.LeadContainer:leading
+
+ +
+ + +
+

+ Parameters + +

+ +
+
+ +
leading
+
+

Type: gboolean

+

Enable leadership.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.ProgressBar.get_reveal_labels.html b/doc/clapper-gtk/method.ProgressBar.get_reveal_labels.html new file mode 100644 index 00000000..f1d33255 --- /dev/null +++ b/doc/clapper-gtk/method.ProgressBar.get_reveal_labels.html @@ -0,0 +1,215 @@ + + + + + + ClapperGtk.ProgressBar.get_reveal_labels + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkProgressBarget_reveal_labels

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
gboolean
+clapper_gtk_progress_bar_get_reveal_labels (
+  ClapperGtkProgressBar* progress_bar
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get whether the position and duration labels are going to be revealed.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapperGtk.ProgressBar:reveal-labels
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: gboolean

+

TRUE if the labels are going to be revealed, FALSE otherwise.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.ProgressBar.get_seek_method.html b/doc/clapper-gtk/method.ProgressBar.get_seek_method.html new file mode 100644 index 00000000..7daf7f98 --- /dev/null +++ b/doc/clapper-gtk/method.ProgressBar.get_seek_method.html @@ -0,0 +1,215 @@ + + + + + + ClapperGtk.ProgressBar.get_seek_method + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkProgressBarget_seek_method

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
ClapperPlayerSeekMethod
+clapper_gtk_progress_bar_get_seek_method (
+  ClapperGtkProgressBar* progress_bar
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get ClapperPlayerSeekMethod used when seeking with progress bar.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapperGtk.ProgressBar:seek-method
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: ClapperPlayerSeekMethod

+

ClapperPlayerSeekMethod used for seeking.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.ProgressBar.set_reveal_labels.html b/doc/clapper-gtk/method.ProgressBar.set_reveal_labels.html new file mode 100644 index 00000000..8c3ba031 --- /dev/null +++ b/doc/clapper-gtk/method.ProgressBar.set_reveal_labels.html @@ -0,0 +1,222 @@ + + + + + + ClapperGtk.ProgressBar.set_reveal_labels + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkProgressBarset_reveal_labels

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_progress_bar_set_reveal_labels (
+  ClapperGtkProgressBar* progress_bar,
+  gboolean reveal
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Set whether the position and duration labels should be revealed.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Sets propertyClapperGtk.ProgressBar:reveal-labels
+
+ +
+ + +
+

+ Parameters + +

+ +
+
+ +
reveal
+
+

Type: gboolean

+

Whether to reveal labels.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.ProgressBar.set_seek_method.html b/doc/clapper-gtk/method.ProgressBar.set_seek_method.html new file mode 100644 index 00000000..b3b6b9a3 --- /dev/null +++ b/doc/clapper-gtk/method.ProgressBar.set_seek_method.html @@ -0,0 +1,222 @@ + + + + + + ClapperGtk.ProgressBar.set_seek_method + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkProgressBarset_seek_method

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_progress_bar_set_seek_method (
+  ClapperGtkProgressBar* progress_bar,
+  ClapperPlayerSeekMethod method
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Set ClapperPlayerSeekMethod to use when seeking with progress bar.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Sets propertyClapperGtk.ProgressBar:seek-method
+
+ +
+ + +
+

+ Parameters + +

+ +
+
+ +
method
+
+

Type: ClapperPlayerSeekMethod

+

A ClapperPlayerSeekMethod.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.QueueSelection.get_queue.html b/doc/clapper-gtk/method.QueueSelection.get_queue.html new file mode 100644 index 00000000..ed1dc663 --- /dev/null +++ b/doc/clapper-gtk/method.QueueSelection.get_queue.html @@ -0,0 +1,211 @@ + + + + + + ClapperGtk.QueueSelection.get_queue + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkQueueSelectionget_queue

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
ClapperQueue*
+clapper_gtk_queue_selection_get_queue (
+  ClapperGtkQueueSelection* selection
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get ClapperQueue managed by this selection model.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapperGtk.QueueSelection:queue
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: ClapperQueue

+

ClapperQueue being managed.

+
+
+ + + + + + + +
The data is owned by the instance.
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.QueueSelection.set_queue.html b/doc/clapper-gtk/method.QueueSelection.set_queue.html new file mode 100644 index 00000000..4342b90f --- /dev/null +++ b/doc/clapper-gtk/method.QueueSelection.set_queue.html @@ -0,0 +1,218 @@ + + + + + + ClapperGtk.QueueSelection.set_queue + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkQueueSelectionset_queue

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_queue_selection_set_queue (
+  ClapperGtkQueueSelection* selection,
+  ClapperQueue* queue
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Set ClapperQueue to be managed by this selection model.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Sets propertyClapperGtk.QueueSelection:queue
+
+ +
+ + +
+

+ Parameters + +

+ +
+
+ +
queue
+
+

Type: ClapperQueue

+

A ClapperQueue.

+ + + + + + + + + + +
The data is owned by the caller of the method.
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.SimpleControls.get_fullscreenable.html b/doc/clapper-gtk/method.SimpleControls.get_fullscreenable.html new file mode 100644 index 00000000..a5f4977e --- /dev/null +++ b/doc/clapper-gtk/method.SimpleControls.get_fullscreenable.html @@ -0,0 +1,216 @@ + + + + + + ClapperGtk.SimpleControls.get_fullscreenable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkSimpleControlsget_fullscreenable

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
gboolean
+clapper_gtk_simple_controls_get_fullscreenable (
+  ClapperGtkSimpleControls* controls
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get whether ClapperGtkToggleFullscreenButton button in the controls +is set to be visible.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapperGtk.SimpleControls:fullscreenable
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: gboolean

+

No description available.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.SimpleControls.get_seek_method.html b/doc/clapper-gtk/method.SimpleControls.get_seek_method.html new file mode 100644 index 00000000..ccf609f5 --- /dev/null +++ b/doc/clapper-gtk/method.SimpleControls.get_seek_method.html @@ -0,0 +1,215 @@ + + + + + + ClapperGtk.SimpleControls.get_seek_method + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkSimpleControlsget_seek_method

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
ClapperPlayerSeekMethod
+clapper_gtk_simple_controls_get_seek_method (
+  ClapperGtkSimpleControls* controls
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get ClapperPlayerSeekMethod used when seeking with progress bar.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapperGtk.SimpleControls:seek-method
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: ClapperPlayerSeekMethod

+

ClapperPlayerSeekMethod used for seeking.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.SimpleControls.set_fullscreenable.html b/doc/clapper-gtk/method.SimpleControls.set_fullscreenable.html new file mode 100644 index 00000000..ab59624a --- /dev/null +++ b/doc/clapper-gtk/method.SimpleControls.set_fullscreenable.html @@ -0,0 +1,225 @@ + + + + + + ClapperGtk.SimpleControls.set_fullscreenable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkSimpleControlsset_fullscreenable

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_simple_controls_set_fullscreenable (
+  ClapperGtkSimpleControls* controls,
+  gboolean fullscreenable
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Set whether ClapperGtkToggleFullscreenButton button in the controls +should be visible.

+

You might want to consider setting this to FALSE, if your application +does not implement ClapperGtkVideo::toggle-fullscreen signal.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Sets propertyClapperGtk.SimpleControls:fullscreenable
+
+ +
+ + +
+

+ Parameters + +

+ +
+
+ +
fullscreenable
+
+

Type: gboolean

+

Whether show button for toggling fullscreen state.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.SimpleControls.set_seek_method.html b/doc/clapper-gtk/method.SimpleControls.set_seek_method.html new file mode 100644 index 00000000..98d09c82 --- /dev/null +++ b/doc/clapper-gtk/method.SimpleControls.set_seek_method.html @@ -0,0 +1,222 @@ + + + + + + ClapperGtk.SimpleControls.set_seek_method + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkSimpleControlsset_seek_method

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_simple_controls_set_seek_method (
+  ClapperGtkSimpleControls* controls,
+  ClapperPlayerSeekMethod method
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Set ClapperPlayerSeekMethod to use when seeking with progress bar.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Sets propertyClapperGtk.SimpleControls:seek-method
+
+ +
+ + +
+

+ Parameters + +

+ +
+
+ +
method
+
+

Type: ClapperPlayerSeekMethod

+

A ClapperPlayerSeekMethod.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.Video.add_fading_overlay.html b/doc/clapper-gtk/method.Video.add_fading_overlay.html new file mode 100644 index 00000000..4c21ac7b --- /dev/null +++ b/doc/clapper-gtk/method.Video.add_fading_overlay.html @@ -0,0 +1,229 @@ + + + + + + ClapperGtk.Video.add_fading_overlay + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkVideoadd_fading_overlay

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_video_add_fading_overlay (
+  ClapperGtkVideo* video,
+  GtkWidget* widget
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Similiar as clapper_gtk_video_add_overlay() but will also automatically +add fading functionality to overlaid GtkWidget for convenience. This will +make widget reveal itself when interacting with video and fade otherwise. +Useful when placing widgets such as playback controls panels.

+
+ +
+ + + + + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
widget
+
+

Type: GtkWidget

+

A GtkWidget.

+ + + + + + + + + + +
The data is owned by the caller of the method.
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.Video.add_overlay.html b/doc/clapper-gtk/method.Video.add_overlay.html new file mode 100644 index 00000000..fce71120 --- /dev/null +++ b/doc/clapper-gtk/method.Video.add_overlay.html @@ -0,0 +1,233 @@ + + + + + + ClapperGtk.Video.add_overlay + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkVideoadd_overlay

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_video_add_overlay (
+  ClapperGtkVideo* video,
+  GtkWidget* widget
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Add another GtkWidget to be overlaid on top of video.

+

The position at which widget is placed is determined from +GtkWidget:halign and GtkWidget:valign properties.

+

This function will overlay widget as-is meaning that widget is responsible +for managing its own visablity if needed. If you want to add a GtkWidget +that will reveal and fade itself automatically when interacting with video +(e.g. controls panel) you can use clapper_gtk_video_add_fading_overlay() +function for convenience.

+
+ +
+ + + + + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
widget
+
+

Type: GtkWidget

+

A GtkWidget.

+ + + + + + + + + + +
The data is owned by the caller of the method.
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.Video.get_auto_inhibit.html b/doc/clapper-gtk/method.Video.get_auto_inhibit.html new file mode 100644 index 00000000..ad7bc3f3 --- /dev/null +++ b/doc/clapper-gtk/method.Video.get_auto_inhibit.html @@ -0,0 +1,227 @@ + + + + + + ClapperGtk.Video.get_auto_inhibit + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkVideoget_auto_inhibit

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
gboolean
+clapper_gtk_video_get_auto_inhibit (
+  ClapperGtkVideo* video
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get whether automatic session inhibit is enabled.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapperGtk.Video:auto-inhibit
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: gboolean

+

TRUE if enabled, FALSE otherwise.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.Video.get_fade_delay.html b/doc/clapper-gtk/method.Video.get_fade_delay.html new file mode 100644 index 00000000..73a02e97 --- /dev/null +++ b/doc/clapper-gtk/method.Video.get_fade_delay.html @@ -0,0 +1,227 @@ + + + + + + ClapperGtk.Video.get_fade_delay + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkVideoget_fade_delay

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
guint
+clapper_gtk_video_get_fade_delay (
+  ClapperGtkVideo* video
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get time in milliseconds after which fading overlays should fade.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapperGtk.Video:fade-delay
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: guint

+

Currently set fade delay.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.Video.get_inhibited.html b/doc/clapper-gtk/method.Video.get_inhibited.html new file mode 100644 index 00000000..9886feda --- /dev/null +++ b/doc/clapper-gtk/method.Video.get_inhibited.html @@ -0,0 +1,228 @@ + + + + + + ClapperGtk.Video.get_inhibited + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkVideoget_inhibited

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
gboolean
+clapper_gtk_video_get_inhibited (
+  ClapperGtkVideo* video
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get whether session is currently inhibited by +ClapperGtkVideo:auto-inhibit.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapperGtk.Video:inhibited
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: gboolean

+

TRUE if inhibited, FALSE otherwise.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.Video.get_player.html b/doc/clapper-gtk/method.Video.get_player.html new file mode 100644 index 00000000..f2824a06 --- /dev/null +++ b/doc/clapper-gtk/method.Video.get_player.html @@ -0,0 +1,227 @@ + + + + + + ClapperGtk.Video.get_player + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkVideoget_player

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
ClapperPlayer*
+clapper_gtk_video_get_player (
+  ClapperGtkVideo* video
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get ClapperPlayer used by this ClapperGtkVideo instance.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapperGtk.Video:player
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: ClapperPlayer

+

A ClapperPlayer used by video.

+
+
+ + + + + + + +
The data is owned by the instance.
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.Video.get_touch_fade_delay.html b/doc/clapper-gtk/method.Video.get_touch_fade_delay.html new file mode 100644 index 00000000..536a7ed5 --- /dev/null +++ b/doc/clapper-gtk/method.Video.get_touch_fade_delay.html @@ -0,0 +1,228 @@ + + + + + + ClapperGtk.Video.get_touch_fade_delay + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkVideoget_touch_fade_delay

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
guint
+clapper_gtk_video_get_touch_fade_delay (
+  ClapperGtkVideo* video
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get time in milliseconds after which fading overlays should fade +when revealed using touch device.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapperGtk.Video:touch-fade-delay
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: guint

+

Currently set touch fade delay.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.Video.set_auto_inhibit.html b/doc/clapper-gtk/method.Video.set_auto_inhibit.html new file mode 100644 index 00000000..e0316963 --- /dev/null +++ b/doc/clapper-gtk/method.Video.set_auto_inhibit.html @@ -0,0 +1,235 @@ + + + + + + ClapperGtk.Video.set_auto_inhibit + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkVideoset_auto_inhibit

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_video_set_auto_inhibit (
+  ClapperGtkVideo* video,
+  gboolean inhibit
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Set whether video should try to automatically inhibit session +from idling (and possibly screen going black) when video is playing.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Sets propertyClapperGtk.Video:auto-inhibit
+
+ +
+ + +
+

+ Parameters + +

+ +
+
+ +
inhibit
+
+

Type: gboolean

+

Whether to enable automatic session inhibit.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.Video.set_fade_delay.html b/doc/clapper-gtk/method.Video.set_fade_delay.html new file mode 100644 index 00000000..f5825c1d --- /dev/null +++ b/doc/clapper-gtk/method.Video.set_fade_delay.html @@ -0,0 +1,226 @@ + + + + + + ClapperGtk.Video.set_fade_delay + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkVideoset_fade_delay

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_video_set_fade_delay (
+  ClapperGtkVideo* video,
+  guint delay
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Set time in milliseconds after which fading overlays should fade.

+
+ +
+ + + + + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
delay
+
+

Type: guint

+

A fade delay.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/method.Video.set_touch_fade_delay.html b/doc/clapper-gtk/method.Video.set_touch_fade_delay.html new file mode 100644 index 00000000..99737ee2 --- /dev/null +++ b/doc/clapper-gtk/method.Video.set_touch_fade_delay.html @@ -0,0 +1,230 @@ + + + + + + ClapperGtk.Video.set_touch_fade_delay + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperGtkVideoset_touch_fade_delay

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+clapper_gtk_video_set_touch_fade_delay (
+  ClapperGtkVideo* video,
+  guint delay
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Set time in milliseconds after which fading overlays should fade +when using touchscreen.

+

It is often useful to set this higher then normal fade delay property, +as in case of touch events user do not have a moving pointer that would +extend fade timeout, so he can have more time to decide what to press next.

+
+ +
+ + + + + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
delay
+
+

Type: guint

+

A touch fade delay.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/opensearch.xml b/doc/clapper-gtk/opensearch.xml new file mode 100644 index 00000000..fed3c26f --- /dev/null +++ b/doc/clapper-gtk/opensearch.xml @@ -0,0 +1 @@ +ClapperGtkClapperGtk-0.0 Reference ManualUTF-8clapper-logo.svghttps://rafostar.github.io/clapper/doc/clapper-gtk/ \ No newline at end of file diff --git a/doc/clapper-gtk/property.Container.adaptive-height.html b/doc/clapper-gtk/property.Container.adaptive-height.html new file mode 100644 index 00000000..a556bc4e --- /dev/null +++ b/doc/clapper-gtk/property.Container.adaptive-height.html @@ -0,0 +1,198 @@ + + + + + + ClapperGtk.Container:adaptive-height + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperGtkContainer:adaptive-height

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+ 
property adaptive-height: int [ read, write ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Adaptive height threshold that triggers ClapperGtkContainer::adapt signal.

+
+ +
+ + + + + + + +
Type:gint
+
+ + +
+ + + + + + + + +
Default value-1
Getter methodclapper_gtk_container_get_adaptive_height()
Setter methodclapper_gtk_container_set_adaptive_height()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableyes
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/property.Container.adaptive-width.html b/doc/clapper-gtk/property.Container.adaptive-width.html new file mode 100644 index 00000000..e4f69e51 --- /dev/null +++ b/doc/clapper-gtk/property.Container.adaptive-width.html @@ -0,0 +1,198 @@ + + + + + + ClapperGtk.Container:adaptive-width + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperGtkContainer:adaptive-width

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+ 
property adaptive-width: int [ read, write ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Adaptive width threshold that triggers ClapperGtkContainer::adapt signal.

+
+ +
+ + + + + + + +
Type:gint
+
+ + +
+ + + + + + + + +
Default value-1
Getter methodclapper_gtk_container_get_adaptive_width()
Setter methodclapper_gtk_container_set_adaptive_width()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableyes
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/property.Container.height-target.html b/doc/clapper-gtk/property.Container.height-target.html new file mode 100644 index 00000000..dce2cb9a --- /dev/null +++ b/doc/clapper-gtk/property.Container.height-target.html @@ -0,0 +1,198 @@ + + + + + + ClapperGtk.Container:height-target + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperGtkContainer:height-target

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+ 
property height-target: int [ read, write ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Height that container should target.

+
+ +
+ + + + + + + +
Type:gint
+
+ + +
+ + + + + + + + +
Default value-1
Getter methodclapper_gtk_container_get_height_target()
Setter methodclapper_gtk_container_set_height_target()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableyes
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/property.Container.width-target.html b/doc/clapper-gtk/property.Container.width-target.html new file mode 100644 index 00000000..4afdcfc0 --- /dev/null +++ b/doc/clapper-gtk/property.Container.width-target.html @@ -0,0 +1,198 @@ + + + + + + ClapperGtk.Container:width-target + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperGtkContainer:width-target

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+ 
property width-target: int [ read, write ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Width that container should target.

+
+ +
+ + + + + + + +
Type:gint
+
+ + +
+ + + + + + + + +
Default value-1
Getter methodclapper_gtk_container_get_width_target()
Setter methodclapper_gtk_container_set_width_target()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableyes
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/property.LeadContainer.blocked-actions.html b/doc/clapper-gtk/property.LeadContainer.blocked-actions.html new file mode 100644 index 00000000..3271c165 --- /dev/null +++ b/doc/clapper-gtk/property.LeadContainer.blocked-actions.html @@ -0,0 +1,194 @@ + + + + + + ClapperGtk.LeadContainer:blocked-actions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperGtkLeadContainer:blocked-actions

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+ 
property blocked-actions: ClapperGtk.VideoActionMask [ read, write ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Mask of actions that container blocks from being triggered on video.

+
+ +
+ + + + + + + +
Type:ClapperGtkVideoActionMask
+
+ + +
+ + + + + + + + +
Default valueCLAPPER_GTK_VIDEO_ACTION_NONE
Getter methodclapper_gtk_lead_container_get_blocked_actions()
Setter methodclapper_gtk_lead_container_set_blocked_actions()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableyes
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/property.LeadContainer.leading.html b/doc/clapper-gtk/property.LeadContainer.leading.html new file mode 100644 index 00000000..ed106dcf --- /dev/null +++ b/doc/clapper-gtk/property.LeadContainer.leading.html @@ -0,0 +1,194 @@ + + + + + + ClapperGtk.LeadContainer:leading + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperGtkLeadContainer:leading

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+ 
property leading: gboolean [ read, write ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Width that container should target.

+
+ +
+ + + + + + + +
Type:gboolean
+
+ + +
+ + + + + + + + +
Default valueTRUE
Getter methodclapper_gtk_lead_container_get_leading()
Setter methodclapper_gtk_lead_container_set_leading()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableyes
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/property.ProgressBar.reveal-labels.html b/doc/clapper-gtk/property.ProgressBar.reveal-labels.html new file mode 100644 index 00000000..9621da46 --- /dev/null +++ b/doc/clapper-gtk/property.ProgressBar.reveal-labels.html @@ -0,0 +1,194 @@ + + + + + + ClapperGtk.ProgressBar:reveal-labels + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperGtkProgressBar:reveal-labels

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+ 
property reveal-labels: gboolean [ read, write ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Reveal state of the position and duration labels.

+
+ +
+ + + + + + + +
Type:gboolean
+
+ + +
+ + + + + + + + +
Default valueTRUE
Getter methodclapper_gtk_progress_bar_get_reveal_labels()
Setter methodclapper_gtk_progress_bar_set_reveal_labels()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableyes
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/property.ProgressBar.seek-method.html b/doc/clapper-gtk/property.ProgressBar.seek-method.html new file mode 100644 index 00000000..4fcf7e97 --- /dev/null +++ b/doc/clapper-gtk/property.ProgressBar.seek-method.html @@ -0,0 +1,194 @@ + + + + + + ClapperGtk.ProgressBar:seek-method + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperGtkProgressBar:seek-method

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+ 
property seek-method: Clapper.PlayerSeekMethod [ read, write ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Method used for seeking.

+
+ +
+ + + + + + + +
Type:ClapperPlayerSeekMethod
+
+ + +
+ + + + + + + + +
Default valueCLAPPER_PLAYER_SEEK_METHOD_NORMAL
Getter methodclapper_gtk_progress_bar_get_seek_method()
Setter methodclapper_gtk_progress_bar_set_seek_method()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableyes
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/property.QueueSelection.queue.html b/doc/clapper-gtk/property.QueueSelection.queue.html new file mode 100644 index 00000000..77294b97 --- /dev/null +++ b/doc/clapper-gtk/property.QueueSelection.queue.html @@ -0,0 +1,190 @@ + + + + + + ClapperGtk.QueueSelection:queue + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperGtkQueueSelection:queue

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+ 
property queue: Clapper.Queue [ read, write ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

The queue being managed.

+
+ +
+ + + + + + + +
Type:ClapperQueue
+
+ + +
+ + + + + + +
Getter methodclapper_gtk_queue_selection_get_queue()
Setter methodclapper_gtk_queue_selection_set_queue()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableyes
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/property.SimpleControls.fullscreenable.html b/doc/clapper-gtk/property.SimpleControls.fullscreenable.html new file mode 100644 index 00000000..9920754d --- /dev/null +++ b/doc/clapper-gtk/property.SimpleControls.fullscreenable.html @@ -0,0 +1,194 @@ + + + + + + ClapperGtk.SimpleControls:fullscreenable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperGtkSimpleControls:fullscreenable

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+ 
property fullscreenable: gboolean [ read, write ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Whether toggle fullscreen button should be visible.

+
+ +
+ + + + + + + +
Type:gboolean
+
+ + +
+ + + + + + + + +
Default valueTRUE
Getter methodclapper_gtk_simple_controls_get_fullscreenable()
Setter methodclapper_gtk_simple_controls_set_fullscreenable()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableyes
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/property.SimpleControls.seek-method.html b/doc/clapper-gtk/property.SimpleControls.seek-method.html new file mode 100644 index 00000000..773cc12e --- /dev/null +++ b/doc/clapper-gtk/property.SimpleControls.seek-method.html @@ -0,0 +1,194 @@ + + + + + + ClapperGtk.SimpleControls:seek-method + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperGtkSimpleControls:seek-method

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+ 
property seek-method: Clapper.PlayerSeekMethod [ read, write ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Method used for seeking.

+
+ +
+ + + + + + + +
Type:ClapperPlayerSeekMethod
+
+ + +
+ + + + + + + + +
Default valueCLAPPER_PLAYER_SEEK_METHOD_NORMAL
Getter methodclapper_gtk_simple_controls_get_seek_method()
Setter methodclapper_gtk_simple_controls_set_seek_method()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableyes
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/property.Video.auto-inhibit.html b/doc/clapper-gtk/property.Video.auto-inhibit.html new file mode 100644 index 00000000..aba7c216 --- /dev/null +++ b/doc/clapper-gtk/property.Video.auto-inhibit.html @@ -0,0 +1,200 @@ + + + + + + ClapperGtk.Video:auto-inhibit + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperGtkVideo:auto-inhibit

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+ 
property auto-inhibit: gboolean [ read, write ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Try to automatically inhibit session when video is playing.

+
+ +
+ + + + + + + +
Type:gboolean
+
+ + +
+ + + + + + + + +
Default valueFALSE
Getter methodclapper_gtk_video_get_auto_inhibit()
Setter methodclapper_gtk_video_set_auto_inhibit()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableyes
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/property.Video.fade-delay.html b/doc/clapper-gtk/property.Video.fade-delay.html new file mode 100644 index 00000000..3cfdd1eb --- /dev/null +++ b/doc/clapper-gtk/property.Video.fade-delay.html @@ -0,0 +1,198 @@ + + + + + + ClapperGtk.Video:fade-delay + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperGtkVideo:fade-delay

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+ 
property fade-delay: guint [ read ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

A delay in milliseconds before trying to fade all fading overlays.

+
+ +
+ + + + + + + +
Type:guint
+
+ + +
+ + + + + + +
Default value3000
Getter methodclapper_gtk_video_get_fade_delay()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableno
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/property.Video.inhibited.html b/doc/clapper-gtk/property.Video.inhibited.html new file mode 100644 index 00000000..bd5b31b9 --- /dev/null +++ b/doc/clapper-gtk/property.Video.inhibited.html @@ -0,0 +1,198 @@ + + + + + + ClapperGtk.Video:inhibited + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperGtkVideo:inhibited

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+ 
property inhibited: gboolean [ read ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get whether session is currently inhibited by the video.

+
+ +
+ + + + + + + +
Type:gboolean
+
+ + +
+ + + + + + +
Default valueFALSE
Getter methodclapper_gtk_video_get_inhibited()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableno
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/property.Video.player.html b/doc/clapper-gtk/property.Video.player.html new file mode 100644 index 00000000..89bf8188 --- /dev/null +++ b/doc/clapper-gtk/property.Video.player.html @@ -0,0 +1,196 @@ + + + + + + ClapperGtk.Video:player + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperGtkVideo:player

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+ 
property player: Clapper.Player [ read ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

A ClapperPlayer used by video.

+
+ +
+ + + + + + + +
Type:ClapperPlayer
+
+ + +
+ + + + +
Getter methodclapper_gtk_video_get_player()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableno
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/property.Video.touch-fade-delay.html b/doc/clapper-gtk/property.Video.touch-fade-delay.html new file mode 100644 index 00000000..ab3da836 --- /dev/null +++ b/doc/clapper-gtk/property.Video.touch-fade-delay.html @@ -0,0 +1,199 @@ + + + + + + ClapperGtk.Video:touch-fade-delay + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperGtkVideo:touch-fade-delay

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+ 
property touch-fade-delay: guint [ read ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

A delay in milliseconds before trying to fade all fading overlays +after revealed using touchscreen.

+
+ +
+ + + + + + + +
Type:guint
+
+ + +
+ + + + + + +
Default value5000
Getter methodclapper_gtk_video_get_touch_fade_delay()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableno
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/search.js b/doc/clapper-gtk/search.js new file mode 100644 index 00000000..29c204f9 --- /dev/null +++ b/doc/clapper-gtk/search.js @@ -0,0 +1,417 @@ +// SPDX-FileCopyrightText: 2021 GNOME Foundation +// +// SPDX-License-Identifier: Apache-2.0 OR GPL-3.0-or-later + +(function() { + +const QUERY_TYPES = [ + "alias", + "bitfield", + "callback", + "class", + "constant", + "content", + "ctor", + "domain", + "enum", + "function_macro", + "function", + "interface", + "method", + "property", + "record", + "signal", + "type_func", + "union", + "vfunc", +]; +const QUERY_PATTERN = new RegExp("^(" + QUERY_TYPES.join('|') + ")\\s*:\\s*", 'i'); + +const TYPE_NAMES = { + "alias": "alias", + "bitfield": "flags", + "callback": "callback", + "class": "class", + "constant": "constant", + "content": "content", + "ctor": "constructor", + "domain": "error", + "enum": "enum", + "function_macro": "macro", + "function": "function", + "interface": "interface", + "method": "method", + "property": "property", + "record": "struct", + "signal": "signal", + "type_func": "function", + "union": "union", + "vfunc": "vfunc", +}; + +const TYPE_CLASSES = { + "alias": "alias", + "bitfield": "flags", + "callback": "callback", + "class": "class", + "constant": "constant", + "content": "extra_content", + "ctor": "ctor", + "domain": "domain", + "enum": "enum", + "function_macro": "function_macro", + "function": "function", + "interface": "interface", + "method": "method", + "property": "property", + "record": "record", + "signal": "signal", + "type_func": "type_func", + "union": "union", + "vfunc": "vfunc", +}; + +const fzy = window.fzy; +const searchParams = getSearchParams(); +const refs = { + input: null, + form: null, + search: null, + main: null, + toc: null, +}; + +let searchIndex = undefined; +let searchResults = []; + +// Exports +window.onInitSearch = onInitSearch; + +/* Event handlers */ + +function onInitSearch() { + fetchJSON('index.json', onDidLoadSearchIndex); +} + +function onDidLoadSearchIndex(data) { + searchIndex = new SearchIndex(data) + + refs.input = document.querySelector("#search-input"); + refs.form = document.querySelector("#search-form"); + refs.search = document.querySelector("#search"); + refs.main = document.querySelector("#main"); + refs.toc = document.querySelector("#toc"); + + attachInputHandlers(); + + if (searchParams.q) { + search(searchParams.q); + } +} + +function getNakedUrl() { + return window.location.href.split("?")[0].split("#")[0]; +} + +function onDidSearch() { + const query = refs.input.value; + if (query) { + search(query); + } + else { + hideSearchResults(); + } +} + +function onDidSubmit(ev) { + ev.preventDefault(); + if (searchResults.length == 1) { + window.location.href = searchResults[0].href; + } +} + +function attachInputHandlers() { + if (refs.input.value === "") { + refs.input.value === searchParams.q || ""; + } + + refs.input.addEventListener('keyup', debounce(500, onDidSearch)) + refs.form.addEventListener('submit', onDidSubmit) +} + +/* Searching */ + +function searchQuery(query) { + const q = matchQuery(query); + const docs = searchIndex.searchDocs(q.term, q.type); + + const results = docs.map(function(doc) { + return { + name: doc.name, + type: doc.type, + text: getLabelForDocument(doc, searchIndex.meta), + href: getLinkForDocument(doc), + summary: doc.summary, + deprecated: doc.deprecated, + }; + }); + + return results; +} + +function search(query) { + searchResults = searchQuery(query) + showResults(query, searchResults); +} + +/* Rendering */ + +function showSearchResults() { + addClass(refs.main, "hidden"); + if (refs.toc) { + addClass(refs.toc, "hidden"); + } + removeClass(refs.search, "hidden"); +} + +function hideSearchResults() { + addClass(refs.search, "hidden"); + removeClass(refs.main, "hidden"); + if (refs.toc) { + removeClass(refs.toc, "hidden"); + } +} + +function renderResults(query, results) { + let html = ""; + + html += "

Results for "" + query + "" (" + results.length + ")

" + + "
" + + if (results.length === 0) { + html += "No results found."; + } + else { + html += "
"; + results.forEach(function(item) { + html += "
" + + "" + item.text + "" + + " " + TYPE_NAMES[item.type] + ""; + if (item.deprecated) { + html += " deprecated: " + item.deprecated + ""; + } + html += "
" + + "
" + item.summary + "
"; + }); + html += "
"; + } + + html += "
"; + + return html; +} + +function showResults(query, results) { + if (window.history && typeof window.history.pushState === "function") { + let baseUrl = getNakedUrl(); + let extra = "?q=" + encodeURIComponent(refs.input.value); + window.history.replaceState(refs.input.value, "", baseUrl + extra + window.location.hash); + } + + window.title = "Results for: " + query; + window.scroll({ top: 0 }) + refs.search.innerHTML = renderResults(query, results); + showSearchResults(search); +} + + +/* Search data instance */ + +function SearchIndex(searchIndex) { + this.symbols = searchIndex.symbols; + this.meta = searchIndex.meta; +} +SearchIndex.prototype.searchDocs = function searchDocs(term, type) { + const filteredSymbols = !type ? + this.symbols : + this.symbols.filter(s => s.type === type); + const results = fzy.filter(term, filteredSymbols, doc => getTextForDocument(doc, this.meta)) + return results.map(i => i.item) +} + + +/* Search metadata selectors */ + +function getLinkForDocument(doc) { + switch (doc.type) { + case "alias": return "alias." + doc.name + ".html"; + case "bitfield": return "flags." + doc.name + ".html"; + case "callback": return "callback." + doc.name + ".html"; + case "class": return "class." + doc.name + ".html"; + case "class_method": return "class_method." + doc.struct_for + "." + doc.name + ".html"; + case "constant": return "const." + doc.name + ".html"; + case "content": return doc.href; + case "ctor": return "ctor." + doc.type_name + "." + doc.name + ".html"; + case "domain": return "error." + doc.name + ".html"; + case "enum": return "enum." + doc.name + ".html"; + case "function": return "func." + doc.name + ".html"; + case "function_macro": return "func." + doc.name + ".html"; + case "interface": return "iface." + doc.name + ".html"; + case "method": return "method." + doc.type_name + "." + doc.name + ".html"; + case "property": return "property." + doc.type_name + "." + doc.name + ".html"; + case "record": return "struct." + doc.name + ".html"; + case "signal": return "signal." + doc.type_name + "." + doc.name + ".html"; + case "type_func": return "type_func." + doc.type_name + "." + doc.name + ".html"; + case "union": return "union." + doc.name + ".html"; + case "vfunc": return "vfunc." + doc.type_name + "." + doc.name + ".html"; + } + return null; +} + +function getLabelForDocument(doc, meta) { + switch (doc.type) { + case "alias": + case "bitfield": + case "callback": + case "class": + case "domain": + case "enum": + case "interface": + case "record": + case "union": + return "" + doc.ctype + ""; + + case "class_method": + case "constant": + case "ctor": + case "function": + case "function_macro": + case "method": + case "type_func": + return "" + doc.ident + ""; + + // NOTE: meta.ns added for more consistent results, otherwise + // searching for "Button" would return all signals, properties + // and vfuncs (eg "Button.clicked") before the actual object + // (eg "GtkButton") because "Button" matches higher with starting + // sequences. + case "property": + return "" + meta.ns + doc.type_name + ":" + doc.name + ""; + case "signal": + return "" + meta.ns + doc.type_name + "::" + doc.name + ""; + case "vfunc": + return "" + meta.ns + doc.type_name + "." + doc.name + ""; + + case "content": + return doc.name; + } + + return null; +} + +function getTextForDocument(doc, meta) { + switch (doc.type) { + case "alias": + case "bitfield": + case "callback": + case "class": + case "domain": + case "enum": + case "interface": + case "record": + case "union": + return doc.ctype; + + case "class_method": + case "constant": + case "ctor": + case "function": + case "function_macro": + case "method": + case "type_func": + return doc.ident; + + // NOTE: meta.ns added for more consistent results, otherwise + // searching for "Button" would return all signals, properties + // and vfuncs (eg "Button.clicked") before the actual object + // (eg "GtkButton") because "Button" matches higher with starting + // sequences. + case "property": + return meta.ns + doc.type_name + ":" + doc.name; + case "signal": + return meta.ns + doc.type_name + "::" + doc.name; + case "vfunc": + return meta.ns + doc.type_name + "." + doc.name; + + case "content": + return doc.name; + } + + return null; +} + + +// Helpers + +function fetchJSON(url, callback) { + const request = new XMLHttpRequest(); + request.open('GET', url, true); + request.onreadystatechange = function() { + if (request.readyState === XMLHttpRequest.DONE) { + const status = request.status; + + if (status === 0 || (status >= 200 && status < 400)) { + callback(JSON.parse(request.responseText)); + } + } + } + request.send(null); +} + +function getSearchParams() { + const params = {}; + window.location.search.substring(1).split('&') + .map(function(s) { + const pair = s.split('='); + params[decodeURIComponent(pair[0])] = + typeof pair[1] === 'undefined' ? null : decodeURIComponent(pair[1].replace(/\+/g, '%20')); + }); + return params; +} + +function matchQuery(input) { + let type = null + let term = input + + const matches = term.match(QUERY_PATTERN); + if (matches) { + type = matches[1]; + term = term.substring(matches[0].length); + } + + // Remove all spaces, fzy will handle things gracefully. + term = term.replace(/\s+/g, '') + + return { type: type, term: term } +} + +function debounce(delay, fn) { + let timeout; + let savedArgs + + return function() { + const self = this; + savedArgs = Array.prototype.slice.call(arguments); + + if (timeout) { + clearTimeout(timeout); + } + + timeout = setTimeout(function() { + fn.apply(self, savedArgs) + timeout = undefined + }, delay) + } +} + +})() diff --git a/doc/clapper-gtk/signal.Container.adapt.html b/doc/clapper-gtk/signal.Container.adapt.html new file mode 100644 index 00000000..f6f06d9d --- /dev/null +++ b/doc/clapper-gtk/signal.Container.adapt.html @@ -0,0 +1,214 @@ + + + + + + ClapperGtk.Container::adapt + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Signal

+

ClapperGtkContainer::adapt

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+ 
void
+adapt (
+  ClapperGtkContainer* self,
+  gboolean adapt,
+  gpointer user_data
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

A helper signal for implementing mobile/narrow adaptive +behavior on descendants.

+
+ +
+ + + + + + + + + + + + + +
Default handler:

The default handler is called after the handlers added via g_signal_connect().

Signal emission will restart instead of recursing
Hooks are disabled for this signal
+
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
adapt
+
+

Type: gboolean

+

TRUE if narrowness reached adaptive threshold, FALSE otherwise.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/signal.QueueSelection.item-query.html b/doc/clapper-gtk/signal.QueueSelection.item-query.html new file mode 100644 index 00000000..02aec1e0 --- /dev/null +++ b/doc/clapper-gtk/signal.QueueSelection.item-query.html @@ -0,0 +1,217 @@ + + + + + + ClapperGtk.QueueSelection::item-query + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Signal

+

ClapperGtkQueueSelection::item-query

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+ 
void
+item_query (
+  ClapperGtkQueueSelection* self,
+  guint index,
+  gpointer user_data
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Signals when the GtkSelectionModel is doing item query.

+

Can be used to know that a widget is created for this item +and its currently being checked by this selection owner.

+
+ +
+ + + + + + + + + + + + + +
Default handler:

The default handler is called after the handlers added via g_signal_connect().

Signal emission will restart instead of recursing
Hooks are disabled for this signal
+
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
index
+
+

Type: guint

+

An index of queried item.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/signal.QueueSelection.item-selected.html b/doc/clapper-gtk/signal.QueueSelection.item-selected.html new file mode 100644 index 00000000..2293ddae --- /dev/null +++ b/doc/clapper-gtk/signal.QueueSelection.item-selected.html @@ -0,0 +1,221 @@ + + + + + + ClapperGtk.QueueSelection::item-selected + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Signal

+

ClapperGtkQueueSelection::item-selected

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+ 
void
+item_selected (
+  ClapperGtkQueueSelection* self,
+  guint index,
+  gpointer user_data
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Signals when user selected item within the GtkSelectionModel. +Note that this signal is emitted only when item gets selected from +the GTK side. If item was changed internally by e.g. ClapperQueue +progression, this signal will not be emitted.

+

This signal is useful if you need to differentiate what caused item +selection, otherwise use either SelectionModel::selection-changed +signal or listen for changes of ClapperQueue:current-item.

+
+ +
+ + + + + + + + + + + + + +
Default handler:

The default handler is called after the handlers added via g_signal_connect().

Signal emission will restart instead of recursing
Hooks are disabled for this signal
+
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
index
+
+

Type: guint

+

An index of selected item.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/signal.Video.toggle-fullscreen.html b/doc/clapper-gtk/signal.Video.toggle-fullscreen.html new file mode 100644 index 00000000..6e1c318b --- /dev/null +++ b/doc/clapper-gtk/signal.Video.toggle-fullscreen.html @@ -0,0 +1,182 @@ + + + + + + ClapperGtk.Video::toggle-fullscreen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Signal

+

ClapperGtkVideo::toggle-fullscreen

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+ 
void
+toggle_fullscreen (
+  ClapperGtkVideo* self,
+  gpointer user_data
+)
+

+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

A signal that user requested a change in fullscreen state of the video.

+

Note that when going fullscreen user will expect for only video to be fullscreened +and not the whole app window. It is up to implementation to decide how to handle that.

+
+ +
+ + + + + + + + + + + + + +
Default handler:

The default handler is called after the handlers added via g_signal_connect().

Signal emission will restart instead of recursing
Hooks are disabled for this signal
+
+ + +
+ + + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/solarized-dark.css b/doc/clapper-gtk/solarized-dark.css new file mode 100644 index 00000000..2edc59b8 --- /dev/null +++ b/doc/clapper-gtk/solarized-dark.css @@ -0,0 +1,88 @@ +/* + * SPDX-FileCopyrightText: 2014 John Louis Del Rosario, Hank Gay, John Mastro, Brandon Bennett + * SPDX-License-Identifier: MIT + */ + +pre { line-height: 125%; } +td.linenos pre { color: #586e75; background-color: #073642; padding-left: 5px; padding-right: 5px; } +span.linenos { color: #586e75; background-color: #073642; padding-left: 5px; padding-right: 5px; } +td.linenos pre.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.codehilite .hll { background-color: #073642 } +.codehilite { background: #002b36; color: #839496 } +.codehilite .c { color: #586e75; font-style: italic } /* Comment */ +.codehilite .err { color: #839496; background-color: #dc322f } /* Error */ +.codehilite .esc { color: #839496 } /* Escape */ +.codehilite .g { color: #839496 } /* Generic */ +.codehilite .k { color: #859900 } /* Keyword */ +.codehilite .l { color: #839496 } /* Literal */ +.codehilite .n { color: #839496 } /* Name */ +.codehilite .o { color: #586e75 } /* Operator */ +.codehilite .x { color: #839496 } /* Other */ +.codehilite .p { color: #839496 } /* Punctuation */ +.codehilite .ch { color: #586e75; font-style: italic } /* Comment.Hashbang */ +.codehilite .cm { color: #586e75; font-style: italic } /* Comment.Multiline */ +.codehilite .cp { color: #d33682 } /* Comment.Preproc */ +.codehilite .cpf { color: #586e75 } /* Comment.PreprocFile */ +.codehilite .c1 { color: #586e75; font-style: italic } /* Comment.Single */ +.codehilite .cs { color: #586e75; font-style: italic } /* Comment.Special */ +.codehilite .gd { color: #dc322f } /* Generic.Deleted */ +.codehilite .ge { color: #839496; font-style: italic } /* Generic.Emph */ +.codehilite .gr { color: #dc322f } /* Generic.Error */ +.codehilite .gh { color: #839496; font-weight: bold } /* Generic.Heading */ +.codehilite .gi { color: #859900 } /* Generic.Inserted */ +.codehilite .go { color: #839496 } /* Generic.Output */ +.codehilite .gp { color: #839496 } /* Generic.Prompt */ +.codehilite .gs { color: #839496; font-weight: bold } /* Generic.Strong */ +.codehilite .gu { color: #839496; text-decoration: underline } /* Generic.Subheading */ +.codehilite .gt { color: #268bd2 } /* Generic.Traceback */ +.codehilite .kc { color: #2aa198 } /* Keyword.Constant */ +.codehilite .kd { color: #2aa198 } /* Keyword.Declaration */ +.codehilite .kn { color: #cb4b16 } /* Keyword.Namespace */ +.codehilite .kp { color: #859900 } /* Keyword.Pseudo */ +.codehilite .kr { color: #859900 } /* Keyword.Reserved */ +.codehilite .kt { color: #b58900 } /* Keyword.Type */ +.codehilite .ld { color: #839496 } /* Literal.Date */ +.codehilite .m { color: #2aa198 } /* Literal.Number */ +.codehilite .s { color: #2aa198 } /* Literal.String */ +.codehilite .na { color: #839496 } /* Name.Attribute */ +.codehilite .nb { color: #268bd2 } /* Name.Builtin */ +.codehilite .nc { color: #268bd2 } /* Name.Class */ +.codehilite .no { color: #268bd2 } /* Name.Constant */ +.codehilite .nd { color: #268bd2 } /* Name.Decorator */ +.codehilite .ni { color: #268bd2 } /* Name.Entity */ +.codehilite .ne { color: #268bd2 } /* Name.Exception */ +.codehilite .nf { color: #268bd2 } /* Name.Function */ +.codehilite .nl { color: #268bd2 } /* Name.Label */ +.codehilite .nn { color: #268bd2 } /* Name.Namespace */ +.codehilite .nx { color: #839496 } /* Name.Other */ +.codehilite .py { color: #839496 } /* Name.Property */ +.codehilite .nt { color: #268bd2 } /* Name.Tag */ +.codehilite .nv { color: #268bd2 } /* Name.Variable */ +.codehilite .ow { color: #859900 } /* Operator.Word */ +.codehilite .w { color: #839496 } /* Text.Whitespace */ +.codehilite .mb { color: #2aa198 } /* Literal.Number.Bin */ +.codehilite .mf { color: #2aa198 } /* Literal.Number.Float */ +.codehilite .mh { color: #2aa198 } /* Literal.Number.Hex */ +.codehilite .mi { color: #2aa198 } /* Literal.Number.Integer */ +.codehilite .mo { color: #2aa198 } /* Literal.Number.Oct */ +.codehilite .sa { color: #2aa198 } /* Literal.String.Affix */ +.codehilite .sb { color: #2aa198 } /* Literal.String.Backtick */ +.codehilite .sc { color: #2aa198 } /* Literal.String.Char */ +.codehilite .dl { color: #2aa198 } /* Literal.String.Delimiter */ +.codehilite .sd { color: #586e75 } /* Literal.String.Doc */ +.codehilite .s2 { color: #2aa198 } /* Literal.String.Double */ +.codehilite .se { color: #2aa198 } /* Literal.String.Escape */ +.codehilite .sh { color: #2aa198 } /* Literal.String.Heredoc */ +.codehilite .si { color: #2aa198 } /* Literal.String.Interpol */ +.codehilite .sx { color: #2aa198 } /* Literal.String.Other */ +.codehilite .sr { color: #cb4b16 } /* Literal.String.Regex */ +.codehilite .s1 { color: #2aa198 } /* Literal.String.Single */ +.codehilite .ss { color: #2aa198 } /* Literal.String.Symbol */ +.codehilite .bp { color: #268bd2 } /* Name.Builtin.Pseudo */ +.codehilite .fm { color: #268bd2 } /* Name.Function.Magic */ +.codehilite .vc { color: #268bd2 } /* Name.Variable.Class */ +.codehilite .vg { color: #268bd2 } /* Name.Variable.Global */ +.codehilite .vi { color: #268bd2 } /* Name.Variable.Instance */ +.codehilite .vm { color: #268bd2 } /* Name.Variable.Magic */ +.codehilite .il { color: #2aa198 } /* Literal.Number.Integer.Long */ diff --git a/doc/clapper-gtk/solarized-light.css b/doc/clapper-gtk/solarized-light.css new file mode 100644 index 00000000..f1fa80f7 --- /dev/null +++ b/doc/clapper-gtk/solarized-light.css @@ -0,0 +1,88 @@ +/* + * SPDX-FileCopyrightText: 2014 John Louis Del Rosario, Hank Gay, John Mastro, Brandon Bennett + * SPDX-License-Identifier: MIT + */ + +pre { line-height: 125%; } +td.linenos pre { color: #93a1a1; background-color: #eee8d5; padding-left: 5px; padding-right: 5px; } +span.linenos { color: #93a1a1; background-color: #eee8d5; padding-left: 5px; padding-right: 5px; } +td.linenos pre.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.codehilite .hll { background-color: #eee8d5 } +.codehilite { background: #fdf6e3; color: #657b83 } +.codehilite .c { color: #93a1a1; font-style: italic } /* Comment */ +.codehilite .err { color: #657b83; background-color: #dc322f } /* Error */ +.codehilite .esc { color: #657b83 } /* Escape */ +.codehilite .g { color: #657b83 } /* Generic */ +.codehilite .k { color: #859900 } /* Keyword */ +.codehilite .l { color: #657b83 } /* Literal */ +.codehilite .n { color: #657b83 } /* Name */ +.codehilite .o { color: #93a1a1 } /* Operator */ +.codehilite .x { color: #657b83 } /* Other */ +.codehilite .p { color: #657b83 } /* Punctuation */ +.codehilite .ch { color: #93a1a1; font-style: italic } /* Comment.Hashbang */ +.codehilite .cm { color: #93a1a1; font-style: italic } /* Comment.Multiline */ +.codehilite .cp { color: #d33682 } /* Comment.Preproc */ +.codehilite .cpf { color: #93a1a1 } /* Comment.PreprocFile */ +.codehilite .c1 { color: #93a1a1; font-style: italic } /* Comment.Single */ +.codehilite .cs { color: #93a1a1; font-style: italic } /* Comment.Special */ +.codehilite .gd { color: #dc322f } /* Generic.Deleted */ +.codehilite .ge { color: #657b83; font-style: italic } /* Generic.Emph */ +.codehilite .gr { color: #dc322f } /* Generic.Error */ +.codehilite .gh { color: #657b83; font-weight: bold } /* Generic.Heading */ +.codehilite .gi { color: #859900 } /* Generic.Inserted */ +.codehilite .go { color: #657b83 } /* Generic.Output */ +.codehilite .gp { color: #657b83 } /* Generic.Prompt */ +.codehilite .gs { color: #657b83; font-weight: bold } /* Generic.Strong */ +.codehilite .gu { color: #657b83; text-decoration: underline } /* Generic.Subheading */ +.codehilite .gt { color: #268bd2 } /* Generic.Traceback */ +.codehilite .kc { color: #2aa198 } /* Keyword.Constant */ +.codehilite .kd { color: #2aa198 } /* Keyword.Declaration */ +.codehilite .kn { color: #cb4b16 } /* Keyword.Namespace */ +.codehilite .kp { color: #859900 } /* Keyword.Pseudo */ +.codehilite .kr { color: #859900 } /* Keyword.Reserved */ +.codehilite .kt { color: #b58900 } /* Keyword.Type */ +.codehilite .ld { color: #657b83 } /* Literal.Date */ +.codehilite .m { color: #2aa198 } /* Literal.Number */ +.codehilite .s { color: #2aa198 } /* Literal.String */ +.codehilite .na { color: #657b83 } /* Name.Attribute */ +.codehilite .nb { color: #268bd2 } /* Name.Builtin */ +.codehilite .nc { color: #268bd2 } /* Name.Class */ +.codehilite .no { color: #268bd2 } /* Name.Constant */ +.codehilite .nd { color: #268bd2 } /* Name.Decorator */ +.codehilite .ni { color: #268bd2 } /* Name.Entity */ +.codehilite .ne { color: #268bd2 } /* Name.Exception */ +.codehilite .nf { color: #268bd2 } /* Name.Function */ +.codehilite .nl { color: #268bd2 } /* Name.Label */ +.codehilite .nn { color: #268bd2 } /* Name.Namespace */ +.codehilite .nx { color: #657b83 } /* Name.Other */ +.codehilite .py { color: #657b83 } /* Name.Property */ +.codehilite .nt { color: #268bd2 } /* Name.Tag */ +.codehilite .nv { color: #268bd2 } /* Name.Variable */ +.codehilite .ow { color: #859900 } /* Operator.Word */ +.codehilite .w { color: #657b83 } /* Text.Whitespace */ +.codehilite .mb { color: #2aa198 } /* Literal.Number.Bin */ +.codehilite .mf { color: #2aa198 } /* Literal.Number.Float */ +.codehilite .mh { color: #2aa198 } /* Literal.Number.Hex */ +.codehilite .mi { color: #2aa198 } /* Literal.Number.Integer */ +.codehilite .mo { color: #2aa198 } /* Literal.Number.Oct */ +.codehilite .sa { color: #2aa198 } /* Literal.String.Affix */ +.codehilite .sb { color: #2aa198 } /* Literal.String.Backtick */ +.codehilite .sc { color: #2aa198 } /* Literal.String.Char */ +.codehilite .dl { color: #2aa198 } /* Literal.String.Delimiter */ +.codehilite .sd { color: #93a1a1 } /* Literal.String.Doc */ +.codehilite .s2 { color: #2aa198 } /* Literal.String.Double */ +.codehilite .se { color: #2aa198 } /* Literal.String.Escape */ +.codehilite .sh { color: #2aa198 } /* Literal.String.Heredoc */ +.codehilite .si { color: #2aa198 } /* Literal.String.Interpol */ +.codehilite .sx { color: #2aa198 } /* Literal.String.Other */ +.codehilite .sr { color: #cb4b16 } /* Literal.String.Regex */ +.codehilite .s1 { color: #2aa198 } /* Literal.String.Single */ +.codehilite .ss { color: #2aa198 } /* Literal.String.Symbol */ +.codehilite .bp { color: #268bd2 } /* Name.Builtin.Pseudo */ +.codehilite .fm { color: #268bd2 } /* Name.Function.Magic */ +.codehilite .vc { color: #268bd2 } /* Name.Variable.Class */ +.codehilite .vg { color: #268bd2 } /* Name.Variable.Global */ +.codehilite .vi { color: #268bd2 } /* Name.Variable.Instance */ +.codehilite .vm { color: #268bd2 } /* Name.Variable.Magic */ +.codehilite .il { color: #2aa198 } /* Literal.Number.Integer.Long */ diff --git a/doc/clapper-gtk/style.css b/doc/clapper-gtk/style.css new file mode 100644 index 00000000..5d3ff742 --- /dev/null +++ b/doc/clapper-gtk/style.css @@ -0,0 +1,1042 @@ +/* + * SPDX-FileCopyrightText: 2021 GNOME Foundation + * + * SPDX-License-Identifier: Apache-2.0 OR GPL-3.0-or-later + */ + +@import url("solarized-light.css") (prefers-color-scheme: light); +@import url("solarized-dark.css") (prefers-color-scheme: dark); + +@import url("fonts.css"); + +/********************************* + * LIGHT THEME + *********************************/ +:root { + + /* colors */ + --text-color: rgb(51, 51, 51); + --text-color-muted: rgba(51, 51, 51, 0.65); + --primary: rgb(28, 118, 228); + --body-bg: #fff; + --sidebar-primary: rgb(144, 194, 255); + --sidebar-bg: #151515; + --sidebar-selected-bg: var(--primary); + --sidebar-hover-bg: rgba(127, 127, 127, 0.2); + --sidebar-text-color: #fafafa; + --sidebar-search-bg: rgba(127, 127, 127, 0.25); + --sidebar-search-focus-bg: rgba(127, 127, 127, 0.3); + --sidebar-padding: 1.5em; + --warning-bg-color: #e5a50a; + --warning-fg-color: rgba(0, 0, 0, 0.8); + --error-bg-color: #e01b24; + --error-fg-color: #ffffff; + --accent-bg-color: #3584e4; + --accent-fg-color: #ffffff; + + /* boxes, e.g. code blocks */ + --box-bg: rgba(135, 135, 135, 0.085); + --box-radius: 0.35rem; + --box-padding: 0.75rem; + --box-margin: 0.75rem 0; + --box-text-color: #111; + + /* typography */ + --body-font-family: "Red Hat Text",-apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji"; + --body-font-scale: 0.95; + --body-font-size: calc(var(--body-font-scale) * clamp(16px, 1vw, 18px)); + --body-font-weight: normal; + + --monospace-font-family: "Source Code Pro", monospace; + --monospace-font-size: calc(0.86 * var(--body-font-size)); /* Monospace fonts are very different in terms of font-sizes. Adjust this value to scale it */ + + --heading-font-family: "Red Hat Display", var(--body-font-family); + --heading-weight: 900; + --heading-font-scale: 1.05; + + --heading-small-font-family: var(--heading-font-family); + --heading-small-weight: 600; + --heading-small-font-scale: 1; + + --heading-table-font-family: var(--heading-font-family); + --heading-table-weight: 600; + + --heading-docblock-color: #6d6d6d; /* docblocks have headings from source comments. we want them to differ.*/ + --heading-docblock-scale: 0.9; /* docblocks have headings from source comments. we want them to differ.*/ + + --symbol-font-family: var(--heading-font-family); + --symbol-font-weight: 500; + --symbol-font-scale: 1; + + --table-font-size: 0.92em; /* Tables often contain lots information. It's better to scale them down a big to get more sutff fitted inside */ + + --admonition-color-bg: transparent; + --admonition-font-size: 0.9rem; + --admonition-color-title--note: #00b0ff; + --admonition-color-title-bg--note: rgba(0, 176, 255, 0.1); + --admonition-color-title--important: #00bfa5; + --admonition-color-title-bg--important: rgba(0, 191, 165, 0.1); + --admonition-color-title--tip: #00c852; + --admonition-color-title-bg--tip: rgba(0, 200, 82, 0.1); + --admonition-color-title--warning: #ff9100; + --admonition-color-title-bg--warning: rgba(255, 145, 0, 0.1); + + --admonition-icon--note: url('data:image/svg+xml;charset=utf-8,'); + --admonition-icon--important: url('data:image/svg+xml;charset=utf-8,'); + --admonition-icon--tip: url('data:image/svg+xml;charset=utf-8,'); + --admonition-icon--warning: url('data:image/svg+xml;charset=utf-8,'); + + /* misc */ + --preferred-content-width: 90ch; /* The preferred width for the readable content */ + --anchor-sign: "#"; + +} + +/********************************* + * DARK THEME (overrides) + *********************************/ + @media (prefers-color-scheme: dark) { + :root { + --primary: rgb(144, 194, 255); + --text-color: #f6f6f6; + --text-color-muted: #686868; + --body-bg: #121212; + --sidebar-primary: rgb(144, 194, 255); + --sidebar-bg: #1e1e1e; + --sidebar-selected-bg: rgb(17, 112, 228); + --sidebar-text-color: #fafafa; + --box-bg: rgba(135, 135, 135, 0.1); + --box-text-color: #fff; + --heading-docblock-color: #b7b7b7; + --warning-bg-color: #cd9309; + --warning-fg-color: rgba(0, 0, 0, 0.8); + --error-bg-color: #c01c28; + --error-fg-color: #ffffff; + --accent-bg-color: #3584e4; + --accent-fg-color: #ffffff; + color-scheme: dark; + } +} + +/********************************* + * GENERAL STYLING + *********************************/ +*, +*:before, +*:after { + box-sizing: border-box; +} + +::-moz-selection { + color: white; + background: var(--primary); +} + +::selection { + color: white; + background: var(--primary); +} + +body { + font: 16px/1.5 var(--body-font-family); + font-weight: var(--body-font-weight); + font-size: var(--body-font-size); + margin: 0; + padding: 0; + position: relative; + + -webkit-font-feature-settings: "kern", "liga"; + -moz-font-feature-settings: "kern", "liga"; + font-feature-settings: "kern", "liga"; + color: var(--text-color); + background: var(--body-bg); +} + +h1, h2, h3, h4, h5, h6 { + font-family: var(--heading-font-family); + font-weight: var(--heading-weight); + margin: 1.75em 0 0.75em 0; +} + +h1 { + font-size: calc(1.75em * var(--heading-font-scale)); +} + + +header h1 { + margin-top: 0; +} + +h2 { + font-size: calc(1.4em * var(--heading-font-scale)); +} + +h3 { + font-size: calc(1.2em * var(--heading-font-scale)); +} + +header h3 { + color: var(--text-color-muted); + margin-bottom: 0; +} + +h4, h5 { + font-size: calc(1em * var(--heading-font-scale)); +} + +h6 { + font-size: calc(1em * var(--heading-small-font-scale)); + font-family: var(--heading-small-font-family); + font-weight: var(--heading-small-weight); +} + +ol, ul { + padding-left: 1rem; +} + +ul ul, ol ul, ul ol, ol ol { + margin-bottom: .6em; +} + +p { + margin: 0 0 .6em 0; +} + +a { + color: var(--primary); + text-decoration: none; +} + +a:hover { + text-decoration: underline; +} + +summary { + outline: none; +} + +blockquote { + border-left: 3px solid var(--primary); + background: var(--box-bg); + padding: var(--box-padding); + border-radius: var(--box-radius); + margin: var(--box--margin); +} + +span.sep::after { + content: "▸"; +} + +span.sep { + font-size: calc(0.5em * var(--monospace-font-size)); + opacity: 0.55; + padding-left: .25em; + padding-right: .25em; +} + +code, +pre { + font-family: var(--monospace-font-family); + font-size: var(--monospace-font-size); + color: var(--box-text-color); +} + +pre { + background: var(--box-bg); + padding: var(--box-padding); + border-radius: var(--box-radius); + overflow: auto; +} + +code { + background: var(--box-bg); + padding: 0 0.35em; + border-radius: 0.35rem; + word-break: break-word; +} + +a > code { + color: var(--primary); +} + + +pre pre, +pre code { + padding: 0; + margin: 0; + font-size: 1em; + background: none; + color: inherit; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + font-family: inherit; + font-weight: inherit; + font-size: 0.85em; +} + +strong, b { + font-weight: 600; +} + +/* fix alignment of images on small screen */ +img, svg { + display: block; + max-width: 100%; + height: auto; +} + +svg .node polygon, svg .node path { + transition: fill 150ms ease; + fill: var(--box-bg); + stroke: none; +} + +svg .node a { + text-decoration: none !important; +} + +svg .node a text { + fill: var(--text-color); + font-family: var(--body-font-family); +} + +svg .node.link text { + fill: var(--primary); +} + +svg .node.link:hover polygon, svg .node.link:hover path { + fill: var(--sidebar-hover-bg); +} +svg .node.link:hover text { + fill: var(--box-text-color); +} +svg .edge path { + stroke: var(--text-color); +} + +/* fix unwanted margins in tables, code, lists and blockquotes */ +li > *:first-child, +li > *:first-child > *:first-child, +li > *:first-child > *:first-child > *:first-child, +td > *:first-child, +td > *:first-child > *:first-child, +td > *:first-child > *:first-child > *:first-child, +pre > *:first-child, +pre > *:first-child > *:first-child, +pre > *:first-child > *:first-child > *:first-child, +blockquote > *:first-child, +blockquote > *:first-child > *:first-child, +blockquote > *:first-child > *:first-child > *:first-child { + margin-top: 0; +} +li > *:last-child, +li > *:last-child > *:last-child, +li > *:last-child > *:last-child > *:last-child, +td > *:last-child, +td > *:last-child > *:last-child, +td > *:last-child > *:last-child > *:last-child, +pre > *:last-child, +pre > *:last-child > *:last-child, +pre > *:last-child > *:last-child > *:last-child, +blockquote > *:last-child, +blockquote > *:last-child > *:last-child, +blockquote > *:last-child > *:last-child > *:last-child { + margin-bottom: 0; +} + +/* allow easily adding a frame around images, by appending + * #frame to the url + */ +img[src$="#frame"] { + border: 1px solid var(--text-color); +} + +/********************************* + * PAGE STRUCTURE + *********************************/ +#body-wrapper { + display: flex; + flex-wrap: nowrap; + flex-direction: row; +} + +#body-wrapper:focus { + outline: none; +} + +#main { + position: relative; + flex-grow: 1; + min-width: 0; + box-shadow: 0 0 134px rgba(0, 0, 0, 0.1); +} + +footer { + width: 100%; + display: none; +} + +/********************************* + * Button + *********************************/ + +#btn-to-top { + position: fixed; + bottom: 12px; + right: 32px; + z-index: 1000; + border-radius: 50%; + width: 42px; + height: 42px; + border: 1px solid var(--primary); + background: var(--box-bg); + color: var(--text-color); + cursor: pointer; + text-transform: none; +} + +#btn-to-top > .up-arrow { + margin-left: -2px; +} + +#btn-to-top > .up-arrow:after { + content: url(go-up-symbolic.png); +} + +/********************************* + * SIDEBAR + *********************************/ +.sidebar { + background: var(--sidebar-bg); + border-right: 1px solid var(--sidebar-bg); + min-width: 35ch; + padding: var(--sidebar-padding); + color: var(--sidebar-text-color); + position: sticky; + top: 0; + z-index: 2; + height: 100vh; + overflow-y: auto; + color-scheme: dark; +} + +.sidebar a, +.sidebar a:hover { + text-decoration: none; +} + +.sidebar .logo { + display: block; + margin: 1rem auto 1.2rem auto; + width: 50%; +} + +.sidebar .section > ul > li { + margin-right: -10px; +} + +.sidebar .generator > p { + padding-left: 0.5rem; + padding-right: 0.5rem; + font-size: 0.8em; + opacity: 0.8; + position: relative; + bottom: 0; +} + +.sidebar .section h3, .sidebar .section h5 { + text-align: left; + padding-left: 0.5rem; + padding-right: 0.5rem; + font-weight: var(--heading-weight); +} + +.sidebar .section h5 { + font-size: 1em; + margin-bottom: 0.5em; +} + +.sidebar .namespace > h3 { + margin-bottom: 0; + padding: 0; + font-size: 1.5em; + text-transform: uppercase; + font-weight: 900; +} + +.sidebar .namespace > p { + font-size: 0.9em; + opacity: 0.8; + padding-left: 0.5rem; +} + +.sidebar .section { + padding-left: 0.5rem; + padding-right: 0.5rem; + font-size: 80%; +} + +.sidebar .links { + margin-bottom: 1rem; +} + +.sidebar .section a { + display: block; + text-overflow: ellipsis; + overflow: hidden; + transition: background-color 150ms ease; + color: var(--sidebar-primary); + border-radius: var(--box-radius); + padding: 0.2rem 0.5rem; + margin-bottom: 0.15rem; +} + +.sidebar .section a:hover { + background-color: var(--sidebar-hover-bg); + color: var(--sidebar-text-color); +} + +.sidebar .section a.current { + background-color: var(--sidebar-selected-bg); + color: white; +} + +.sidebar .search { + box-sizing: border-box; + text-align: center; +} + +.sidebar .search input[type="text"] { + border: none; + width: 100%; + border-radius: 50px; + padding: 8px 14px; + display: inline-block; + font-size: 14px; + outline: transparent; + background: var(--sidebar-search-bg); + color: var(--sidebar-text-color); + transition: background-color 150ms ease; +} + +.sidebar .search input[type="text"]:hover, +.sidebar .search input[type="text"]:focus { + background: var(--sidebar-search-focus-bg); +} + +.toc { + display: block; + margin-top: 2em; + z-index: 3; + min-width: 15ch; + font-size: 80%; +} + +.toc nav { + margin-left: 2em; + margin-right: 2em; +} + +#toc-title { + text-transform: uppercase; + font-weight: var(--heading-weight); +} + +.toc-list { + list-style-type: none; + margin: 0; + padding-left: 0; +} + +.toc-list-item { + padding-top: .25em; +} + +ul.toc-list > ul.toc-list { + padding-left: 1em; +} + +/********************************* + * ANCHORS & TOGGLERS + *********************************/ +.anchor, +.md-anchor { + position: relative; + z-index: 1; + text-decoration: none; + padding: 0 0.5em; + color: var(--text-color-muted); +} + +.anchor:hover, +.md-anchor:hover { + color: var(--primary); +} + +.anchor:not([href]), +.md-anchor:not([href]) { + display: none; +} + +.anchor:before, +.md-anchor:before { + content: var(--anchor-sign); /*'§'*/ +} + +.toggle-wrapper { + position: relative; +} + +.collapse-toggle { + position: absolute; + right: 0; + left: -2em; + white-space: nowrap; + text-decoration: none; + font-size: 0.8em; + color: transparent; +} + +.collapse-toggle > .inner { + width: 1rem; + height: 1rem; + border-radius: calc(0.75 * var(--box-radius)); + display: inline-flex; + justify-content: center; + align-items: center; + text-align: center; + vertical-align: middle; + color: var(--box-text-color); + position: relative; + left: -0.25rem; + font-family: monospace; + font-size: 0.7rem; + font-weight: bold; + background: var(--box-bg); +} + +/********************************* + * UTILITY + *********************************/ +.deprecated > h6 > a { + opacity: 0.65; +} + +.hidden { + display: none !important; +} + +/********************************* + * CONTENT STYLING + *********************************/ +.content { + padding: 2em 4em; + overflow: visible; + max-width: calc(var(--preferred-content-width) + 8em); +} + +.content table:not(.table-display) { + border-spacing: 0 0.25rem; +} + +.content td { + vertical-align: top; +} + +.content td:first-child { + padding-right: 1rem; +} + +.content td p:first-child { + margin-top: 0; +} + +.content td h1, .content td h2 { + margin-left: 0; + font-size: 1.1em; +} + +.content tr:first-child td { + border-top: 0; +} + +kbd { + display: inline-block; + padding: 8px; + font: 10px monospace; + line-height: 10px; + vertical-align: middle; + border: none; + border-radius: 6px; + box-shadow: 0 0 3px rgba(0,0,0,0.3); + margin: 3px; + background-color: var(--box-bg); + cursor: default; +} + +.content tr:first-child { + border-bottom: 1px solid rgba(0, 0, 0, 0.35); +} + +.content td { + vertical-align: top; +} + +.content td:first-child { + padding-right: 1rem; +} + +.content td p:first-child { + margin-top: 0; +} + +.content td h4, .content td h5 { + margin-left: 0; + font-size: 1.1em; +} + +.content tr:first-child td { + border-top: 0; +} + +.srclink { + color: var(--text-color-muted); + font-size: 1rem; + font-weight: var(--body-font-weight); + flex-grow: 0; + text-decoration: none; + margin-left: auto; + position: relative; + z-index: 1; +} + +.meta tr > td:not(:first-child) { + width: 100%; +} + +.meta tr > td:first-child { + white-space: nowrap; +} + +/********************************* + * DOCBLOCK STYLING + *********************************/ +.docblock { + position: relative; + text-align: left; +} + +.docblock h1 { + font-size: calc(1.3em * var(--heading-docblock-scale) * var(--heading-font-scale)); +} + +.docblock h2 { + font-size: calc(1.2em * var(--heading-docblock-scale) * var(--heading-font-scale)); +} + +.docblock h3 { + font-size: calc(1.1em * var(--heading-docblock-scale) * var(--heading-font-scale)); +} + +.docblock h4 { + font-size: calc(1.05em * var(--heading-docblock-scale) * var(--heading-font-scale)); +} + +.docblock h1, +.docblock h2, +.docblock h3, +.docblock h4, +.docblock h5, +.docblock h6 { + color: var(--heading-docblock-color) +} + +.docblock table { + margin: .25em 0; + max-width: 100%; + font-size: var(--table-font-size); +} + +.docblock table td { + padding: .25em; +} + +.docblock table th { + padding: .25em; + text-align: left; + font-family: var(--heading-table-font-family); + font-weight: var(--heading-table-weight); +} + +.docblock table tr th:first-child, +.docblock table tr td:first-child { + padding-left: 0; +} + +.docblock table tr th:last-child, +.docblock table tr td:last-child { + padding-right: 0; +} + +dl.enum-members { + font-size: 80%; +} + +dl.enum-members dt { + padding-top: 1em; +} + +table.arguments tr td { + color: var(--text-color-muted); +} + +table.arguments tr td:first-child { + min-width: 12em; +} + +table.arguments tr.arg-name td, +table.arguments tr.arg-description td { + color: var(--text-color); +} + +.docblock ul li, +.docblock ol li { + padding-top: 0.15rem; + padding-bottom: 0.15rem; +} + +.docblock ul.type { + list-style: none; +} + +.docblock ul.type li::before { + content: "»"; + color: var(--text-color); + display: inline-block; + width: 1em; + margin-left: -1em; +} + +.docblock .codehilite { + position: relative; +} +.docblock .codehilite > .copy-button { + position: absolute; + top: 0; + right: 0; + + border: none; + background: none; + + margin: var(--box-padding); + cursor: pointer; +} + +.docblock .codehilite > .copy-button { + transition: background-color 150ms ease; + color: var(--primary); + border-radius: var(--box-radius); + padding: 0.2rem 0.5rem; + margin: var(--box-padding); +} + +.docblock .codehilite > .copy-button:hover { + background-color: var(--sidebar-hover-bg); + color: var(--text-color); +} + +.docblock .codehilite > .copy-button:active { + background-color: var(--primary); +} + +.emblem { + padding: 0 0.75em; + border-radius: 9999px; + font-size: 80%; +} + +.emblem.available-next { + background-color: var(--warning-bg-color); + color: var(--warning-fg-color); +} + +.emblem.deprecated { + background-color: var(--error-bg-color); + color: var(--error-fg-color); +} + +.emblem.available { + background-color: var(--accent-bg-color); + color: var(--accent-fg-color); +} + +dt.result { + padding: .5em 0; +} + +.result.emblem.alias, +.result.emblem.bitfield, +.result.emblem.callback, +.result.emblem.class, +.result.emblem.constant, +.result.emblem.extra_content, +.result.emblem.ctor, +.result.emblem.domain, +.result.emblem.enum, +.result.emblem.function_macro, +.result.emblem.function, +.result.emblem.interface, +.result.emblem.method, +.result.emblem.property, +.result.emblem.record, +.result.emblem.signal, +.result.emblem.type_func, +.result.emblem.union, +.result.emblem.vfunc { + background-color: var(--accent-bg-color); + color: var(--accent-fg-color); +} + +.admonition { + background: var(--admonition-color-bg); + border-left: .2rem solid #651fff; + border-radius: .2rem; + box-shadow: 0 .2rem .5rem rgba(0, 0, 0, .05), 0 0 .0625rem rgba(0, 0, 0, .1); + font-size: var(--admonition-font-size); + margin: 1rem auto; + overflow: hidden; + padding: 0 .5rem .5rem; + page-break-inside: avoid; +} + +.admonition > p.admonition-title { + font-weight: 500; + line-height: 1.3; + margin: 0 -.5rem .5rem; + padding: .4rem .5rem .4rem 2rem; + position: relative; +} + +p.admonition-title::before { + content: ""; + position: absolute; + left: .5rem; + height: 1rem; + width: 1rem; + -webkit-mask-repeat: no-repeat; + mask-repeat: no-repeat; +} + +.admonition.note > .admonition-title, +.admonition.seealso > .admonition-title { + background-color: var(--admonition-color-title-bg--note); +} + +.admonition.note > .admonition-title::before, +.admonition.seealso > .admonition-title::before { + background-color: var(--admonition-color-title--note); + -webkit-mask-image: var(--admonition-icon--note); + mask-image: var(--admonition-icon--note); + +} + +.admonition.note, +.admonition.seealso { + border-left-color: var(--admonition-color-title--note); +} + +.admonition.tip > .admonition-title, +.admonition.hint > .admonition-title { + background-color: var(--admonition-color-title-bg--tip); +} + +.admonition.tip > .admonition-title::before, +.admonition.hint > .admonition-title::before { + background-color: var(--admonition-color-title--tip); + -webkit-mask-image: var(--admonition-icon--tip); + mask-image: var(--admonition-icon--tip); +} + +.admonition.tip, +.admonition.hint { + border-left-color: var(--admonition-color-title--tip); +} + +.admonition.important > .admonition-title { + background-color: var(--admonition-color-title-bg--important); +} + +.admonition.important > .admonition-title::before { + background-color: var(--admonition-color-title--important); + -webkit-mask-image: var(--admonition-icon--important); + mask-image: var(--admonition-icon--important); +} + +.admonition.important { + border-left-color: var(--admonition-color-title--important); +} + +.admonition.warning > .admonition-title { + background-color: var(--admonition-color-title-bg--warning); +} + +.admonition.warning > .admonition-title::before { + background-color: var(--admonition-color-title--warning); + -webkit-mask-image: var(--admonition-icon--warning); + mask-image: var(--admonition-icon--warning); +} + +.admonition.warning { + border-left-color: var(--admonition-color-title--warning); +} + +/************************************************************* + SYMBOLS +**************************************************************/ +.symbol, +.constructors h6, +.methods h6, +.signals h6, +.properties h6, +.type-funcs h6, +.implements a, +.ancestors a, +.descendants a, +.implementations a, +.sidebar .links a +.toc a +{ + font-family: var(--symbol-font-family); + font-size: calc(1em * var(--symbol-font-scale)); + font-weight: var(--symbol-font-weight); +} + +/************************** + RESPONSIVENESS +**************************/ +@media (max-width: 700px) { + body { + padding-top: 0px; + } + + #body-wrapper { + flex-direction: column; + overflow: hidden; + } + + #main { + width: 100%; + padding: 2rem; + } + + .sidebar { + position: static; + height: initial; + order: 1; + } + + .toc { + display: hidden; + } +} diff --git a/doc/clapper-gtk/urlmap.js b/doc/clapper-gtk/urlmap.js new file mode 100644 index 00000000..27b7b961 --- /dev/null +++ b/doc/clapper-gtk/urlmap.js @@ -0,0 +1,7 @@ +baseURLs = [ + ['GLib', 'https://docs.gtk.org/glib/'], + ['GObject', 'https://docs.gtk.org/gobject/'], + ['Gtk', 'https://docs.gtk.org/gtk4/'], + ['Gst', 'https://gstreamer.freedesktop.org/documentation/gstreamer/gi-index.html?'], + ['Clapper', 'https://rafostar.github.io/clapper/doc/clapper/'], +] diff --git a/doc/clapper-gtk/vfunc.SkipItemButton.can_skip.html b/doc/clapper-gtk/vfunc.SkipItemButton.can_skip.html new file mode 100644 index 00000000..d3d81f87 --- /dev/null +++ b/doc/clapper-gtk/vfunc.SkipItemButton.can_skip.html @@ -0,0 +1,231 @@ + + + + + + ClapperGtk.SkipItemButton.can_skip + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Virtual Method

+

ClapperGtkSkipItemButtoncan_skip

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
gboolean
+can_skip (
+  ClapperGtkSkipItemButton* skip_button,
+  ClapperQueue* queue
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
queue
+
+

Type: ClapperQueue

+

No description available.

+ + + + + + + + + + +
The data is owned by the caller of the function.
+
+ + + +
+
+
+ + + +
+

+ Return value + +

+ +
+
+
+

Type: gboolean

+

No description available.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper-gtk/vfunc.SkipItemButton.skip_item.html b/doc/clapper-gtk/vfunc.SkipItemButton.skip_item.html new file mode 100644 index 00000000..cc79c088 --- /dev/null +++ b/doc/clapper-gtk/vfunc.SkipItemButton.skip_item.html @@ -0,0 +1,205 @@ + + + + + + ClapperGtk.SkipItemButton.skip_item + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Virtual Method

+

ClapperGtkSkipItemButtonskip_item

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+ 
void
+skip_item (
+  ClapperGtkSkipItemButton* skip_button,
+  ClapperQueue* queue
+)
+

+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
queue
+
+

Type: ClapperQueue

+

No description available.

+ + + + + + + + + + +
The data is owned by the caller of the function.
+
+ + + +
+
+
+ + + + +
+
+ + + + + + + +
+ + \ No newline at end of file