[cheese] Comment Vala methods with Valadoc markup
- From: David King <davidk src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [cheese] Comment Vala methods with Valadoc markup
- Date: Sat, 5 Nov 2011 13:10:54 +0000 (UTC)
commit a8e5d86c622214712604a97a6ebddaa69d932bd7
Author: David King <amigadave amigadave com>
Date: Sat Nov 5 13:24:38 2011 +0100
Comment Vala methods with Valadoc markup
Add basic documentation to all methods in Vala sources.
src/cheese-countdown.vala | 18 +++
src/cheese-effects-manager.vala | 24 ++++
src/cheese-main.vala | 10 ++
src/cheese-preferences.vala | 143 ++++++++++++++++++++++-
src/cheese-window.vala | 237 ++++++++++++++++++++++++++++++++++++++-
5 files changed, 421 insertions(+), 11 deletions(-)
---
diff --git a/src/cheese-countdown.vala b/src/cheese-countdown.vala
index 097e464..81b9059 100644
--- a/src/cheese-countdown.vala
+++ b/src/cheese-countdown.vala
@@ -46,12 +46,22 @@ internal class Cheese.Countdown : GLib.Object
settings = new GLib.Settings("org.gnome.Cheese");
}
+ /**
+ * Fade the countdown text out, over 500 milliseconds.
+ *
+ * Once the fade-out is complete, this method calls fade_in().
+ */
private void fade_out ()
{
anim = this.countdown_actor.animate (Clutter.AnimationMode.LINEAR, 500, "opacity", 0);
signal_id = Signal.connect_after (anim, "completed", (GLib.Callback)fade_in, this);
}
+ /**
+ * Decrement the countdown text and fade it in, over 500 milliseconds.
+ *
+ * Once the fade-in is complete, this method calls fade_out().
+ */
private void fade_in ()
{
if (this.current_value <= 0)
@@ -67,6 +77,11 @@ internal class Cheese.Countdown : GLib.Object
signal_id = Signal.connect_after (anim, "completed", (GLib.Callback)fade_out, this);
}
+ /**
+ * Start the countdown, using the countdown-duration GSetting for the time.
+ *
+ * @param completed_callback the callback to call upon countdown completion
+ */
public void start (CountdownCallback completed_callback)
{
this.completed_callback = completed_callback;
@@ -76,6 +91,9 @@ internal class Cheese.Countdown : GLib.Object
fade_in ();
}
+ /**
+ * Stop the countdown, for example if it was interrupted by the user.
+ */
public void stop ()
{
countdown_actor.hide ();
diff --git a/src/cheese-effects-manager.vala b/src/cheese-effects-manager.vala
index 42fc51c..1d7bbc0 100644
--- a/src/cheese-effects-manager.vala
+++ b/src/cheese-effects-manager.vala
@@ -33,6 +33,9 @@ internal class Cheese.EffectsManager : GLib.Object
effects = new ArrayList<Effect>((EqualFunc) cmp_value);
}
+ /**
+ * Add the effects into the manager.
+ */
public void load_effects ()
{
GLib.List<Cheese.Effect> effect_list = Cheese.Effect.load_effects ();
@@ -51,6 +54,12 @@ internal class Cheese.EffectsManager : GLib.Object
}
}
+ /**
+ * Search for and return the requested effect.
+ *
+ * @param name the name of the effect to search for
+ * @return the effect that which matches the supplied name, or null
+ */
public Effect ? get_effect (string name)
{
foreach (Effect eff in effects)
@@ -61,11 +70,26 @@ internal class Cheese.EffectsManager : GLib.Object
return null;
}
+ /**
+ * Compare two effects by the pipeline description.
+ *
+ * @param a an effect to compare against
+ * @param b another effect to compare against
+ * @return true if the effects are the same, false otherwise
+ */
private static bool cmp_value (Effect a, Effect b)
{
return a.pipeline_desc == b.pipeline_desc;
}
+ /**
+ * A sort function for effects
+ *
+ * @param a an effect to sort against
+ * @param b another effect to sort against
+ * @return -1 if a is less than b, 0 if the effects are the same and 1 if a
+ * is greater than b
+ */
private static int sort_value (Effect a, Effect b)
{
if (a.name.down () < b.name.down ())
diff --git a/src/cheese-main.vala b/src/cheese-main.vala
index 0d1cd53..334356b 100644
--- a/src/cheese-main.vala
+++ b/src/cheese-main.vala
@@ -46,6 +46,9 @@ public class Cheese.Main : Gtk.Application
GLib.Object (application_id: app_id, flags: flags);
}
+ /**
+ * Present the existing main window, or create a new one.
+ */
public void on_app_activate ()
{
if (get_windows () != null)
@@ -79,6 +82,13 @@ public class Cheese.Main : Gtk.Application
}
}
+ /**
+ * Overridden method of GApplication, to handle the arguments locally.
+ *
+ * @param arguments the command-line arguments
+ * @param exit_status the exit status to return to the OS
+ * @return true if the arguments were successfully processed, false otherwise
+ */
public override bool local_command_line ([CCode (array_null_terminated = true, array_length = false)]
ref unowned string[] arguments,
out int exit_status)
diff --git a/src/cheese-preferences.vala b/src/cheese-preferences.vala
index fe3604f..2f5ecea 100644
--- a/src/cheese-preferences.vala
+++ b/src/cheese-preferences.vala
@@ -110,6 +110,9 @@ public class Cheese.PreferencesDialog : GLib.Object
camera.notify["num-camera-devices"].connect(this.on_camera_update_num_camera_devices);
}
+ /**
+ * Set up combo box cell renderers.
+ */
private void setup_combo_box_models ()
{
CellRendererText cell = new CellRendererText ();
@@ -124,6 +127,9 @@ public class Cheese.PreferencesDialog : GLib.Object
source_combo.set_attributes (cell, "text", 0);
}
+ /**
+ * Initialize and populate the camera device combo box model.
+ */
private void initialize_camera_devices ()
{
unowned GLib.PtrArray devices = camera.get_camera_devices ();
@@ -139,6 +145,11 @@ public class Cheese.PreferencesDialog : GLib.Object
setup_resolutions_for_device (camera.get_selected_device ());
}
+ /**
+ * Initialize and populate the resolution combo box models for the device.
+ *
+ * @param device the Cheese.CameraDevice for which to enumerate resolutions
+ */
private void setup_resolutions_for_device (Cheese.CameraDevice device)
{
unowned List<VideoFormat> formats = device.get_format_list ();
@@ -171,10 +182,10 @@ public class Cheese.PreferencesDialog : GLib.Object
}
}
- /* Video resolution combo shows photo resolution by
- * default if previous user choice is not found in settings or not supported
- * by current device. These values are saved to settings.
- */
+ /* Video resolution combo shows photo resolution by default if previous
+ * user choice is not found in settings or not supported by current device.
+ * These values are saved to settings.
+ */
if (video_resolution_combo.get_active () == -1)
{
video_resolution_combo.set_active (photo_resolution_combo.get_active ());
@@ -183,6 +194,9 @@ public class Cheese.PreferencesDialog : GLib.Object
}
}
+ /**
+ * Take the user preferences from GSettings.
+ */
private void initialize_values_from_settings ()
{
brightness_adjustment.value = settings.get_double ("brightness");
@@ -197,6 +211,11 @@ public class Cheese.PreferencesDialog : GLib.Object
flash_check.active = settings.get_boolean ("flash");
}
+ /**
+ * Update the active device to the active iter of the device combo box.
+ *
+ * @param combo the video device combo box
+ */
[CCode (instance_pos = -1)]
public void on_source_change (Gtk.ComboBox combo)
{
@@ -214,6 +233,12 @@ public class Cheese.PreferencesDialog : GLib.Object
settings.set_string ("camera", dev.get_device_file ());
}
+ /**
+ * Update the current photo capture resolution to the active iter of the
+ * photo resolution combo box.
+ *
+ * @param combo the photo resolution combo box
+ */
[CCode (instance_pos = -1)]
public void on_photo_resolution_change (Gtk.ComboBox combo)
{
@@ -231,6 +256,12 @@ public class Cheese.PreferencesDialog : GLib.Object
settings.set_int ("photo-y-resolution", format.height);
}
+ /**
+ * Update the current video capture resolution to the active iter of the
+ * video resolution combo box.
+ *
+ * @param combo the video resolution combo box
+ */
[CCode (instance_pos = -1)]
public void on_video_resolution_change (Gtk.ComboBox combo)
{
@@ -248,18 +279,33 @@ public class Cheese.PreferencesDialog : GLib.Object
settings.set_int ("video-y-resolution", format.height);
}
+ /**
+ * Hide the dialog when it is closed, rather than deleting it.
+ *
+ * @param dialog the dialog on which the delete event was generated
+ */
[CCode (instance_pos = -1)]
public void on_delete (Gtk.Dialog dialog)
{
dialog.hide_on_delete ();
}
+ /**
+ * Hide the dialog when it is closed, rather than deleting it.
+ *
+ * @param button the close button
+ */
[CCode (instance_pos = -1)]
public void on_dialog_close (Gtk.Button button)
{
this.dialog.hide ();
}
+ /**
+ * Show the help for the preferences dialog.
+ *
+ * @param button the help button
+ */
[CCode (instance_pos = -1)]
public void on_dialog_help (Gtk.Button button)
{
@@ -274,30 +320,61 @@ public class Cheese.PreferencesDialog : GLib.Object
}
}
+ /**
+ * Toggle the countdown GSetting when toggling the check button.
+ *
+ * @param checkbutton the countdown check button
+ */
[CCode (instance_pos = -1)]
public void on_countdown_toggle (Gtk.CheckButton checkbutton)
{
settings.set_boolean ("countdown", checkbutton.active);
}
+ /**
+ * Toggle the flash GSetting when toggling the check button.
+ *
+ * @param checkbutton the flash check button
+ */
[CCode (instance_pos = -1)]
public void on_flash_toggle (Gtk.CheckButton checkbutton)
{
settings.set_boolean ("flash", checkbutton.active);
}
+ /**
+ * Change the burst-repeat GSetting when changing the spin button.
+ *
+ * The burst repeat is the total number of photos to take in a single burst.
+ *
+ * @param spinbutton the burst-repeat spin button
+ */
[CCode (instance_pos = -1)]
public void on_burst_repeat_change (Gtk.SpinButton spinbutton)
{
settings.set_int ("burst-repeat", (int) spinbutton.value);
}
+ /**
+ * Change the burst-delay GSetting when changing the spin button.
+ *
+ * The burst delay is the time, in milliseconds, between individual photos in
+ * a burst.
+ *
+ * @param spinbutton the burst-delay spin button
+ */
[CCode (instance_pos = -1)]
public void on_burst_delay_change (Gtk.SpinButton spinbutton)
{
settings.set_int ("burst-delay", (int) spinbutton.value * 1000);
}
+ /**
+ * Change the brightness of the image, and update the GSetting, when changing
+ * the scale.
+ *
+ * @param adjustment the adjustment of the brightness Gtk.Scale
+ */
[CCode (instance_pos = -1)]
public void on_brightness_change (Gtk.Adjustment adjustment)
{
@@ -305,6 +382,12 @@ public class Cheese.PreferencesDialog : GLib.Object
settings.set_double ("brightness", adjustment.value);
}
+ /**
+ * Change the contrast of the image, and update the GSetting, when changing
+ * the scale.
+ *
+ * @param adjustment the adjustment of the contrast Gtk.Scale
+ */
[CCode (instance_pos = -1)]
public void on_contrast_change (Gtk.Adjustment adjustment)
{
@@ -312,6 +395,12 @@ public class Cheese.PreferencesDialog : GLib.Object
settings.set_double ("contrast", adjustment.value);
}
+ /**
+ * Change the hue of the image, and update the GSetting, when changing the
+ * scale.
+ *
+ * @param adjustment the adjustment of the hue Gtk.Scale
+ */
[CCode (instance_pos = -1)]
public void on_hue_change (Gtk.Adjustment adjustment)
{
@@ -319,6 +408,12 @@ public class Cheese.PreferencesDialog : GLib.Object
settings.set_double ("hue", adjustment.value);
}
+ /**
+ * Change the saturation of the image, and update the GSetting, when changing
+ * the scale.
+ *
+ * @param adjustment the adjustment of the saturation Gtk.Scale
+ */
[CCode (instance_pos = -1)]
public void on_saturation_change (Gtk.Adjustment adjustment)
{
@@ -326,8 +421,11 @@ public class Cheese.PreferencesDialog : GLib.Object
settings.set_double ("saturation", adjustment.value);
}
- // A camera device was added/removed.
- public void on_camera_update_num_camera_devices ()
+ /**
+ * Update the video device combo box when a camera device was added or
+ * removed.
+ */
+ private void on_camera_update_num_camera_devices ()
{
unowned GLib.PtrArray devices = camera.get_camera_devices ();
Cheese.CameraDevice dev;
@@ -382,6 +480,14 @@ public class Cheese.PreferencesDialog : GLib.Object
setup_resolutions_for_device (camera.get_selected_device ());
}
+ /**
+ * Add the supplied camera device to the device combo box model.
+ *
+ * This method is intended to be used with the foreach method of GLib
+ * containers.
+ *
+ * @param device a Cheese.CameraDevice to add to the device combo box model
+ */
private void add_camera_device (void *device)
{
TreeIter iter;
@@ -396,6 +502,13 @@ public class Cheese.PreferencesDialog : GLib.Object
source_combo.set_active_iter (iter);
}
+ /**
+ * Remove the supplied camera device from the device combo box model.
+ *
+ * @param iter the iterator of the device to remove
+ * @param device_node the device to remove from the combo box model
+ * @param active_device_node the currently-active camera device
+ */
private void remove_camera_device (TreeIter iter, Cheese.CameraDevice device_node,
Cheese.CameraDevice active_device_node)
{
@@ -412,7 +525,12 @@ public class Cheese.PreferencesDialog : GLib.Object
camera_model.remove (iter);
}
- // Look for an available device and activate it.
+ /**
+ * Search for an available camera device and activate it in the device combo
+ * box model.
+ *
+ * @param iter a device in the combo box model to search either side of
+ */
private void set_new_available_camera_device (TreeIter iter)
{
TreeIter new_iter = iter;
@@ -425,11 +543,22 @@ public class Cheese.PreferencesDialog : GLib.Object
source_combo.set_active_iter (new_iter);
}
+ /**
+ * Show the dialog.
+ */
public void show ()
{
this.dialog.show_all ();
}
+ /**
+ * Set the current media mode (photo, video, burst).
+ *
+ * The current mode is used if the photo or video resolution is changed, in
+ * order to propagate that change to the Cheese.Camera.
+ *
+ * @param mode the media mode to set
+ */
public void set_current_mode (MediaMode mode)
{
this.current_mode = mode;
diff --git a/src/cheese-window.vala b/src/cheese-window.vala
index 7afc501..5c1c059 100644
--- a/src/cheese-window.vala
+++ b/src/cheese-window.vala
@@ -106,12 +106,22 @@ public class Cheese.MainWindow : Gtk.Window
private Cheese.Effect selected_effect;
+ /**
+ * Destroy the main window, and shutdown the application, when quitting.
+ *
+ * @param action the action that emitted the signal
+ */
[CCode (instance_pos = -1)]
public void on_quit (Gtk.Action action)
{
destroy ();
}
+ /**
+ * Show the preferences dialog when requested, creating it as necessary.
+ *
+ * @param action the action that emitted the signal
+ */
[CCode (instance_pos = -1)]
public void on_preferences_dialog (Gtk.Action action)
{
@@ -121,6 +131,13 @@ public class Cheese.MainWindow : Gtk.Window
preferences_dialog.show ();
}
+ /**
+ * Popup a context menu when right-clicking on a thumbnail.
+ *
+ * @param iconview the thumbnail view that emitted the signal
+ * @param event the event
+ * @return false, to allow further processing of the event
+ */
public bool on_thumbnail_mouse_button_press (Gtk.Widget iconview,
Gdk.EventButton event)
{
@@ -153,6 +170,11 @@ public class Cheese.MainWindow : Gtk.Window
return false;
}
+ /**
+ * Open an image associated with a thumbnail in the default application.
+ *
+ * @param action the action that emitted the signal, or null
+ */
[CCode (instance_pos = -1)]
public void on_file_open (Gtk.Action ? action)
{
@@ -185,6 +207,13 @@ public class Cheese.MainWindow : Gtk.Window
}
}
+ /**
+ * Delete the requested image in the thumbview from storage.
+ *
+ * A confirmation dialog is shown to the user before deleting the file.
+ *
+ * @param action the action that emitted the signal
+ */
[CCode (instance_pos = -1)]
public void on_file_delete (Gtk.Action action)
{
@@ -234,6 +263,13 @@ public class Cheese.MainWindow : Gtk.Window
}
}
+ /**
+ * Move the requested image in the thumbview to the trash.
+ *
+ * A confirmation dialog is shown to the user before moving the file.
+ *
+ * @param action the action that emitted the signal
+ */
[CCode (instance_pos = -1)]
public void on_file_move_to_trash (Gtk.Action action)
{
@@ -267,6 +303,13 @@ public class Cheese.MainWindow : Gtk.Window
}
}
+ /**
+ * Move all images in the thumbview to the trash.
+ *
+ * No confirmation dialog is shown to the user before moving the files!
+ *
+ * @param action the action that emitted the signal
+ */
[CCode (instance_pos = -1)]
public void on_file_move_to_trash_all (Gtk.Action action)
{
@@ -297,6 +340,14 @@ public class Cheese.MainWindow : Gtk.Window
}
}
+ /**
+ * Save the selected file in the thumbview to an alternate storage location.
+ *
+ * A file chooser dialog is shown to the user, asking where the file should
+ * be saved and the filename.
+ *
+ * @param action the action that emitted the signal.
+ */
[CCode (instance_pos = -1)]
public void on_file_save_as (Gtk.Action action)
{
@@ -352,6 +403,11 @@ public class Cheese.MainWindow : Gtk.Window
save_as_dialog.destroy ();
}
+ /**
+ * Show the Cheese help contents.
+ *
+ * @param action the action that emitted the signal
+ */
[CCode (instance_pos = -1)]
public void on_help_contents (Gtk.Action action)
{
@@ -365,6 +421,11 @@ public class Cheese.MainWindow : Gtk.Window
}
}
+ /**
+ * Show the about dialog.
+ *
+ * @param action the action that emitted the signal
+ */
[CCode (instance_pos = -1)]
public void on_help_about (Gtk.Action action)
{
@@ -377,6 +438,11 @@ public class Cheese.MainWindow : Gtk.Window
about_dialog.hide ();
}
+ /**
+ * Toggle wide mode and save the preference to GSettings.
+ *
+ * @param action the action that emitted the signal
+ */
[CCode (instance_pos = -1)]
public void on_layout_wide_mode (ToggleAction action)
{
@@ -389,6 +455,11 @@ public class Cheese.MainWindow : Gtk.Window
set_wide_mode (action.active);
}
+ /**
+ * Toggle fullscreen mode and save the preference to GSettings.
+ *
+ * @param action the action that emitted the signal
+ */
[CCode (instance_pos = -1)]
public void on_layout_fullscreen (ToggleAction action)
{
@@ -401,12 +472,20 @@ public class Cheese.MainWindow : Gtk.Window
set_fullscreen_mode (action.active);
}
+ /**
+ * Change the media capture mode (photo, video or burst).
+ *
+ * @param action the action that emitted the signal
+ */
[CCode (instance_pos = -1)]
public void on_mode_change (RadioAction action)
{
set_mode ((MediaMode) action.value);
}
+ /**
+ * Make the media capture mode actions sensitive.
+ */
private void enable_mode_change ()
{
photo_mode_action.sensitive = true;
@@ -415,6 +494,9 @@ public class Cheese.MainWindow : Gtk.Window
effects_toggle_action.sensitive = true;
}
+ /**
+ * Make the media capture mode actions insensitive.
+ */
private void disable_mode_change ()
{
photo_mode_action.sensitive = false;
@@ -423,6 +505,11 @@ public class Cheese.MainWindow : Gtk.Window
effects_toggle_action.sensitive = false;
}
+ /**
+ * Set the capture resolution, based on the current capture mode.
+ *
+ * @param mode the current capture mode (photo, video or burst)
+ */
private void set_resolution(MediaMode mode)
{
if (camera == null)
@@ -461,6 +548,11 @@ public class Cheese.MainWindow : Gtk.Window
}
}
+ /**
+ * Set the current media capture mode, and update the UI sensitivities.
+ *
+ * @param mode the new capture mode to set
+ */
private void set_mode (MediaMode mode)
{
this.current_mode = mode;
@@ -498,6 +590,9 @@ public class Cheese.MainWindow : Gtk.Window
}
private TimeoutSource fullscreen_timeout;
+ /**
+ * Clear the fullscreen activity timeout.
+ */
private void clear_fullscreen_timeout ()
{
if (fullscreen_timeout != null)
@@ -507,6 +602,10 @@ public class Cheese.MainWindow : Gtk.Window
}
}
+ /**
+ * Set the fullscreen timeout, for hiding the UI if there is no mouse
+ * movement.
+ */
private void set_fullscreen_timeout ()
{
fullscreen_timeout = new TimeoutSource (FULLSCREEN_TIMEOUT_INTERVAL);
@@ -516,17 +615,29 @@ public class Cheese.MainWindow : Gtk.Window
return true; });
}
+ /**
+ * Show the UI in fullscreen if there is any mouse activity.
+ *
+ * Start a new timeout at the end of every mouse pointer movement. All
+ * timeouts will be cancelled, except one created during the last movement
+ * event. Show() is called even if the button is not hidden.
+ *
+ * @param viewport the widget to check for mouse activity on
+ * @param e the (unused) event
+ */
private bool fullscreen_motion_notify_callback (Gtk.Widget viewport, EventMotion e)
{
- /* Start a new timeout at the end of every mouse pointer movement.
- * So all timeouts will be cancelled, except one at the last pointer movement.
- * We call show even if the button isn't hidden. */
clear_fullscreen_timeout ();
buttons_area.show ();
set_fullscreen_timeout ();
return true;
}
+ /**
+ * Enable or disable fullscreen mode to the requested state.
+ *
+ * @param fullscreen_mode whether to enable or disable fullscreen mode
+ */
private void set_fullscreen_mode (bool fullscreen_mode)
{
/* After the first time the window has been shown using this.show_all (),
@@ -589,6 +700,11 @@ public class Cheese.MainWindow : Gtk.Window
}
}
+ /**
+ * Enable or disable wide mode to the requested state.
+ *
+ * @param wide_mode whether to enable or disable wide mode
+ */
private void set_wide_mode (bool wide_mode)
{
is_wide_mode = wide_mode;
@@ -638,7 +754,13 @@ public class Cheese.MainWindow : Gtk.Window
viewport_widget.set_size_request (-1, -1);
}
- /* To make sure that the layout manager manages the entire stage. */
+ /**
+ * Make sure that the layout manager manages the entire stage.
+ *
+ * @param actor unused
+ * @param box unused
+ * @param flags unused
+ */
public void on_stage_resize (Clutter.Actor actor,
Clutter.ActorBox box,
Clutter.AllocationFlags flags)
@@ -647,12 +769,20 @@ public class Cheese.MainWindow : Gtk.Window
this.background_layer.set_size (viewport.width, viewport.height);
}
+ /**
+ * Toggle whether the countdown is active.
+ *
+ * @param action the action that emitted the signal
+ */
[CCode (instance_pos = -1)]
public void on_countdown_toggle (ToggleAction action)
{
settings.set_boolean ("countdown", action.active);
}
+ /**
+ * The method to call when the countdown is finished.
+ */
private void finish_countdown_callback ()
{
if (action_cancelled == false)
@@ -679,6 +809,9 @@ public class Cheese.MainWindow : Gtk.Window
}
Countdown current_countdown;
+ /**
+ * Start to take a photo, starting a countdown if it is enabled.
+ */
public void take_photo ()
{
if (settings.get_boolean ("countdown"))
@@ -701,6 +834,12 @@ public class Cheese.MainWindow : Gtk.Window
private int burst_count;
private uint burst_callback_id;
+ /**
+ * Take a photo during burst mode, and increment the burst count.
+ *
+ * @return true if there are more photos to be taken in the current burst,
+ * false otherwise
+ */
private bool burst_take_photo ()
{
if (is_bursting && burst_count < settings.get_int ("burst-repeat"))
@@ -716,6 +855,12 @@ public class Cheese.MainWindow : Gtk.Window
}
}
+ /**
+ * Cancel the current activity if the escape key is pressed.
+ *
+ * @param event the key event, to check which key was pressed
+ * @return false, to allow further processing of the event
+ */
private bool on_key_release (Gdk.EventKey event)
{
string key;
@@ -752,6 +897,11 @@ public class Cheese.MainWindow : Gtk.Window
return false;
}
+ /**
+ * Toggle whether video recording is active.
+ *
+ * @param is_start whether to start video recording
+ */
public void toggle_video_recording (bool is_start)
{
if (is_start)
@@ -774,6 +924,11 @@ public class Cheese.MainWindow : Gtk.Window
}
}
+ /**
+ * Toggle whether photo bursting is active.
+ *
+ * @param is_start whether to start capturing a photo burst
+ */
public void toggle_photo_bursting (bool is_start)
{
if (is_start)
@@ -813,6 +968,12 @@ public class Cheese.MainWindow : Gtk.Window
}
}
+ /**
+ * Take a photo or burst of photos, or record a video, based on the current
+ * capture mode.
+ *
+ * @param action the action that emitted the signal
+ */
[CCode (instance_pos = -1)]
public void on_take_action (Gtk.Action action)
{
@@ -832,6 +993,11 @@ public class Cheese.MainWindow : Gtk.Window
}
}
+ /**
+ * Toggle the display of the effect selector.
+ *
+ * @param action the action that emitted the signal
+ */
[CCode (instance_pos = -1)]
public void on_effects_toggle (Gtk.ToggleAction action)
{
@@ -844,6 +1010,13 @@ public class Cheese.MainWindow : Gtk.Window
burst_mode_action.sensitive = !action.active;
}
+ /**
+ * Change the selected effect, as a new one was selected.
+ *
+ * @param source unused
+ * @param event unused
+ * @return false, to allow further event processing
+ */
public bool on_selected_effect_change (Clutter.Actor source,
Clutter.ButtonEvent event)
{
@@ -854,6 +1027,11 @@ public class Cheese.MainWindow : Gtk.Window
return false;
}
+ /**
+ * Navigate back one page of effects.
+ *
+ * @param action the action that emitted the signal
+ */
[CCode (instance_pos = -1)]
public void on_prev_effects_page (Gtk.Action action)
{
@@ -863,6 +1041,11 @@ public class Cheese.MainWindow : Gtk.Window
}
}
+ /**
+ * Navigate forward one page of effects.
+ *
+ * @param action the action that emitted the signal
+ */
[CCode (instance_pos = -1)]
public void on_next_effects_page (Gtk.Action action)
{
@@ -872,6 +1055,11 @@ public class Cheese.MainWindow : Gtk.Window
}
}
+ /**
+ * Switch to the supplied page of effects.
+ *
+ * @param number the effects page to switch to
+ */
private void activate_effects_page (int number)
{
if (!is_effects_selector_active)
@@ -908,6 +1096,9 @@ public class Cheese.MainWindow : Gtk.Window
setup_effects_page_switch_sensitivity ();
}
+ /**
+ * Control the sensitivity of the effects page navigation buttons.
+ */
private void setup_effects_page_switch_sensitivity ()
{
effects_page_prev_action.sensitive = (is_effects_selector_active && current_effects_page != 0);
@@ -915,6 +1106,11 @@ public class Cheese.MainWindow : Gtk.Window
(is_effects_selector_active && current_effects_page != effects_manager.effects.size / EFFECTS_PER_PAGE);
}
+ /**
+ * Toggle the visibility of the effects selector.
+ *
+ * @param active whether the selector should be active
+ */
private void toggle_effects_selector (bool active)
{
is_effects_selector_active = active;
@@ -950,6 +1146,9 @@ public class Cheese.MainWindow : Gtk.Window
setup_effects_page_switch_sensitivity ();
}
+ /**
+ * Create the effects selector.
+ */
private void setup_effects_selector ()
{
if (current_effects_grid == null)
@@ -1021,6 +1220,11 @@ public class Cheese.MainWindow : Gtk.Window
}
private Gee.HashMap<string, bool> action_sensitivities;
+ /**
+ * Toggle the sensitvity of the camera actions.
+ *
+ * @param active whether the camera actions should be sensitive
+ */
public void toggle_camera_actions_sensitivities (bool active)
{
is_camera_actions_sensitive = active;
@@ -1080,6 +1284,11 @@ public class Cheese.MainWindow : Gtk.Window
}
}
+ /**
+ * Update the UI based on state changes of the camera.
+ *
+ * @param new_state the new Cheese.Camera state
+ */
private void camera_state_changed (Gst.State new_state)
{
if (new_state == Gst.State.PLAYING)
@@ -1093,6 +1302,10 @@ public class Cheese.MainWindow : Gtk.Window
}
}
+ /**
+ * Set wide mode active when started from the command line (and do not change
+ * the GSetting).
+ */
public void set_startup_wide_mode ()
{
if (is_wide_mode)
@@ -1106,6 +1319,10 @@ public class Cheese.MainWindow : Gtk.Window
is_command_line_startup = false;
}
+ /**
+ * Set fullscreen mode active when started from the command line (and do not
+ * change the GSetting).
+ */
public void set_startup_fullscreen_mode ()
{
is_command_line_startup = true;
@@ -1113,6 +1330,9 @@ public class Cheese.MainWindow : Gtk.Window
is_command_line_startup = false;
}
+ /**
+ * Load the UI from the GtkBuilder description.
+ */
public void setup_ui ()
{
gtk_builder = new Gtk.Builder ();
@@ -1238,6 +1458,11 @@ public class Cheese.MainWindow : Gtk.Window
fullscreen_action.active = true;
}
+ /**
+ * Setup the camera listed in GSettings.
+ *
+ * @param uri the uri of the device node to setup, or null
+ */
public void setup_camera (string ? uri)
{
string device;
@@ -1285,6 +1510,10 @@ public class Cheese.MainWindow : Gtk.Window
camera.state_flags_changed.connect (camera_state_changed);
camera.play ();
}
+
+ /**
+ * Setup the thumbview thumbnail monitors.
+ */
public void start_thumbview_monitors ()
{
thumb_view.start_monitoring_video_path (fileutil.get_video_path ());
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
