org.gnu.gtk

Class ToolItem

public class ToolItem extends Bin

ToolItem is the base class of widgets that can be added to ToolBar objects.

ToolItems are widgets that can appear on a toolbar. To create a toolbar item that contain something else than a button, use new {@link ToolItem#ToolItem()}. Use {@link org.gnu.gtk.Container#add(Widget)} to add a child widget to the tool item.

For toolbar items that contain buttons, see the {@link ToolButton}, {@link ToggleToolButton} and {@link RadioToolButton} classes. see {@link org.gnu.gtk.ToolBar} class for a description of the toolbar widget.

Constructor Summary
ToolItem()
Create an empty ToolItem.
Method Summary
booleangetExpand()
Returns whether ToolItem is allocated extra space.
booleangetHomogeneous()
Returns whether the item is the same size as other homogeneous items.
IconSizegetIconSize()
Returns the icon size used for ToolItem.
booleangetIsImportant()
Returns whether ToolItem is considered important.
OrientationgetOrientation()
Returns the orientation used for ToolItem.
MenuItemgetProxyMenuItem(String menuItemId)
If menuItemId matches the string passed to {@link ToolItem#setProxyMenuItem(String, MenuItem)} returns the corresponding {@link MenuItem}.
ReliefStylegetReliefStyle()
Returns the relief style of ToolItem.
ToolBarStylegetToolbarStyle()
Returns the toolbar style used for ToolItem.
static ToolItemgetToolItem(Handle handle)
Construct a new ToolItem object from a handle to a native widget.
booleangetUseDragWindow()
Returns whether ToolItem has a drag window.
booleangetVisibleHorizontal()
Returns whether the ToolItem is visible on toolbars that are docked horizontally.
booleangetVisibleVertical()
Returns whether ToolItem is visible on toolbars that are docked vertically.
voidrebuildMenu()
Calling this function signals to the toolbar that the overflow menu item for this ToolItem has changed.
MenuItemretrieveProxyMenuItem()
Returns the {@link MenuItem} that was last set by {@link ToolItem#setProxyMenuItem(String, MenuItem)} (ie the {@link MenuItem} that is going to appear in the overflow menu).
voidsetExpand(boolean expand)
Sets whether the ToolItem is allocated extra space when there is more room on the ToolBar than needed by the ToolItems.
voidsetHomogeneous(boolean homogeneous)
Sets whether the ToolItem is to be allocated the same size as other homogeneous items.
voidsetIsImportant(boolean isImportant)
Sets whether ToolItem should be considered important.
voidsetProxyMenuItem(String menuItemId, MenuItem menuItem)
Sets the {@link MenuItem} used in the toolbar overflow menu.
voidsetTooltip(ToolTips toolTips, String tipText, String tipPrivate)
Sets the {@link ToolTips} object to be used for ToolItem, the text to be displayed as tooltip on the item and the private text to be used.
voidsetToolTip(ToolTips toolTips, String tipText, String tipPrivate)
Sets the {@link ToolTips} object to be used for ToolItem, the text to be displayed as tooltip on the item and the private text to be used.
voidsetUseDragWindow(boolean useDragWindow)
Sets whether ToolItem has a drag window.
voidsetVisibleHorizontal(boolean visibleHorizontal)
Sets whether ToolItem is visible when the toolbar is docked horizontally.
voidsetVisibleVertical(boolean visibleVertical)
Sets whether ToolItem is visible when the toolbar is docked vertically.

Constructor Detail

ToolItem

public ToolItem()
Create an empty ToolItem.

Method Detail

getExpand

public boolean getExpand()
Returns whether ToolItem is allocated extra space.

Returns: TRUE if ToolItem is allocated extra space

getHomogeneous

public boolean getHomogeneous()
Returns whether the item is the same size as other homogeneous items.

Returns: TRUE if the item is the same size as other homogeneous items

getIconSize

public IconSize getIconSize()
Returns the icon size used for ToolItem. Custom subclasses of ToolItem should call this function to find out what size icons they should use.

Returns: a {@link IconSize} indicating the icon size used for ToolItem

getIsImportant

public boolean getIsImportant()
Returns whether ToolItem is considered important.

Returns: TRUE if ToolItem is considered important

See Also: ToolItem

getOrientation

public Orientation getOrientation()
Returns the orientation used for ToolItem. Custom subclasses of ToolItem should call this function to find out what size icons they should use.

Returns: a {@link Orientation} indicating the orientation used for ToolItem

getProxyMenuItem

public MenuItem getProxyMenuItem(String menuItemId)
If menuItemId matches the string passed to {@link ToolItem#setProxyMenuItem(String, MenuItem)} returns the corresponding {@link MenuItem}. Custom subclasses of ToolItem should use this function to update their menu item when the ToolItem changes. That the menuItemId must match ensures that a ToolItem will not inadvertently change a menu item that they did not create.

Parameters: menuItemId a string used to identify the menu item

Returns: the {@link MenuItem} passed to {@link ToolItem#setProxyMenuItem(String, MenuItem)} if the menuItemId matches

getReliefStyle

public ReliefStyle getReliefStyle()
Returns the relief style of ToolItem. See {@link Button#setRelief(ReliefStyle)}. Custom subclasses of ToolItem should call this function in the handler of the GtkToolItem::toolbar_reconfigured signal to find out the relief style of buttons.

Returns: a {@link ReliefStyle} indicating the relief style used for ToolItem

getToolbarStyle

public ToolBarStyle getToolbarStyle()
Returns the toolbar style used for ToolItem. Custom subclasses of ToolItem should call this function in the handler of the GtkToolItem::toolbar_reconfigured signal to find out in what style the toolbar is displayed and change themselves accordingly.

Possibilities are:

  • GTK_TOOLBAR_BOTH, meaning the tool item should show both an icon and a label, stacked vertically.
  • GTK_TOOLBAR_ICONS, meaning the toolbar shows only icons.
  • GTK_TOOLBAR_TEXT, meaning the tool item should only show text.
  • GTK_TOOLBAR_BOTH_HORIZ, meaning the tool item should show both an icon and a label, arranged horizontally (however, note the GtkToolButton::has_text_horizontally that makes tool buttons not show labels when the toolbar style is GTK_TOOLBAR_BOTH_HORIZ.

Returns: a {@link ToolBarStyle} indicating the toolbar style used for ToolItem.

getToolItem

public static ToolItem getToolItem(Handle handle)
Construct a new ToolItem object from a handle to a native widget.

This is an internal static factory method that should be used by Java-Gnome only.

getUseDragWindow

public boolean getUseDragWindow()
Returns whether ToolItem has a drag window.

Returns: TRUE if toolitem uses a drag window

See Also: ToolItem

getVisibleHorizontal

public boolean getVisibleHorizontal()
Returns whether the ToolItem is visible on toolbars that are docked horizontally.

Returns: TRUE if ToolItem is visible on toolbars that are docked horizontally

See Also: ToolItem

getVisibleVertical

public boolean getVisibleVertical()
Returns whether ToolItem is visible on toolbars that are docked vertically.

Returns: TRUE if ToolItem is visible on toolbars that are docked vertically

See Also: ToolItem

rebuildMenu

public void rebuildMenu()
Calling this function signals to the toolbar that the overflow menu item for this ToolItem has changed. If the overflow menu is visible when this function is called, the menu will be rebuilt.

retrieveProxyMenuItem

public MenuItem retrieveProxyMenuItem()
Returns the {@link MenuItem} that was last set by {@link ToolItem#setProxyMenuItem(String, MenuItem)} (ie the {@link MenuItem} that is going to appear in the overflow menu).

Returns: the {@link MenuItem} that is going to appear in the overflow menu for tool_item.

setExpand

public void setExpand(boolean expand)
Sets whether the ToolItem is allocated extra space when there is more room on the ToolBar than needed by the ToolItems. The effect is that the item gets bigger when the ToolBar gets bigger and smaller when the ToolBar gets smaller.

Parameters: expand whether ToolItem is allocated extra space

setHomogeneous

public void setHomogeneous(boolean homogeneous)
Sets whether the ToolItem is to be allocated the same size as other homogeneous items. The effect is that all homogeneous items will have the same width as the widest of the items.

Parameters: homogeneous TRUE if the item is the same size as other homogeneous items

setIsImportant

public void setIsImportant(boolean isImportant)
Sets whether ToolItem should be considered important. The {@link ToolButton} class uses this property to determine whether to show or hide its label when the toolbar style is {@link ToolBarStyle#BOTH_HORIZ}. The result is that only tool buttons with the IS_IMPORTANT property set have labels, an effect known as "priority text".

Parameters: isImportant whether the tool item should be considered important

setProxyMenuItem

public void setProxyMenuItem(String menuItemId, MenuItem menuItem)
Sets the {@link MenuItem} used in the toolbar overflow menu. The menuItemId is used to identify the caller of this function and should also be used with {@link ToolItem#getProxyMenuItem(String)}.

Parameters: menuItemId a string used to identify menuItem menuItem a {@link MenuItem} to be used in the overflow menu

setTooltip

public void setTooltip(ToolTips toolTips, String tipText, String tipPrivate)

Deprecated:

Sets the {@link ToolTips} object to be used for ToolItem, the text to be displayed as tooltip on the item and the private text to be used.

Parameters: toolTips the {@link ToolTips} object to be used tipText text to be used as tooltip text for ToolItem tipPrivate text to be used as private tooltip text

See Also: ToolTips

setToolTip

public void setToolTip(ToolTips toolTips, String tipText, String tipPrivate)
Sets the {@link ToolTips} object to be used for ToolItem, the text to be displayed as tooltip on the item and the private text to be used.

Parameters: toolTips the {@link ToolTips} object to be used tipText text to be used as tooltip text for ToolItem tipPrivate text to be used as private tooltip text

See Also: ToolTips

setUseDragWindow

public void setUseDragWindow(boolean useDragWindow)
Sets whether ToolItem has a drag window. When TRUE the ToolItem can be used as a drag source through DragSource. When ToolItem has a drag window it will intercept all events, even those that would otherwise be sent to a child of ToolItem.

Parameters: useDragWindow whether ToolItem has a drag window

setVisibleHorizontal

public void setVisibleHorizontal(boolean visibleHorizontal)
Sets whether ToolItem is visible when the toolbar is docked horizontally.

Parameters: visibleHorizontal whether ToolItem is visible when the toolbar is in horizontal mode

setVisibleVertical

public void setVisibleVertical(boolean visibleVertical)
Sets whether ToolItem is visible when the toolbar is docked vertically. Some tool items, such as text entries, are too wide to be useful on a vertically docked toolbar. If visibleVertical is FALSE ToolItem will not appear on toolbars that are docked vertically.

Parameters: visibleVertical whether toolitem is visible when the toolbar is in vertical mode