CellRendererToggle

GtkCellRendererToggle renders a toggle button in a cell. The button is drawn as a radio or a checkbutton, depending on the "radio" property. When activated, it emits the "toggled" signal.

class CellRendererToggle : CellRenderer {

protected

GtkCellRendererToggle* gtkCellRendererToggle;

GtkCellRendererToggle* getCellRendererToggleStruct();

void* getStruct();

this(GtkCellRendererToggle* gtkCellRendererToggle);

void setStruct(GObject* obj);

int[string] connectedSignals;

void delegate(string, CellRendererToggle)[] onToggledListeners;

void addOnToggled(void delegate(string, CellRendererToggle) dlg, ConnectFlags connectFlags);

static void callBackToggled(GtkCellRendererToggle* cellRendererStruct, gchar* path, CellRendererToggle _cellRendererToggle);

this();

int getRadio();

void setRadio(int radio);

int getActive();

void setActive(int setting);

int getActivatable();

void setActivatable(int setting);

}

Constructors

this this(GtkCellRendererToggle* gtkCellRendererToggle): Sets our main struct and passes it to the parent class
this this(): Creates a new GtkCellRendererToggle. Adjust rendering parameters using object properties. Object properties can be set globally (with g_object_set()). Also, with GtkTreeViewColumn, you can bind a property to a value in a GtkTreeModel. For example, you can bind the "active" property on the cell renderer to a boolean value in the model, thus causing the check button to reflect the state of the model.

Members

Functions

addOnToggled void addOnToggled(void delegate(string, CellRendererToggle) dlg, ConnectFlags connectFlags): The ::toggled signal is emitted when the cell is toggled.
getActivatable int getActivatable(): Returns whether the cell renderer is activatable. See gtk_cell_renderer_toggle_set_activatable(). Since 2.18
getActive int getActive(): Returns whether the cell renderer is active. See gtk_cell_renderer_toggle_set_active().
getCellRendererToggleStruct GtkCellRendererToggle* getCellRendererToggleStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
getRadio int getRadio(): Returns whether we're rendering radio toggles rather than checkboxes.
getStruct void* getStruct(): the main Gtk struct as a void*
setActivatable void setActivatable(int setting): Makes the cell renderer activatable. Since 2.18
setActive void setActive(int setting): Activates or deactivates a cell renderer.
setRadio void setRadio(int radio): If radio is TRUE, the cell renderer renders a radio toggle (i.e. a toggle in a group of mutually-exclusive toggles). If FALSE, it renders a check toggle (a standalone boolean option). This can be set globally for the cell renderer, or changed just before rendering each cell in the model (for GtkTreeView, you set up a per-row setting using GtkTreeViewColumn to associate model columns with cell renderer properties).
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

callBackToggled void callBackToggled(GtkCellRendererToggle* cellRendererStruct, gchar* path, CellRendererToggle _cellRendererToggle): Undocumented in source. Be warned that the author may not have intended to support it.

Variables

connectedSignals int[string] connectedSignals;
gtkCellRendererToggle GtkCellRendererToggle* gtkCellRendererToggle;: the main Gtk struct
onToggledListeners void delegate(string, CellRendererToggle)[] onToggledListeners;: Undocumented in source.

Inherited Members

From CellRenderer

gtkCellRenderer GtkCellRenderer* gtkCellRenderer;: the main Gtk struct
getCellRendererStruct GtkCellRenderer* getCellRendererStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
getStruct void* getStruct(): the main Gtk struct as a void*
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
connectedSignals int[string] connectedSignals;
onEditingCanceledListeners void delegate(CellRenderer)[] onEditingCanceledListeners;: Undocumented in source.
addOnEditingCanceled void addOnEditingCanceled(void delegate(CellRenderer) dlg, ConnectFlags connectFlags): This signal gets emitted when the user cancels the process of editing a cell. For example, an editable cell renderer could be written to cancel editing when the user presses Escape. See also: gtk_cell_renderer_stop_editing(). Since 2.4
callBackEditingCanceled void callBackEditingCanceled(GtkCellRenderer* rendererStruct, CellRenderer _cellRenderer): Undocumented in source. Be warned that the author may not have intended to support it.
onEditingStartedListeners void delegate(CellEditableIF, string, CellRenderer)[] onEditingStartedListeners;: Undocumented in source.
addOnEditingStarted void addOnEditingStarted(void delegate(CellEditableIF, string, CellRenderer) dlg, ConnectFlags connectFlags): This signal gets emitted when a cell starts to be edited. The intended use of this signal is to do special setup on editable, e.g. adding a GtkEntryCompletion or setting up additional columns in a GtkComboBox. Note that GTK+ doesn't guarantee that cell renderers will continue to use the same kind of widget for editing in future releases, therefore you should check the type of editable Since 2.6 See Also GtkCellRendererText, GtkCellRendererPixbuf, GtkCellRendererToggle
callBackEditingStarted void callBackEditingStarted(GtkCellRenderer* rendererStruct, GtkCellEditable* editable, gchar* path, CellRenderer _cellRenderer): Undocumented in source. Be warned that the author may not have intended to support it.
classSetAccessibleType void classSetAccessibleType(GtkCellRendererClass* rendererClass, GType type): Sets the type to be used for creating accessibles for cells rendered by cell renderers of renderer_class. Note that multiple accessibles will be created. This function should only be called from class init functions of cell renderers.
getAlignedArea void getAlignedArea(Widget widget, GtkCellRendererState flags, Rectangle cellArea, Rectangle alignedArea): Gets the aligned area used by cell inside cell_area. Used for finding the appropriate edit and focus rectangle.
getSize void getSize(Widget widget, Rectangle* cellArea, int xOffset, int yOffset, int width, int height): Warning gtk_cell_renderer_get_size has been deprecated since version 3.0 and should not be used in newly-written code. Use gtk_cell_renderer_get_preferred_size() instead. Obtains the width and height needed to render the cell. Used by view widgets to determine the appropriate size for the cell_area passed to gtk_cell_renderer_render(). If cell_area is not NULL, fills in the x and y offsets (if set) of the cell relative to this location. Please note that the values set in width and height, as well as those in x_offset and y_offset are inclusive of the xpad and ypad properties.
render void render(Context cr, Widget widget, Rectangle backgroundArea, Rectangle cellArea, GtkCellRendererState flags): Invokes the virtual render function of the GtkCellRenderer. The three passed-in rectangles are areas in cr. Most renderers will draw within cell_area; the xalign, yalign, xpad, and ypad fields of the GtkCellRenderer should be honored with respect to cell_area. background_area includes the blank space around the cell, and also the area containing the tree expander; so the background_area rectangles for all cells tile to cover the entire window.
activate int activate(Event event, Widget widget, string path, Rectangle backgroundArea, Rectangle cellArea, GtkCellRendererState flags): Passes an activate event to the cell renderer for possible processing. Some cell renderers may use events; for example, GtkCellRendererToggle toggles when it gets a mouse click.
startEditing CellEditableIF startEditing(Event event, Widget widget, string path, Rectangle backgroundArea, Rectangle cellArea, GtkCellRendererState flags): Passes an activate event to the cell renderer for possible processing.
stopEditing void stopEditing(int canceled): Informs the cell renderer that the editing is stopped. If canceled is TRUE, the cell renderer will emit the "editing-canceled" signal. This function should be called by cell renderer implementations in response to the "editing-done" signal of GtkCellEditable. Since 2.6
getFixedSize void getFixedSize(int width, int height): Fills in width and height with the appropriate size of cell.
setFixedSize void setFixedSize(int width, int height): Sets the renderer size to be explicit, independent of the properties set.
getVisible int getVisible(): Returns the cell renderer's visibility. Since 2.18
setVisible void setVisible(int visible): Sets the cell renderer's visibility. Since 2.18
getSensitive int getSensitive(): Returns the cell renderer's sensitivity. Since 2.18
setSensitive void setSensitive(int sensitive): Sets the cell renderer's sensitivity. Since 2.18
getAlignment void getAlignment(float xalign, float yalign): Fills in xalign and yalign with the appropriate values of cell. Since 2.18
setAlignment void setAlignment(float xalign, float yalign): Sets the renderer's alignment within its available space. Since 2.18
getPadding void getPadding(int xpad, int ypad): Fills in xpad and ypad with the appropriate values of cell. Since 2.18
setPadding void setPadding(int xpad, int ypad): Sets the renderer's padding. Since 2.18
getState GtkStateFlags getState(Widget widget, GtkCellRendererState cellState): Translates the cell renderer state to GtkStateFlags, based on the cell renderer and widget sensitivity, and the given GtkCellRendererState.
isActivatable int isActivatable(): Checks whether the cell renderer can do something when activated.
getPreferredHeight void getPreferredHeight(Widget widget, int minimumSize, int naturalSize): Retreives a renderer's natural size when rendered to widget.
getPreferredHeightForWidth void getPreferredHeightForWidth(Widget widget, int width, int minimumHeight, int naturalHeight): Retreives a cell renderers's minimum and natural height if it were rendered to widget with the specified width.
getPreferredSize void getPreferredSize(Widget widget, GtkRequisition minimumSize, GtkRequisition naturalSize): Retrieves the minimum and natural size of a cell taking into account the widget's preference for height-for-width management.
getPreferredWidth void getPreferredWidth(Widget widget, int minimumSize, int naturalSize): Retreives a renderer's natural size when rendered to widget.
getPreferredWidthForHeight void getPreferredWidthForHeight(Widget widget, int height, int minimumWidth, int naturalWidth): Retreives a cell renderers's minimum and natural width if it were rendered to widget with the specified height.
getRequestMode GtkSizeRequestMode getRequestMode(): Gets whether the cell renderer prefers a height-for-width layout or a width-for-height layout.