Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.gnu.gtk

Class ToolItem

Known Direct Subclasses:
SeparatorToolItem, ToolButton
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 ToolItem(). Use Container.add(Widget) to add a child widget to the tool item.

For toolbar items that contain buttons, see the ToolButton, ToggleToolButton and RadioToolButton classes. see ToolBar class for a description of the toolbar widget.

Constructor Summary

ToolItem()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Method Summary

boolean
getExpand()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
boolean
getHomogeneous()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
IconSize
getIconSize()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
boolean
getIsImportant()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
Orientation
getOrientation()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
MenuItem
getProxyMenuItem(String menuItemId)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
ReliefStyle
getReliefStyle()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
static ToolItem
getToolItem(Handle handle)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
ToolBarStyle
getToolbarStyle()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
boolean
getUseDragWindow()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
boolean
getVisibleHorizontal()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
boolean
getVisibleVertical()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
void
rebuildMenu()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
MenuItem
retrieveProxyMenuItem()
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
void
setExpand(boolean expand)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
void
setHomogeneous(boolean homogeneous)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
void
setIsImportant(boolean isImportant)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
void
setProxyMenuItem(String menuItemId, MenuItem menuItem)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
void
setToolTip(ToolTips toolTips, String tipText, String tipPrivate)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
void
setTooltip(ToolTips toolTips, String tipText, String tipPrivate)
Deprecated.
void
setUseDragWindow(boolean useDragWindow)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
void
setVisibleHorizontal(boolean visibleHorizontal)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.
void
setVisibleVertical(boolean visibleVertical)
Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Methods inherited from class org.gnu.gtk.Bin

getChild, getType

Methods inherited from class org.gnu.gtk.Container

add, addListener, getBooleanChildProperty, getBorderWidth, getChildProperty, getChildren, getEventListenerClass, getEventType, getIntChildProperty, getResizeMode, getType, remove, removeListener, resizeChildren, setBooleanChildProperty, setBorderWidth, setChildProperty, setIntChildProperty, setResizeMode

Methods inherited from class org.gnu.gtk.Widget

activate, addAccelerator, addEvents, addListener, addListener, addListener, addListener, addListener, addListener, addListener, addListener, addListener, addListener, addListener, canActivateAccel, createContext, createLayout, draw, drawArea, drawArea, finish, getAccessible, getAllocation, getCanFocus, getColormap, getContext, getData, getDisplay, getDragData, getEventListenerClass, getEventType, getExtensionEvents, getModifierStyle, getName, getParent, getParentWindow, getPointer, getRootWindow, getScreen, getSensitive, getStyle, getToplevel, getType, getWidget, getWindow, grabDefault, grabFocus, hasFocus, hasScreen, hide, hideAll, highlight, highlight, intersect, isAncestor, makeWidget, modifyStyle, popColormap, pushColormap, realize, removeAccelerator, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, reparent, setBackgroundColor, setBaseColor, setCanFocus, setColormap, setDoubleBuffered, setDragDestination, setDragIcon, setDragIconPixbuf, setDragIconStock, setDragSource, setEvents, setExtensionEvents, setFont, setForegroundColor, setMinimumSize, setName, setNoDragDestination, setNoDragSource, setSensitive, setTextColor, shapeCombineMask, show, showAll, unHighlight, unHighlight

Methods inherited from class org.gnu.gtk.GtkObject

destroy, getType, sink

Constructor Details

ToolItem

public ToolItem()

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Create an empty ToolItem.

Method Details

getExpand

public boolean getExpand()

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Returns whether ToolItem is allocated extra space.
Returns:
TRUE if ToolItem is allocated extra space

getHomogeneous

public boolean getHomogeneous()

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

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()

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

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 IconSize indicating the icon size used for ToolItem

getIsImportant

public boolean getIsImportant()

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Returns whether ToolItem is considered important.
Returns:
TRUE if ToolItem is considered important
See Also:
setIsImportant(boolean)

getOrientation

public Orientation getOrientation()

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

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 Orientation indicating the orientation used for ToolItem

getProxyMenuItem

public MenuItem getProxyMenuItem(String menuItemId)

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

If menuItemId matches the string passed to setProxyMenuItem(String,MenuItem) returns the corresponding 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 MenuItem passed to setProxyMenuItem(String,MenuItem) if the menuItemId matches

getReliefStyle

public ReliefStyle getReliefStyle()

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Returns the relief style of ToolItem. See 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 ReliefStyle indicating the relief style used for ToolItem

getToolItem

public static ToolItem getToolItem(Handle handle)

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

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.

getToolbarStyle

public ToolBarStyle getToolbarStyle()

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

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 ToolBarStyle indicating the toolbar style used for ToolItem.

getUseDragWindow

public boolean getUseDragWindow()

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Returns whether ToolItem has a drag window.
Returns:
TRUE if toolitem uses a drag window
See Also:
setUseDragWindow(boolean)

getVisibleHorizontal

public boolean getVisibleHorizontal()

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

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:
setVisibleHorizontal(boolean)

getVisibleVertical

public boolean getVisibleVertical()

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

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:
setVisibleVertical(boolean)

rebuildMenu

public void rebuildMenu()

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

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()

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Returns the MenuItem that was last set by setProxyMenuItem(String,MenuItem) (ie the MenuItem that is going to appear in the overflow menu).
Returns:
the MenuItem that is going to appear in the overflow menu for tool_item.

setExpand

public void setExpand(boolean expand)

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

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)

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

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)

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Sets whether ToolItem should be considered important. The ToolButton class uses this property to determine whether to show or hide its label when the toolbar style is 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)

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Sets the MenuItem used in the toolbar overflow menu. The menuItemId is used to identify the caller of this function and should also be used with getProxyMenuItem(String).
Parameters:
menuItemId - a string used to identify menuItem
menuItem - a MenuItem to be used in the overflow menu

setToolTip

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

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Sets the 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 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.setTip(Widget,String,String)

setTooltip

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

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

Sets the 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 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.setTip(Widget,String,String)

setUseDragWindow

public void setUseDragWindow(boolean useDragWindow)

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

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)

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

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)

Deprecated. Superceeded by java-gnome 4.0; a method along these lines may well exist in the new bindings, but if it does it likely has a different name or signature due to the shift to an algorithmic mapping of the underlying native libraries.

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

Overview Package Tree Index Deprecated About