Top | ![]() |
![]() |
![]() |
![]() |
VisuScalarfieldSetVisuScalarfieldSet — Defines a storage object to gather VisuScalarField objects. |
struct | VisuScalarfieldSet |
struct | VisuScalarfieldSetClass |
struct | VisuScalarfieldSetIter |
A VisuScalarfieldSet object is a storage object for a bunch of VisuScalarField. This object provides methods to iterate over the internal storage.
VisuScalarfieldSet * visu_scalarfield_set_new ();
Creates an object to store several fields and do hiding operations with them.
Since: 3.8
gboolean visu_scalarfield_set_add (VisuScalarfieldSet *set
,const gchar *label
,VisuScalarField *field
);
Adds a field
to the list of stored fields. label
is not
necessarily unique in he set.
set |
a VisuScalarfieldSet object. |
|
label |
a string. |
|
field |
a VisuScalarField object. |
[transfer none] |
Since: 3.8
gboolean visu_scalarfield_set_addFromFile (VisuScalarfieldSet *set
,VisuScalarFieldMethod *meth
,const gchar *filename
,GHashTable *table
,GCancellable *cancel
,GAsyncReadyCallback callback
,gpointer user_data
);
Read the given file and try to load it as a scalar field file. If succeed,
all read fields are added to set
. If table
is given, it means
that the caller routine gives some options to the loader
routine. These options are a set of names and values. If meth
is
NULL
, then all known methods are used to parse filename
.
This is an asynchronous method. Use
visu_scalarfield_set_addFromFileSync()
for a blocking equivalent.
set |
a VisuScalarfieldSet object. |
|
meth |
a VisuScalarFieldMethod object. |
[allow-none] |
filename |
the path to the file to be loaded ;. |
[type filename] |
table |
a set of different options (can be NULL). |
[allow-none] |
cancel |
a GCancellable object. |
[allow-none] |
callback |
a method to call when the load finishes. |
[allow-none] |
user_data |
some user data. |
[scope async] |
Since: 3.8
gboolean visu_scalarfield_set_addFromFileSync (VisuScalarfieldSet *set
,VisuScalarFieldMethod *meth
,const gchar *filename
,GHashTable *table
,GCancellable *cancel
,GError **error
);
As visu_scalarfield_set_addFromFileSync()
, but blocking variant.
set |
a VisuScalarfieldSet object. |
|
meth |
a VisuScalarFieldMethod object. |
[allow-none] |
filename |
the path to the file to be loaded ;. |
[type filename] |
table |
a set of different options (can be NULL). |
[allow-none] |
cancel |
a GCancellable object. |
[allow-none] |
error |
an error location. |
[allow-none] |
Since: 3.8
gboolean visu_scalarfield_set_remove (VisuScalarfieldSet *set
,VisuScalarField *field
);
Remove field
from the list of stored fields.
Since: 3.8
VisuScalarField * visu_scalarfield_set_getAt (const VisuScalarfieldSet *set
,guint i
);
Retrieve the field stored at index i
.
Since: 3.8
guint
visu_scalarfield_set_getLength (const VisuScalarfieldSet *set
);
Retrieve the number of fields stored in set
.
Since: 3.8
const gchar * visu_scalarfield_set_getLabel (const VisuScalarfieldSet *set
,const VisuScalarField *field
);
Retrieve the label that has been associated to field
.
Since: 3.8
VisuScalarfieldSet *
visu_scalarfield_set_getDefault (void
);
Retrieve the default storage for VisuScalarField objects.
Since: 3.8
void
visu_scalarfield_set_class_finalize (void
);
Cleanup function.
[skip]
Since: 3.8
gboolean visu_scalarfield_set_iter_new (const VisuScalarfieldSet *set
,VisuScalarfieldSetIter *iter
);
Creates an iterator on the internal storage of VisuScalarField objects.
Since: 3.8
gboolean
visu_scalarfield_set_iter_next (VisuScalarfieldSetIter *iter
);
Use this function to iterate on field stored in a VisuScalarfieldSet object.
Since: 3.8
struct VisuScalarfieldSetClass { VisuObjectClass parent; };
Common name to refer to a _VisuScalarfieldSetClass.
struct VisuScalarfieldSetIter { const VisuScalarfieldSet *set; VisuScalarField *field; GList *next; };
Structure to iterate over the stored field
of set
.
const VisuScalarfieldSet * |
the VisuScalarfieldSet to iter on. |
|
VisuScalarField * |
the current VisuScalarField. |
|
GList * |
internal index. |
[element-type gpointer] |
Since: 3.8
“added”
signalvoid user_function (VisuScalarfieldSet *set, VisuScalarField *field, gpointer user_data)
This signal is emitted each time a field is added to the set.
set |
the object emitting the signal. |
|
field |
the added VisuScalarField object. |
|
user_data |
user data set when the signal handler was connected. |
Flags: No Hooks
Since: 3.8
“removed”
signalvoid user_function (VisuScalarfieldSet *set, VisuScalarField *field, gpointer user_data)
This signal is emitted each time a field is removed from the set.
set |
the object emitting the signal. |
|
field |
the removed VisuScalarField object. |
|
user_data |
user data set when the signal handler was connected. |
Flags: No Hooks
Since: 3.8