gtk_main

gtk_main — The command panel definition.

Synopsis

struct              VisuUiMain;
                    VisuUiMainClass;
typedef             VisuUiMain_private;
void                visu_ui_main_buildInteractiveDialog (VisuUiMain *main);
void                visu_ui_main_class_createMain       (GtkWindow **panel,
                                                         GtkWindow **renderWindow,
                                                         GtkWidget **renderArea);
VisuUiMain *        visu_ui_main_class_getCurrentPanel  ();
VisuUiRenderingWindow * visu_ui_main_class_getDefaultRendering
                                                        ();
gboolean            visu_ui_main_class_getRememberPosition
                                                        ();
void                visu_ui_main_class_setCurrentPanel  (VisuUiMain *main);
void                visu_ui_main_class_setRememberPosition
                                                        (gboolean val);
gboolean            visu_ui_main_initPanels             (gpointer data);
GtkWidget *         visu_ui_main_new                    (gboolean oneWindow);
void                visu_ui_main_quit                   (VisuUiMain *main,
                                                         gboolean force);
gboolean            visu_ui_main_runCommandLine         (gpointer data);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkWidget
               +----GtkContainer
                     +----GtkBin
                           +----GtkWindow
                                 +----VisuUiMain

Implemented Interfaces

VisuUiMain implements AtkImplementorIface and GtkBuildable.

Signals

  "DataFocused"                                    : No Hooks

Description

This is the main interface in V_Sim. It hosts the common action buttons, like open a file, save resources, switch to interactive session... It also hosts the different panels.

Details

struct VisuUiMain

struct VisuUiMain;

Structure to describe the main interface of V_Sim.


VisuUiMainClass

typedef struct _VisuUiMainClass VisuUiMainClass;

A short way to identify _VisuUiMainClass structure.


VisuUiMain_private

typedef struct VisuUiMain_private_struct VisuUiMain_private;

Private fields for VisuUiMain objects.


visu_ui_main_buildInteractiveDialog ()

void                visu_ui_main_buildInteractiveDialog (VisuUiMain *main);

Create the mouse action dialog window (if not already done).

main :

a VisuUiMain object.

visu_ui_main_class_createMain ()

void                visu_ui_main_class_createMain       (GtkWindow **panel,
                                                         GtkWindow **renderWindow,
                                                         GtkWidget **renderArea);

A convenience routine to create a command panel, a rendering window and links them together.

panel :

a location for a VisuUiMain panel ;

renderWindow :

a location for a GtkWindow ;

renderArea :

a location for a GtkWidget.

visu_ui_main_class_getCurrentPanel ()

VisuUiMain *        visu_ui_main_class_getCurrentPanel  ();

This routine can be used to get the command panel, everywhere from V_Sim.

Returns :

the command Panel. [transfer none]

visu_ui_main_class_getDefaultRendering ()

VisuUiRenderingWindow * visu_ui_main_class_getDefaultRendering
                                                        ();

Get the rendering window of V_Sim.

Returns :

the rendering window. [transfer none]

visu_ui_main_class_getRememberPosition ()

gboolean            visu_ui_main_class_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.

visu_ui_main_class_setCurrentPanel ()

void                visu_ui_main_class_setCurrentPanel  (VisuUiMain *main);

After having created the command panel with visu_ui_main_new(), use this routine to declare it as the current command panel.

main :

a command panel.

visu_ui_main_class_setRememberPosition ()

void                visu_ui_main_class_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.

val :

an boolean.

visu_ui_main_initPanels ()

gboolean            visu_ui_main_initPanels             (gpointer data);

Call the init routines for the different panels.

data :

a pointer on a VisuUiMain object.

Returns :

always FALSE.

visu_ui_main_new ()

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.

oneWindow :

a boolean.

Returns :

a newly create command panel.

visu_ui_main_quit ()

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).

main :

a pointer to the main interface.

force :

if TRUE, override the preference of a quiting dialog and quit.

visu_ui_main_runCommandLine ()

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 visu_ui_runCommandLine() instead.

data :

a pointer on a VisuUiMain object.

Returns :

always FALSE.

Signal Details

The "DataFocused" signal

void                user_function                      (VisuUiMain *ui,
                                                        GObject    *dataObj,
                                                        gpointer    user_data)      : No Hooks

This signal is emitted when dataObj has been displayed on the rendering window and is ready for use.

ui :

the object which received the signal ;

dataObj :

the newly associated VisuData object.

user_data :

user data set when the signal handler was connected.

Since 3.7