| Top | |
|
|
|
The GdaUiDataEntry is an interface for widgets (simple or complex) which lets the user view and/or modify a GValue.
This interface is implemented by widgets which feature data editing (usually composed of an editing area and a button to have some more control on the value being edited). The interface allows to control how the widget works and to query the value and the attributes of the data held by the widget.
The widget can store the original value (to be able to tell if the value has been changed by the user) and a default value (which will be returned if the user explicitly forces the widget to be set to the default value). Control methods allow to set the type of value to be edited (the requested type must be compatible with what the widget can handle), set the value (which replaces the currently edited value), set the value and the original value (the value passed as argument is set and is also considered to be the original value).
GdaUiDataEntry widgets are normally created using the gdaui_new_data_entry() function.
void gdaui_data_entry_set_value_type (GdauiDataEntry *de,GType type);
Sets the type of value the GdauiDataEntry will handle. The type must be compatible with what the widget can handle.
de |
a GtkWidget object which implements the GdauiDataEntry interface |
|
type |
the GType of the data to be displayed |
Since: 4.2
GType
gdaui_data_entry_get_value_type (GdauiDataEntry *de);
Fetch the type of data the GdauiDataEntry handles
Since: 4.2
void gdaui_data_entry_set_value (GdauiDataEntry *de,const GValue *value);
Push a value into the GdauiDataEntry. The value parameter must either be:
of type GDA_TYPE_NULL (may be created using gda_value_new_null()) to
represent a NULL value (SQL NULL), or
of type specified using gdaui_data_entry_set_value_type(), or
NULL to represent an undetermined value (usually an error)
Since: 4.2
GValue *
gdaui_data_entry_get_value (GdauiDataEntry *de);
Fetch the value held in the GdauiDataEntry widget. If the value is set to NULL,
the returned value is of type GDA_TYPE_NULL. If the value is set to default,
then the returned value is of type GDA_TYPE_NULL or is the default value if it
has been provided to the widget (and is of the same type as the one provided by de
).
Since: 4.2
gboolean gdaui_data_entry_content_is_valid (GdauiDataEntry *de,GError **error);
gdaui_data_entry_content_is_valid has been deprecated since version 5.2 and should not be used in newly-written code.
Tests the validity of de
's contents. The validity is a determined from:
the de widget itself if it is capable of doing it (depending on the implementation)
the results of the "contents-valid" signal which can be connected from
[skip]
de |
a GtkWidget object which implements the GdauiDataEntry interface |
|
error |
a place to store an error, or |
[allow-none] |
Since: 4.2
void gdaui_data_entry_set_reference_value (GdauiDataEntry *de,const GValue *value);
Push a value into the GdauiDataEntry in the same way as gdaui_data_entry_set_value() but
also sets this value as the reference value.
Since: 4.2
const GValue *
gdaui_data_entry_get_reference_value (GdauiDataEntry *de);
Fetch the reference value held in the GdauiDataEntry widget
Since: 4.2
void
gdaui_data_entry_set_reference_current
(GdauiDataEntry *de);
Tells that the current value in de
is to be considered as the reference value
Since: 4.2
void gdaui_data_entry_set_default_value (GdauiDataEntry *de,const GValue *value);
Sets the default value for the GdauiDataEntry which gets displayed when the user forces the default value. If it is not set then it is set to type GDA_TYPE_NULL. The value parameter must either be:
NULL or of type GDA_TYPE_NULL, or
of type specified using gdaui_data_entry_set_value_type().
Since: 4.2
void gdaui_data_entry_set_attributes (GdauiDataEntry *de,GdaValueAttribute attrs,GdaValueAttribute mask);
Sets the parameters of the GdauiDataEntry. Only the attributes corresponding to the mask are set, the other ones are ignored.
de |
a GtkWidget object which implements the GdauiDataEntry interface |
|
attrs |
the attributes to set (OR'ed between them) |
|
mask |
the mask corresponding to the considered attributes |
Since: 4.2
GdaValueAttribute
gdaui_data_entry_get_attributes (GdauiDataEntry *de);
Retrieves the parameters of the GdauiDataEntry widget.
Since: 4.2
GdaDataHandler *
gdaui_data_entry_get_handler (GdauiDataEntry *de);
Fetch the GdaDataHandler the GdauiDataEntry is using
Since: 4.2
gboolean gdaui_data_entry_can_expand (GdauiDataEntry *de,gboolean horiz);
gdaui_data_entry_can_expand has been deprecated since version 5.2 and should not be used in newly-written code.
use the GtkWidget::hexpand, GtkWidget::wexpand or GtkWidget::expand properties
Used for the layout of GdaDataEntry widgets in containers: queries if de
requires
horizontal or vertical expansion, depending on horiz
de |
a GtkWidget object which implements the GdauiDataEntry interface |
|
horiz |
|
Since: 4.2
void gdaui_data_entry_set_editable (GdauiDataEntry *de,gboolean editable);
Set if de
can be modified or not by the user
de |
a GtkWidget object which implements the GdauiDataEntry interface |
|
editable |
set to |
Since: 4.2
gboolean
gdaui_data_entry_get_editable (GdauiDataEntry *de);
Tells if de
can be edited by the user
Since: 4.2
void
gdaui_data_entry_grab_focus (GdauiDataEntry *de);
Makes de
grab the focus for the window it's in
Since: 4.2
void gdaui_data_entry_set_unknown_color (GdauiDataEntry *de,gdouble red,gdouble green,gdouble blue,gdouble alpha);
Defines the color to be used when de
displays an invalid value. Any value not
between 0. and 1. will result in the default hard coded values to be used (grayish).
de |
a GtkWidget object which implements the GdauiDataEntry interface |
|
red |
the red component of a color |
|
green |
the green component of a color |
|
blue |
the blue component of a color |
|
alpha |
the alpha component of a color |
Since: 5.0.3