CellRendererToggle

Renders a toggle button in a cell

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

More...

class CellRendererToggle : CellRenderer {

this();

bool getActivatable();

bool getActive();

bool getRadio();

void setActivatable(bool setting);

void setActive(bool setting);

void setRadio(bool radio);

ulong connectToggled(T callback, Flag!"After" after);

}

Constructors

this this(): Creates a new gtk.cell_renderer_toggle.CellRendererToggle. Adjust rendering parameters using object properties. Object properties can be set globally (with gobject.object.ObjectG.set). Also, with gtk.tree_view_column.TreeViewColumn, you can bind a property to a value in a gtk.tree_model.TreeModel. 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

connectToggled ulong connectToggled(T callback, Flag!"After" after): Connect to Toggled signal.
getActivatable bool getActivatable(): Returns whether the cell renderer is activatable. See gtk.cell_renderer_toggle.CellRendererToggle.setActivatable.
getActive bool getActive(): Returns whether the cell renderer is active. See gtk.cell_renderer_toggle.CellRendererToggle.setActive.
getRadio bool getRadio(): Returns whether we’re rendering radio toggles rather than checkboxes.
setActivatable void setActivatable(bool setting): Makes the cell renderer activatable.
setActive void setActive(bool setting): Activates or deactivates a cell renderer.
setRadio void setRadio(bool 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 gtk.tree_view.TreeView, you set up a per-row setting using gtk.tree_view_column.TreeViewColumn to associate model columns with cell renderer properties).

Inherited Members

From CellRenderer

activate bool activate(gdk.event.Event event, gtk.widget.Widget widget, string path, gdk.rectangle.Rectangle backgroundArea, gdk.rectangle.Rectangle cellArea, gtk.types.CellRendererState flags): Passes an activate event to the cell renderer for possible processing. Some cell renderers may use events; for example, gtk.cell_renderer_toggle.CellRendererToggle toggles when it gets a mouse click.
getAlignedArea void getAlignedArea(gtk.widget.Widget widget, gtk.types.CellRendererState flags, gdk.rectangle.Rectangle cellArea, gdk.rectangle.Rectangle alignedArea): Gets the aligned area used by cell inside cell_area. Used for finding the appropriate edit and focus rectangle.
getAlignment void getAlignment(float xalign, float yalign): Fills in xalign and yalign with the appropriate values of cell.
getFixedSize void getFixedSize(int width, int height): Fills in width and height with the appropriate size of cell.
getIsExpanded bool getIsExpanded(): Checks whether the given gtk.cell_renderer.CellRenderer is expanded.
getIsExpander bool getIsExpander(): Checks whether the given gtk.cell_renderer.CellRenderer is an expander.
getPadding void getPadding(int xpad, int ypad): Fills in xpad and ypad with the appropriate values of cell.
getPreferredHeight void getPreferredHeight(gtk.widget.Widget widget, int minimumSize, int naturalSize): Retrieves a renderer’s natural size when rendered to widget.
getPreferredHeightForWidth void getPreferredHeightForWidth(gtk.widget.Widget widget, int width, int minimumHeight, int naturalHeight): Retrieves a cell renderers’s minimum and natural height if it were rendered to widget with the specified width.
getPreferredSize void getPreferredSize(gtk.widget.Widget widget, gtk.requisition.Requisition minimumSize, gtk.requisition.Requisition 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(gtk.widget.Widget widget, int minimumSize, int naturalSize): Retrieves a renderer’s natural size when rendered to widget.
getPreferredWidthForHeight void getPreferredWidthForHeight(gtk.widget.Widget widget, int height, int minimumWidth, int naturalWidth): Retrieves a cell renderers’s minimum and natural width if it were rendered to widget with the specified height.
getRequestMode gtk.types.SizeRequestMode getRequestMode(): Gets whether the cell renderer prefers a height-for-width layout or a width-for-height layout.
getSensitive bool getSensitive(): Returns the cell renderer’s sensitivity.
getState gtk.types.StateFlags getState(gtk.widget.Widget widget, gtk.types.CellRendererState cellState): Translates the cell renderer state to gtk.types.StateFlags, based on the cell renderer and widget sensitivity, and the given gtk.cell_renderer.CellRendererState.
getVisible bool getVisible(): Returns the cell renderer’s visibility.
isActivatable bool isActivatable(): Checks whether the cell renderer can do something when activated.
setAlignment void setAlignment(float xalign, float yalign): Sets the renderer’s alignment within its available space.
setFixedSize void setFixedSize(int width, int height): Sets the renderer size to be explicit, independent of the properties set.
setIsExpanded void setIsExpanded(bool isExpanded): Sets whether the given gtk.cell_renderer.CellRenderer is expanded.
setIsExpander void setIsExpander(bool isExpander): Sets whether the given gtk.cell_renderer.CellRenderer is an expander.
setPadding void setPadding(int xpad, int ypad): Sets the renderer’s padding.
setSensitive void setSensitive(bool sensitive): Sets the cell renderer’s sensitivity.
setVisible void setVisible(bool visible): Sets the cell renderer’s visibility.
snapshot void snapshot(gtk.snapshot.Snapshot snapshot, gtk.widget.Widget widget, gdk.rectangle.Rectangle backgroundArea, gdk.rectangle.Rectangle cellArea, gtk.types.CellRendererState flags): Invokes the virtual render function of the gtk.cell_renderer.CellRenderer. 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 gtk.cell_renderer.CellRenderer 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.
startEditing gtk.cell_editable.CellEditable startEditing(gdk.event.Event event, gtk.widget.Widget widget, string path, gdk.rectangle.Rectangle backgroundArea, gdk.rectangle.Rectangle cellArea, gtk.types.CellRendererState flags): Starts editing the contents of this cell, through a new gtk.cell_editable.CellEditable widget created by the gtk.cell_renderer.CellRendererClass.start_editing virtual function.
stopEditing void stopEditing(bool canceled): Informs the cell renderer that the editing is stopped. If canceled is true, the cell renderer will emit the gtk.cell_renderer.CellRenderer::editing-canceled signal.
connectEditingCanceled ulong connectEditingCanceled(T callback, Flag!"After" after): Connect to EditingCanceled signal.
connectEditingStarted ulong connectEditingStarted(T callback, Flag!"After" after): Connect to EditingStarted signal.

Detailed Description

Deprecated: List views use widgets to display their contents. You should use gtk.toggle_button.ToggleButton instead

gtk cell_renderer_toggle classes

CellRendererToggle