![]() |
![]() |
![]() |
V_Sim API - Reference Manual | ![]() |
---|---|---|---|---|
Top | Description |
GtkWidget * (*VisuUiPairsBuildWidgetsFunc) (); void (*VisuUiPairsInitFunc) (void
); struct VisuUiPairsIter; void (*VisuUiPairsSetValuesFunc) (VisuPairLink *data
); gchar * (*VisuUiPairsToLabelFunc) (VisuPairLink *data
); void visu_ui_pairs_init (); void visu_ui_pairs_initBuild (VisuUiMain *main
); void visu_ui_pairs_iter_empty (VisuUiPairsIter *iter
); void visu_ui_pairs_iter_nextSelected (VisuUiPairsIter *iter
); void visu_ui_pairs_iter_startSelected (VisuUiPairsIter *iter
); void visu_ui_pairs_newIter (VisuUiPairsIter *iter
); gboolean visu_ui_pairs_select (const VisuPairLink *data
); void visu_ui_pairs_setSpecificLabels (GtkTreeIter *iter
,const gchar *label
); void visu_ui_pairs_show (VisuUiMain *main
); void visu_ui_pairs_update (VisuUiMain *main
,VisuData *dataObj
,gboolean force
);
The pair dialog provides a list of pairs as min/max distances between species to draw pairs. A set of two species can have several pairs drawn.
This dialog also hosts widgets that depend on the pair method that is used for a given link.
Finally, it has also a second tab where a graph of g(r) can be drawn.
GtkWidget * (*VisuUiPairsBuildWidgetsFunc) ();
Prototype of functions that create a container GtkWidgets will all element needed to change characteristic of a model.
Returns : |
a newly allocated GtkWidget. |
void (*VisuUiPairsInitFunc) (void
);
Prototype of functions called once on V_Sim start-up.
struct VisuUiPairsIter { VisuElement *ele1; VisuElement *ele2; VisuPairLink *data; GtkTreeIter iter; /* Private data. */ GList *selected; GList *current; };
An iterator on pairs.
VisuElement * |
the VisuElement on one side ; |
VisuElement * |
the VisuElement on the other side ; |
VisuPairLink * |
the VisuPairLink information on the link between ele1 and
ele2 ; |
GtkTreeIter |
the GtkTreeIter corresponding to this link ; |
GList * |
a private attribute ; |
GList * |
an other private attribute. |
void (*VisuUiPairsSetValuesFunc) (VisuPairLink *data
);
Prototype of functions used to update the widgets with given pair data
.
|
informations about a pair. |
gchar * (*VisuUiPairsToLabelFunc) (VisuPairLink *data
);
Create a string, internationalised and in UTF-8, that describes the
given pair data
. This string is used in a column tree view to
summarize the pair description.
|
information about a pair. |
Returns : |
a newly created string. |
void visu_ui_pairs_init ();
Initialise the default values for the pair dialog. It does not build
the interface, use visu_ui_pairs_initBuild()
to do it.
void visu_ui_pairs_initBuild (VisuUiMain *main
);
Create the dialog window for pairs.
|
the command panel the about dialog is associated to. |
void visu_ui_pairs_iter_empty (VisuUiPairsIter *iter
);
Free internals of the iterator. This routine is automatically
called by visu_ui_pairs_iter_nextSelected()
when arriving at the
end of selection.
|
an iterator. |
Since 3.7
void visu_ui_pairs_iter_nextSelected (VisuUiPairsIter *iter
);
Go to the next selected pair or set iter->data to NULL if none.
|
an iterator. |
void visu_ui_pairs_iter_startSelected (VisuUiPairsIter *iter
);
Initialise the given iterator iter
on the first selected pair or
set iter->data to NULL if none. If iter->data
is not NULL,
visu_ui_pairs_iter_nextSelected()
must be called until iter->data
is
NULL to be sure that iter->selected
list is freed.
|
an iterator. [out caller-allocates] |
void visu_ui_pairs_newIter (VisuUiPairsIter *iter
);
This method is used by bindings to initialise a new VisuUiPairsIter object.
|
an iterator. [out caller-allocates] |
Since 3.7
gboolean visu_ui_pairs_select (const VisuPairLink *data
);
Select in the UI the given data
.
|
a VisuPairLink object. |
Returns : |
TRUE if the data pair is indeed selected. |
Since 3.7
void visu_ui_pairs_setSpecificLabels (GtkTreeIter *iter
,const gchar *label
);
Change the specific label shown in the treeview of pairs for the given iter. An iter in this treeview can be retrieve using the _VisuUiPairsIter objects.
|
the GtkTreeIter to set the label ; |
|
the value of the label to be set. |
void visu_ui_pairs_show (VisuUiMain *main
);
Shows the pairs dialog and run possible update of the interface.
|
the container for pairs dialog. |
Since 3.6
void visu_ui_pairs_update (VisuUiMain *main
,VisuData *dataObj
,gboolean force
);
Update the list of pairs. This routine must be called only after
visu_ui_pairs_initBuild()
has been called. The job is done only if the
window is visible or if the force
argument is used.
|
the command panel the about dialog is associated to ; |
|
the VisuData the pairs are related to (can be NULL, if none is loaded) ; |
|
build the pairs even if the window is hidden. |