| GNOME Color Manager Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Properties | ||||
#define GCM_DDC_CONTROL_ERROR #define GCM_DDC_CONTROL_TYPE_ERROR enum GcmDdcControlError; GcmDdcControlPrivate; GcmDdcControl; GcmDdcControlClass; GcmDdcControlCap; #define GCM_DDC_CONTROL_ID_BRIGHTNESS GQuark gcm_ddc_control_error_quark (void); GcmDdcControl * gcm_ddc_control_new (void); void gcm_ddc_control_parse (GcmDdcControl *control,guchar id,const gchar *values); void gcm_ddc_control_set_device (GcmDdcControl *control,GcmDdcDevice *device); void gcm_ddc_control_set_verbose (GcmDdcControl *control,GcmVerbose verbose); gboolean gcm_ddc_control_run (GcmDdcControl *control,GError **error); gboolean gcm_ddc_control_request (GcmDdcControl *control,guint16 *value,guint16 *maximum,GError **error); gboolean gcm_ddc_control_set (GcmDdcControl *control,guint16 value,GError **error); gboolean gcm_ddc_control_reset (GcmDdcControl *control,GError **error); guchar gcm_ddc_control_get_id (GcmDdcControl *control); const gchar * gcm_ddc_control_get_description (GcmDdcControl *control); GArray * gcm_ddc_control_get_values (GcmDdcControl *control);
typedef enum
{
GCM_DDC_CONTROL_ERROR_FAILED
} GcmDdcControlError;
Errors that can be thrown
typedef struct _GcmDdcControlPrivate GcmDdcControlPrivate;
Private GcmDdcControl data
typedef struct {
GObjectClass parent_class;
/* padding for future expansion */
void (*_gcm_reserved1) (void);
void (*_gcm_reserved2) (void);
void (*_gcm_reserved3) (void);
void (*_gcm_reserved4) (void);
void (*_gcm_reserved5) (void);
} GcmDdcControlClass;
GQuark gcm_ddc_control_error_quark (void);
Returns : |
Our personal error quark. |
Since 0.0.1
GcmDdcControl * gcm_ddc_control_new (void);
Get a control objects.
Returns : |
A new GcmDdcControl instance
|
Since 0.0.1
void gcm_ddc_control_parse (GcmDdcControl *control,guchar id,const gchar *values);
Parses a control string for permissable values.
|
A valid GcmDdcControl |
|
the control ID, e.g. GCM_DDC_CONTROL_ID_BRIGHTNESS
|
|
a string of permissible values, e.g. "1 3 5 7 8 9" or NULL
|
Since 0.0.1
void gcm_ddc_control_set_device (GcmDdcControl *control,GcmDdcDevice *device);
Set the device that this control belongs to.
|
A valid GcmDdcControl |
|
the device that owns this control. |
Since 0.0.1
void gcm_ddc_control_set_verbose (GcmDdcControl *control,GcmVerbose verbose);
Set the control verbosity.
|
A valid GcmDdcControl |
|
if the control should log to stderr. |
Since 0.0.1
gboolean gcm_ddc_control_run (GcmDdcControl *control,GError **error);
Runs the control. Note, this only makes sense for true controls like 'degauss' rather than other VCP values such as 'contrast'.
|
A valid GcmDdcControl |
|
a GError, or NULL
|
Returns : |
TRUE for success
|
Since 0.0.1
gboolean gcm_ddc_control_request (GcmDdcControl *control,guint16 *value,guint16 *maximum,GError **error);
Get the value of this control.
|
A valid GcmDdcControl |
|
the value location to write into |
|
the value maximum location to write into |
|
a GError, or NULL
|
Returns : |
TRUE for success
|
Since 0.0.1
gboolean gcm_ddc_control_set (GcmDdcControl *control,guint16 value,GError **error);
Sets the control value.
|
A valid GcmDdcControl |
|
the value to write |
|
a GError, or NULL
|
Returns : |
TRUE for success
|
Since 0.0.1
gboolean gcm_ddc_control_reset (GcmDdcControl *control,GError **error);
Resets the control to it's default value.
|
A valid GcmDdcControl |
|
a GError, or NULL
|
Returns : |
TRUE for success
|
Since 0.0.1
guchar gcm_ddc_control_get_id (GcmDdcControl *control);
Gets the ID for this control.
|
A valid GcmDdcControl |
Returns : |
The control ID, e.g. GCM_DDC_CONTROL_ID_BRIGHTNESS |
Since 0.0.1
const gchar * gcm_ddc_control_get_description (GcmDdcControl *control);
Gets the string description for the control.
|
A valid GcmDdcControl |
Returns : |
A string value, or NULL
|
Since 0.0.1
GArray * gcm_ddc_control_get_values (GcmDdcControl *control);
Gets the permissible values of this control.
|
A valid GcmDdcControl |
Returns : |
A GArray of guint16 values, free with g_array_unref().
|
Since 0.0.1
"supported" property"supported" gboolean : Read
if there are no transactions in progress on this control.
Default value: TRUE
Since 0.0.1