| V_Sim API - Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | ||||
#define VISU_UIMAIN_TYPE #define VISU_UIMAIN (obj) #define VISU_UIMAIN_CLASS (klass) #define IS_VISU_UIMAIN_TYPE (obj) #define IS_VISU_UIMAIN_CLASS (klass) #define VISU_UIMAIN_GET_CLASS (obj) typedef VisuUiMain_private; VisuUiMain; VisuUiMainClass; GType visu_ui_main_get_type (void); GtkWidget* visu_ui_main_new (gboolean oneWindow); void visu_ui_main_quit (VisuUiMain *main,gboolean force); void visu_ui_main_buildInteractiveDialog (VisuUiMain *main); gboolean visu_ui_main_runCommandLine (gpointer data); gboolean visu_ui_main_initPanels (gpointer data); void visu_uiMainClass_setRememberPosition (gboolean val); gboolean visu_uiMainClass_getRememberPosition (); VisuUiMain* visu_uiMainClass_getCurrentPanel (); void gtkMainClassSet_currentPanel (VisuUiMain *main); void visu_uiMainClass_createMain (GtkWindow **panel,GtkWindow **renderWindow,GtkWidget **renderArea); VisuRenderingWindow* visu_uiMainClass_getDefaultRendering ();
GObject +----GInitiallyUnowned +----GtkObject +----GtkWidget +----GtkContainer +----GtkBin +----GtkWindow +----VisuUiMain
#define VISU_UIMAIN(obj) (G_TYPE_CHECK_INSTANCE_CAST(obj, VISU_UIMAIN_TYPE, VisuUiMain))
Cast the given obj into VisuUiMain type.
|
a GObject to cast. |
#define VISU_UIMAIN_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST(klass, VISU_UIMAIN_TYPE, VisuUiMainClass))
Cast the given klass into VisuUiMainClass.
|
a GObjectClass to cast. |
#define IS_VISU_UIMAIN_TYPE(obj) (G_TYPE_CHECK_INSTANCE_TYPE(obj, VISU_UIMAIN_TYPE))
Test if the given ogj is of the type of VisuUiMain object.
|
a GObject to test. |
#define IS_VISU_UIMAIN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE(klass, VISU_UIMAIN_TYPE))
Test if the given klass is of the type of VisuUiMainClass class.
|
a GObjectClass to test. |
#define VISU_UIMAIN_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS(obj, VISU_UIMAIN_TYPE, VisuUiMainClass))
It returns the class of the given obj.
|
a GObject to get the class of. |
typedef struct VisuUiMain_private_struct VisuUiMain_private;
Private fields for VisuUiMain objects.
typedef struct _VisuUiMainClass VisuUiMainClass;
A short way to identify _VisuUiMainClass structure.
GType visu_ui_main_get_type (void);
This method returns the type of VisuUiMain, use VISU_UIMAIN_TYPE instead.
Returns : |
the type of VisuUiMain. |
GtkWidget* visu_ui_main_new (gboolean oneWindow);
Create the command panel window and is dependencies, such as the
associated rendering window... WARNING: some part are still currently
static, so only once instance can be created at a time. If
oneWindow argument is TRUE, then the rendering area is creating in
the same GtkWindow on the right of the panel.
|
a boolean. |
Returns : |
a newly create command panel. |
void visu_ui_main_quit (VisuUiMain *main,gboolean force);
Quit the program. If the preference to have a confirm dialog is set, then it raises the little warning window before quiting (or not).
|
a pointer to the main interface. |
|
if TRUE, override the preference of a quiting dialog and quit. |
void visu_ui_main_buildInteractiveDialog (VisuUiMain *main);
Create the mouse action dialog window (if not already done).
|
a VisuUiMain object. |
gboolean visu_ui_main_runCommandLine (gpointer data);
Call the get routines from the command line module and associate
the different tasks to the different panels. For a version that do
not use the panels, call visuGtkRun_commandLine() instead.
|
a pointer on a VisuUiMain object. |
Returns : |
always FALSE. |
gboolean visu_ui_main_initPanels (gpointer data);
Call the init routines for the different panels.
|
a pointer on a VisuUiMain object. |
Returns : |
always FALSE. |
void visu_uiMainClass_setRememberPosition
(gboolean val);
V_Sim can try to remember the position of its main windows, then open them again will result in a positioning on screen equivalent to previous position.
|
an boolean. |
gboolean visu_uiMainClass_getRememberPosition ();
V_Sim can store the position of its main windows. Use this routine to get the status of this capability.
Returns : |
TRUE if set. |
VisuUiMain* visu_uiMainClass_getCurrentPanel ();
This routine can be used to get the command panel, everywhere from V_Sim.
Returns : |
the command Panel.. transfer full. |
void gtkMainClassSet_currentPanel (VisuUiMain *main);
After having created the command panel with visu_ui_main_new(), use this
routine to declare it as the current command panel.
|
a command panel. |
void visu_uiMainClass_createMain (GtkWindow **panel,GtkWindow **renderWindow,GtkWidget **renderArea);
A convenience routine to create a command panel, a rendering window and links them together.
VisuRenderingWindow* visu_uiMainClass_getDefaultRendering ();
Get the rendering window of V_Sim.
Returns : |
the rendering window.. transfer none. |