| V_Sim API - Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | Signals | ||||
gtk_shadeComboBoxWidgetgtk_shadeComboBoxWidget — Defines a specialised GtkComboBox to choose pre-built shades. |
#include <coreTools/toolShade.h>
VisuUiShadeCombobox;
VisuUiShadeComboboxClass;
GdkPixbuf * visu_ui_shade_combobox_buildStamp (ToolShade *shade,
GdkPixbuf *pixbuf);
ToolShade * visu_ui_shade_combobox_getSelection (VisuUiShadeCombobox *shadeComboBox);
GdkPixbuf * visu_ui_shade_combobox_getStamp (VisuUiShadeCombobox *shadeComboBox,
ToolShade *shade);
GtkWidget * visu_ui_shade_combobox_new (gboolean hasAlphaChannel,
gboolean showNames);
gboolean visu_ui_shade_combobox_setSelectionByShade
(VisuUiShadeCombobox *shadeComboBox,
ToolShade *shade);
GObject +----GInitiallyUnowned +----GtkWidget +----GtkContainer +----GtkBin +----GtkComboBox +----VisuUiShadeCombobox
VisuUiShadeCombobox implements AtkImplementorIface, GtkBuildable, GtkCellLayout and GtkCellEditable.
This widget looks like a GtkComboBox and it displays a list of preset colour shades. These patterns are defined by colour parameters, see ToolShade.
This widget can emit a "shade-selected" signal that is a wrapper around the "changed" signal, but it is emitted only when a new shade is selected and this shade is passed to the callback.
typedef struct _VisuUiShadeCombobox VisuUiShadeCombobox;
Private structure to store informations of a VisuUiShadeCombobox object.
Since 3.3
typedef struct _VisuUiShadeComboboxClass VisuUiShadeComboboxClass;
Private structure to store informations of a VisuUiShadeComboboxClass object.
Since 3.3
GdkPixbuf * visu_ui_shade_combobox_buildStamp (ToolShade *shade,GdkPixbuf *pixbuf);
This method is used to create pixbuf representing shades. If pixbuf is given,
it must be a valid pixbuf, and the shade is created in it. Otherwise, a new
pixbuf is created.
|
a ToolShade object ; |
|
an existing pixbuf (can be NULL). [inout][allow-none] |
Returns : |
a pixbuf pointer. [transfer full] |
Since 3.3
ToolShade * visu_ui_shade_combobox_getSelection (VisuUiShadeCombobox *shadeComboBox);
The user can access to the selected ToolShade object using this method.
|
a VisuUiShadeCombobox widget. |
Returns : |
a pointer to the selected ToolShade object (or NULL). This object is read-only. [transfer none] |
Since 3.3
GdkPixbuf * visu_ui_shade_combobox_getStamp (VisuUiShadeCombobox *shadeComboBox,ToolShade *shade);
The shadeComboBox has little pixbufs to represent the shade. User methods can
use these pixbufs but should considered them read-only.
|
a VisuUiShadeCombobox widget ; |
|
a ToolShade object. |
Returns : |
a pixbuf pointer corresponding to the
little image shown on the shadeComboBox. [transfer none]
|
Since 3.3
GtkWidget * visu_ui_shade_combobox_new (gboolean hasAlphaChannel,gboolean showNames);
A VisuUiShadeCombobox widget is like a GtkComboBox widget, but it is already filled
with the known shades. Using this widget
is a convienient way to share shades between all part of V_Sim and to give a consistent
look of all shade selection. If the argument hasAlphaChannel is FALSE, the widget
display all shades but without their alpha channel, assuming it to be fully opaque.
|
a boolean. |
|
if TRUE, the names of the shades are displayed. |
Returns : |
a newly created VisuUiShadeCombobox widget. [transfer full] |
Since 3.3
gboolean visu_ui_shade_combobox_setSelectionByShade (VisuUiShadeCombobox *shadeComboBox,ToolShade *shade);
Use this method to set the ComboBox on the given shade. This emits a 'shade-channel' signal if the shade is changed, which means, a previous shade has been modified, or a new shade is selected.
|
a VisuUiShadeCombobox widget ; |
|
a ToolShade object. |
Returns : |
TRUE if the shade already exists in the model. |
Since 3.3
"shade-selected" signalvoid user_function (VisuUiShadeCombobox *combo,
gpointer shade,
gpointer user_data) : Action
This signal is emitted when a new valid colour shade is selected.
|
the VisuUiShadeCombobox that emits the signal ; |
|
the newly selected ToolShade. |
|
user data set when the signal handler was connected. |
Since 3.3