ToolItem

Instances of this class represent a selectable user interface object that represents a button in a tool bar. <dl> <dt>Styles:</dt> <dd>PUSH, CHECK, RADIO, SEPARATOR, DROP_DOWN</dd> <dt>Events:</dt> <dd>Selection</dd> </dl> Note: Only one of the styles CHECK, PUSH, RADIO, SEPARATOR and DROP_DOWN may be specified. IMPORTANT: This class is not intended to be subclassed.

@see <a href="http://www.eclipse.org/swt/snippets/#toolbar">ToolBar, ToolItem snippets</a> @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>

class ToolItem : Item {

GtkWidget* boxHandle;

GtkWidget* arrowHandle;

GtkWidget* arrowBoxHandle;

GtkWidget* separatorHandle;

GtkWidget* labelHandle;

GtkWidget* imageHandle;

ToolBar parent;

Control control;

Image hotImage;

Image disabledImage;

String toolTipText;

bool drawHotImage;

this(ToolBar parent, int style);

this(ToolBar parent, int style, int index);

void addSelectionListener(SelectionListener listener);

Rectangle getBounds();

Control getControl();

Image getDisabledImage();

bool getEnabled();

Image getHotImage();

ToolBar getParent();

bool getSelection();

String getToolTipText();

int getWidth();

bool isEnabled();

void removeSelectionListener(SelectionListener listener);

void setControl(Control control);

void setDisabledImage(Image image);

void setEnabled(bool enabled);

void setHotImage(Image image);

void setSelection(bool selected);

void setText(String string);

void setToolTipText(String string);

void setWidth(int width);

}

Constructors

this this(ToolBar parent, int style): Constructs a new instance of this class given its parent (which must be a <code>ToolBar</code>) and a style value describing its behavior and appearance. The item is added to the end of the items maintained by its parent. The style value is either one of the style constants defined in class <code>SWT</code> which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the <code>int</code> "|" operator) two or more of those <code>SWT</code> style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.
this this(ToolBar parent, int style, int index): Constructs a new instance of this class given its parent (which must be a <code>ToolBar</code>), a style value describing its behavior and appearance, and the index at which to place it in the items maintained by its parent. The style value is either one of the style constants defined in class <code>SWT</code> which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the <code>int</code> "|" operator) two or more of those <code>SWT</code> style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Members

Functions

addSelectionListener void addSelectionListener(SelectionListener listener): Adds the listener to the collection of listeners who will be notified when the control is selected by the user, by sending it one of the messages defined in the <code>SelectionListener</code> interface. When <code>widgetSelected</code> is called when the mouse is over the arrow portion of a drop-down tool, the event object detail field contains the value <code>SWT.ARROW</code>. <code>widgetDefaultSelected</code> is not called.
getBounds Rectangle getBounds(): Returns a rectangle describing the receiver's size and location relative to its parent.
getControl Control getControl(): Returns the control that is used to fill the bounds of the item when the item is a <code>SEPARATOR</code>.
getDisabledImage Image getDisabledImage(): Returns the receiver's disabled image if it has one, or null if it does not. The disabled image is displayed when the receiver is disabled.
getEnabled bool getEnabled(): Returns <code>true</code> if the receiver is enabled, and <code>false</code> otherwise. A disabled control is typically not selectable from the user interface and draws with an inactive or "grayed" look.
getHotImage Image getHotImage(): Returns the receiver's hot image if it has one, or null if it does not. The hot image is displayed when the mouse enters the receiver.
getParent ToolBar getParent(): Returns the receiver's parent, which must be a <code>ToolBar</code>.
getSelection bool getSelection(): Returns <code>true</code> if the receiver is selected, and false otherwise. When the receiver is of type <code>CHECK</code> or <code>RADIO</code>, it is selected when it is checked (which some platforms draw as a pushed in button). If the receiver is of any other type, this method returns false.
getToolTipText String getToolTipText(): Returns the receiver's tool tip text, or null if it has not been set.
getWidth int getWidth(): Gets the width of the receiver.
isEnabled bool isEnabled(): Returns <code>true</code> if the receiver is enabled and all of the receiver's ancestors are enabled, and <code>false</code> otherwise. A disabled control is typically not selectable from the user interface and draws with an inactive or "grayed" look.
removeSelectionListener void removeSelectionListener(SelectionListener listener): Removes the listener from the collection of listeners who will be notified when the control is selected by the user.
setControl void setControl(Control control): Sets the control that is used to fill the bounds of the item when the item is a <code>SEPARATOR</code>.
setDisabledImage void setDisabledImage(Image image): Sets the receiver's disabled image to the argument, which may be null indicating that no disabled image should be displayed. The disabled image is displayed when the receiver is disabled.
setEnabled void setEnabled(bool enabled): Enables the receiver if the argument is <code>true</code>, and disables it otherwise. A disabled control is typically not selectable from the user interface and draws with an inactive or "grayed" look.
setHotImage void setHotImage(Image image): Sets the receiver's hot image to the argument, which may be null indicating that no hot image should be displayed. The hot image is displayed when the mouse enters the receiver.
setSelection void setSelection(bool selected): Sets the selection state of the receiver. When the receiver is of type <code>CHECK</code> or <code>RADIO</code>, it is selected when it is checked (which some platforms draw as a pushed in button).
setText void setText(String string): Sets the receiver's text. The string may include the mnemonic character. Mnemonics are indicated by an '&' that causes the next character to be the mnemonic. When the user presses a key sequence that matches the mnemonic, a selection event occurs. On most platforms, the mnemonic appears underlined but may be emphasised in a platform specific manner. The mnemonic indicator character '&' can be escaped by doubling it in the string, causing a single '&' to be displayed.
setToolTipText void setToolTipText(String string): Sets the receiver's tool tip text to the argument, which may be null indicating that no tool tip text should be shown.
setWidth void setWidth(int width): Sets the width of the receiver, for <code>SEPARATOR</code> ToolItems.

Inherited Members

From Item

getImage Image getImage(): Returns the receiver's image if it has one, or null if it does not.
getText String getText(): Returns the receiver's text, which will be an empty string if it has never been set.
setImage void setImage(Image image): Sets the receiver's image to the argument, which may be null indicating that no image should be displayed.
setText void setText(String string): Sets the receiver's text.