GdauiDataProxy

GdauiDataProxy — Displaying and modifying data in a GdaDataProxy

Stability Level

Stable, unless otherwise indicated

Functions

Signals

void proxy-changed Run First

Types and Values

Object Hierarchy

    GInterface
    ╰── GdauiDataProxy

Prerequisites

GdauiDataProxy requires GtkWidget.

Known Implementations

GdauiDataProxy is implemented by GdauiForm, GdauiGrid, GdauiRawForm and GdauiRawGrid.

Description

The GdauiDataProxy interface is implemented by widgets which allow modifications to a GdaDataModel (through a GdaDataProxy to actually proxy the changes before they are written to the data model).

Functions

gdaui_data_proxy_get_proxy ()

GdaDataProxy *
gdaui_data_proxy_get_proxy (GdauiDataProxy *iface);

Get a pointer to the GdaDataProxy being used by iface

Parameters

iface

an object which implements the GdauiDataProxy interface

 

Returns

a GdaDataProxy pointer.

[transfer none]

Since: 4.2


gdaui_data_proxy_supports_action ()

gboolean
gdaui_data_proxy_supports_action (GdauiDataProxy *iface,
                                  GdauiAction action);

Determines if action can be used on iface (using gdaui_data_proxy_perform_action()).

Parameters

iface

an object which implements the GdauiDataProxy interface

 

action

a GdauiAction action

 

Returns

TRUE if the requested action is supported, FALSE otherwise

Since: 6.0


gdaui_data_proxy_perform_action ()

void
gdaui_data_proxy_perform_action (GdauiDataProxy *iface,
                                 GdauiAction action);

Forces the widget to perform the selected action , as if the user had pressed on the corresponding action button in the iface widget, if the corresponding action is possible and if the iface widget supports the action.

Parameters

iface

an object which implements the GdauiDataProxy interface

 

action

a GdauiAction action

 

Since: 4.2


gdaui_data_proxy_column_set_editable ()

void
gdaui_data_proxy_column_set_editable (GdauiDataProxy *iface,
                                      gint column,
                                      gboolean editable);

Sets if the data entry in the iface widget at column (in the data model iface operates on) can be edited or not.

Parameters

iface

an object which implements the GdauiDataProxy interface

 

column

column number of the data

 

editable

set to TRUE to make the column editable

 

Since: 4.2


gdaui_data_proxy_set_write_mode ()

gboolean
gdaui_data_proxy_set_write_mode (GdauiDataProxy *iface,
                                 GdauiDataProxyWriteMode mode);

Specifies the way the modifications stored in the GdaDataProxy used internally by iface are written back to the GdaDataModel which holds the data displayed in iface .

Parameters

iface

an object which implements the GdauiDataProxy interface

 

mode

the requested GdauiDataProxyWriteMode mode

 

Returns

TRUE if the proposed mode has been taken into account

Since: 4.2


gdaui_data_proxy_get_write_mode ()

GdauiDataProxyWriteMode
gdaui_data_proxy_get_write_mode (GdauiDataProxy *iface);

Get the way the modifications stored in the GdaDataProxy used internally by iface are written back to the GdaDataModel which holds the data displayed in iface .

Parameters

iface

an object which implements the GdauiDataProxy interface

 

Returns

the write mode used by iface

Since: 4.2

Types and Values

enum GdauiDataProxyWriteMode

Defines when the data modifications held in the underlying GdaDataProxy are written to the data model being proxied (using gda_data_proxy_apply_row_changes()).

Members

GDAUI_DATA_PROXY_WRITE_ON_DEMAND

write only when explicitly requested

 

GDAUI_DATA_PROXY_WRITE_ON_ROW_CHANGE

write when the current selected row changes

 

GDAUI_DATA_PROXY_WRITE_ON_VALUE_ACTIVATED

write when user activates a value change

 

GDAUI_DATA_PROXY_WRITE_ON_VALUE_CHANGE

write when a parameters's value changes

 

GDAUI_TYPE_DATA_PROXY

#define GDAUI_TYPE_DATA_PROXY          (gdaui_data_proxy_get_type())

struct GdauiDataProxyInterface

struct GdauiDataProxyInterface {
	GTypeInterface           g_iface;

	/* virtual table */
	GdaDataProxy        *(* get_proxy)           (GdauiDataProxy *iface);
	void                 (* set_column_editable) (GdauiDataProxy *iface, gint column, gboolean editable);
	gboolean             (* supports_action)     (GdauiDataProxy *iface, GdauiAction action);
	void                 (* perform_action)      (GdauiDataProxy *iface, GdauiAction action);
	gboolean             (* set_write_mode)      (GdauiDataProxy *iface, GdauiDataProxyWriteMode mode);
	GdauiDataProxyWriteMode (* get_write_mode)(GdauiDataProxy *iface);

	/* signals */
	void                 (* proxy_changed)       (GdauiDataProxy *iface, GdaDataProxy *proxy);
};

GdauiDataProxy

typedef struct _GdauiDataProxy GdauiDataProxy;

Signal Details

The “proxy-changed” signal

void
user_function (GdauiDataProxy *gdauidataproxy,
               GdaDataProxy   *arg1,
               gpointer        user_data)

The ::proxy-changed signal is emitted each time the GdaDataProxy which would be returned by gdaui_data_proxy_get_proxy() changes. This is generally the result of changes in the structure of the proxied data model (different number and/or type of columns for example).

Parameters

gdauidataproxy

the GdauiDataProxy

 

arg1

the GdaDataProxy which would be returned by gdaui_data_proxy_get_proxy()

 

user_data

user data set when the signal handler was connected.

 

Flags: Run First

See Also

The GdauiDataSelector interface which is usually also implemented by the widgets which implement the GdauiDataProxy interface.