StippleComboBox

StippleComboBox — Defines a specialised GtkComboBox to choose patterns for lines.

Synopsis




            StippleComboBox;
GtkWidget*  stippleComboBox_new             ();
void        stippleComboBoxAdd_pattern      (StippleComboBox *stippleComboBox,
                                             guint16 stipple);
guint16     stippleComboBoxGet_selectedStipple
                                            (StippleComboBox *stippleComboBox);
GdkPixbuf*  stippleComboBoxGet_pixbufFromStipple
                                            (StippleComboBox *stippleComboBox,
                                             guint16 stipple);
gboolean    stippleComboBoxSet_selectionByStipple
                                            (StippleComboBox *stippleComboBox,
                                             guint16 stipple);
GdkPixbuf*  stippleComboBoxBuild_stippleStamp
                                            (guint16 stipple);

Object Hierarchy


  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBin
                                 +----GtkComboBox
                                       +----StippleComboBox

Implemented Interfaces

StippleComboBox implements AtkImplementorIface, GtkCellLayout and GtkCellEditable.

Signals


"stipple-selected"
            void        user_function      (StippleComboBox *combo,
                                            guint            stipple,
                                            gpointer         user_data)      : Run first / Action

Description

This widget looks like a GtkComboBox and it displays a list of preset patterns for line. These patterns are defined by a guint16 value that is given to OpenGL for line stipple.

This widget can emit a StippleComboBox::stipple-selected signal that is a wrapper around the GtkComboBox::changed signal, but it is emitted only when a stipple is selected and this stipple is passed to the call back.

Details

StippleComboBox

typedef struct _StippleComboBox StippleComboBox;

Private structure to store informations of a StippleComboBox object.

Since 3.4


stippleComboBox_new ()

GtkWidget*  stippleComboBox_new             ();

A StippleComboBox widget is like a GtkComboBox widget, but it is already filled with predefined line patterns (call stipple). Using this widget is a convienient way to share stipples between all part of V_Sim and to give a consistent look of all stipple selection.

Returns : a newly created StippleComboBox widget.

Since 3.4


stippleComboBoxAdd_pattern ()

void        stippleComboBoxAdd_pattern      (StippleComboBox *stippleComboBox,
                                             guint16 stipple);

Create an entry in the ComboBox for the given stipple pattern if it does not already exist.

stippleComboBox : a StippleComboBox widget ;
stipple : a pattern value.

Since 3.4


stippleComboBoxGet_selectedStipple ()

guint16     stippleComboBoxGet_selectedStipple
                                            (StippleComboBox *stippleComboBox);

The user can access to the selected Stipple object using this method.

stippleComboBox : a StippleComboBox widget.
Returns : a pattern value (or 65535).

Since 3.4


stippleComboBoxGet_pixbufFromStipple ()

GdkPixbuf*  stippleComboBoxGet_pixbufFromStipple
                                            (StippleComboBox *stippleComboBox,
                                             guint16 stipple);

The stippleComboBox has little pixbufs to represent the stipple. User methods can use these pixbufs but should considered them read-only.

stippleComboBox : a StippleComboBox widget ;
stipple : a pattern value.
Returns : a pixbuf pointer corresponding to the little image shown on the stippleComboBox.

Since 3.4


stippleComboBoxSet_selectionByStipple ()

gboolean    stippleComboBoxSet_selectionByStipple
                                            (StippleComboBox *stippleComboBox,
                                             guint16 stipple);

Use this method to set the ComboBox on the given stipple. This emits a 'stipple-channel' signal if the stipple is changed, which means, a previous stipple has been modified, or a new stipple is selected.

stippleComboBox : a StippleComboBox widget ;
stipple : a pattern value.
Returns : TRUE if the stipple already exists in the model.

Since 3.4


stippleComboBoxBuild_stippleStamp ()

GdkPixbuf*  stippleComboBoxBuild_stippleStamp
                                            (guint16 stipple);

This method is used to create pixbuf representing stipples.A new pixbuf is created.

stipple : a pattern value.
Returns : a pixbuf pointer.

Since 3.4

Signal Details

The "stipple-selected" signal

void        user_function                  (StippleComboBox *combo,
                                            guint            stipple,
                                            gpointer         user_data)      : Run first / Action

This signal is emitted when a new valid line pattern is selected.

combo : the StippleComboBox that emits the signal ;
stipple : the value of the newly selected line patter.
user_data : user data set when the signal handler was connected.

Since 3.4

See Also

ShadeComboBox