VisuUiPlaneList

VisuUiPlaneList — Defines a GtkListStore specialised to store VisuPlanes.

Functions

Properties

VisuPlane * selection Read / Write

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── GtkListStore
        ╰── VisuUiPlaneList

Implemented Interfaces

VisuUiPlaneList implements GtkTreeModel, GtkTreeDragSource, GtkTreeDragDest, GtkTreeSortable and GtkBuildable.

Description

It provides a Gtk wrapper around VisuPlaneSet object to store VisuPlanes.

It also can creates GtkTreeView and control widgets to display itself.

Functions

visu_ui_plane_list_new ()

VisuUiPlaneList *
visu_ui_plane_list_new ();

Create a new GtkListStore to store planes.

Returns

a newly created object.

Since: 3.8


visu_ui_plane_list_getModel ()

VisuPlaneSet *
visu_ui_plane_list_getModel (const VisuUiPlaneList *list);

Retrieve the VisuPlaneSet object that list is built upon.

Parameters

list

a VisuUiPlaneList object.

 

Returns

a VisuPlaneSet object.

[transfer none]

Since: 3.8


visu_ui_plane_list_setModel ()

gboolean
visu_ui_plane_list_setModel (VisuUiPlaneList *list,
                             VisuPlaneSet *set);

Bind the set object to list .

Parameters

list

a VisuUiPlaneList object.

 

set

a VisuPlaneSet object.

[allow-none]

Returns

TRUE if set is changed


visu_ui_plane_list_getView ()

GtkWidget *
visu_ui_plane_list_getView (VisuUiPlaneList *list);

Retrieve a treeview and a side toolbar that displays the list of planes of the model.

Parameters

list

a VisuUiPlaneList object.

 

Returns

widgets are created if needed.

[transfer full]

Since: 3.8


visu_ui_plane_list_getControls ()

GtkBox *
visu_ui_plane_list_getControls (VisuUiPlaneList *list);

Retrieve the GtkBox object with the GtkWidget to control the selected plane in the treeview of list .

Parameters

list

a VisuUiPlaneList object.

 

Returns

widgets are created if needed.

[transfer full]

Since: 3.8


visu_ui_plane_list_getSelection ()

VisuPlane *
visu_ui_plane_list_getSelection (const VisuUiPlaneList *list);

Retrieve the selected VisuPlane, or NULL if no selection.

Parameters

list

a VisuUiPlaneList object.

 

Returns

a VisuPlane object or NULL.

[transfer none]

Since: 3.8


visu_ui_plane_list_getAt ()

VisuPlane *
visu_ui_plane_list_getAt (VisuUiPlaneList *list,
                          guint i);

Retrieve the VisuPlane object, stored at the place i in list .

Parameters

list

a VisuUiPlaneList object.

 

i

an integer.

 

Returns

a VisuPlane object or NULL.

[transfer full]

Since: 3.8

Types and Values

struct VisuUiPlaneList

struct VisuUiPlaneList;

Common name to refer to a _VisuUiPlaneList.


struct VisuUiPlaneListClass

struct VisuUiPlaneListClass {
  GtkListStoreClass parent;
};

Common name to refer to a _VisuUiPlaneListClass.

Members

GtkListStoreClass parent;

private.

 

enum VisuUiPlaneListColumnId

Thesse are the description of the columns stored in the object.

Members

VISU_UI_PLANE_LIST_POINTER

the pointer to the VisuPlane object.

 

VISU_UI_PLANE_LIST_NOTIFY

a handler of the VisuPlane::notify signal.

 

VISU_UI_PLANE_LIST_MODE

cache the hidding side of the plane when plane is not hiding.

 

VISU_UI_PLANE_LIST_N_COLUMNS

the number of columns.

 

Property Details

The “selection” property

  “selection”                VisuPlane *

current selection.

Flags: Read / Write

Signal Details

The “align” signal

void
user_function (VisuUiPlaneList *list,
               VisuPlane       *plane,
               gpointer         user_data)

This signal is emitted each time the user request to align with a plane.

Parameters

list

the object emitting the signal.

 

plane

the requested VisuPlane object for alignment.

 

user_data

user data set when the signal handler was connected.

 

Flags: No Hooks

Since: 3.8