## UnicapgtkDeviceSelection

UnicapgtkDeviceSelection

## Synopsis

                        UnicapgtkDeviceSelection;
    GtkWidget*          unicapgtk_device_selection_new      (gboolean include_rescan_entry);
    gint                unicapgtk_device_selection_rescan   (UnicapgtkDeviceSelection *combo);
    gboolean            unicapgtk_device_selection_set_device
                                                            (UnicapgtkDeviceSelection *combo,
                                                             unicap_device_t *device);
    void                unicapgtk_device_selection_set_label_fmt
                                                            (UnicapgtkDeviceSelection *combo,
                                                             const gchar *fmt);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkObject
                   +----GtkWidget
                         +----GtkContainer
                               +----GtkBin
                                     +----GtkComboBox
                                           +----UnicapgtkDeviceSelection

## Implemented Interfaces

UnicapgtkDeviceSelection implements AtkImplementorIface, GtkBuildable, GtkCellLayout and GtkCellEditable.

## Properties

      "include-rescan-entry"     gboolean              : Read / Write / Construct Only

## Signals

      "unicapgtk-device-selection-changed"             : Run First / Action

## Description

## Details

### UnicapgtkDeviceSelection

    typedef struct _UnicapgtkDeviceSelection UnicapgtkDeviceSelection;

### unicapgtk_device_selection_new ()

    GtkWidget*          unicapgtk_device_selection_new      (gboolean include_rescan_entry);

Creates a new UnicapgtkDeviceSelection

`include_rescan_entry` : | if TRUE, the an entry will get added to the combo box allowing the user to manually trigger a device rescan
Returns : | a new UnicapgtkDeviceSelection

### unicapgtk_device_selection_rescan ()

    gint                unicapgtk_device_selection_rescan   (UnicapgtkDeviceSelection *combo);

Tiggers rescan of available video capture devices and updates the combo box.

`combo` : | an UnicapgtkDeviceSelection
Returns : | number of available devices

### unicapgtk_device_selection_set_device ()

    gboolean            unicapgtk_device_selection_set_device
                                                            (UnicapgtkDeviceSelection *combo,
                                                             unicap_device_t *device);

Sets the combo box to the given device.

`combo` : | a UnicapgtkDeviceSelection
`device` : | a unicap_device_t
Returns : | TRUE on success

### unicapgtk_device_selection_set_label_fmt ()

    void                unicapgtk_device_selection_set_label_fmt
                                                            (UnicapgtkDeviceSelection *combo,
                                                             const gchar *fmt);

Sets the format string for the device labels. The following special sequences are currently supported:

%`i`: Identifier

%`v`: Vendor Name

%`m`: Model Name

%`s`: Model Id, hexadecimal with lowercase letters

%`S`: Model Id, hexadecimal with uppercase letters

%`p`: Vendor Id, hexadecimal with lowercase letters

%`P`: Vendor Id, hexadecimal with uppercase letters

`combo` : | a UnicapgtkDeviceSelection
`fmt` : | a format string

## Property Details

### The `"include-rescan-entry"` property

      "include-rescan-entry"     gboolean              : Read / Write / Construct Only

Default value: FALSE

## Signal Details

### The `"unicapgtk-device-selection-changed"` signal

    void                user_function                      (UnicapgtkDeviceSelection *unicapgtkdeviceselection,
                                                            gpointer                  arg1,
                                                            gpointer                  user_data)                     : Run First / Action

`unicapgtkdeviceselection` : | the object which received the signal.
`arg1` : |
`user_data` : | user data set when the signal handler was connected.