org.gnu.gtk
public class ToolItem extends Bin
Deprecated: This class is part of the java-gnome 2.x family of libraries,
which, due to their inefficiency and complexity, are no longer
being maintained and have been abandoned by the java-gnome
project. This class may in the future have an equivalent in
java-gnome 4.0, try looking for
org.gnome.gtk.ToolItem
.
You should be aware that there is a considerably different API
in the new library: the architecture is completely different
and most notably internals are no longer exposed to public view.
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 add 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()
Create an empty ToolItem. |
Method Summary | |
---|---|
boolean | getExpand()
Returns whether ToolItem is allocated extra space.
|
boolean | getHomogeneous()
Returns whether the item is the same size as other homogeneous items.
|
IconSize | getIconSize()
Returns the icon size used for ToolItem. |
boolean | getIsImportant()
Returns whether ToolItem is considered important.
|
Orientation | getOrientation()
Returns the orientation used for ToolItem. |
MenuItem | getProxyMenuItem(String menuItemId) |
ReliefStyle | getReliefStyle()
Returns the relief style of ToolItem. |
ToolBarStyle | getToolbarStyle()
Returns the toolbar style used for ToolItem. |
static ToolItem | getToolItem(Handle handle)
Construct a new ToolItem object from a handle to a native widget.
|
boolean | getUseDragWindow()
Returns whether ToolItem has a drag window.
|
boolean | getVisibleHorizontal()
Returns whether the ToolItem is visible on toolbars that are docked
horizontally.
|
boolean | getVisibleVertical()
Returns whether ToolItem is visible on toolbars that are docked
vertically.
|
void | rebuildMenu()
Calling this function signals to the toolbar that the overflow menu item
for this ToolItem has changed. |
MenuItem | retrieveProxyMenuItem() |
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. |
void | setHomogeneous(boolean homogeneous)
Sets whether the ToolItem is to be allocated the same size as other
homogeneous items. |
void | setIsImportant(boolean isImportant)
Sets whether ToolItem should be considered important. |
void | setProxyMenuItem(String menuItemId, MenuItem menuItem)
Sets the MenuItem used in the toolbar overflow menu. |
void | setTooltip(ToolTips toolTips, String tipText, String tipPrivate)
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.
|
void | setToolTip(ToolTips toolTips, String tipText, String tipPrivate)
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.
|
void | setUseDragWindow(boolean useDragWindow)
Sets whether ToolItem has a drag window. |
void | setVisibleHorizontal(boolean visibleHorizontal)
Sets whether ToolItem is visible when the toolbar is docked horizontally.
|
void | setVisibleVertical(boolean visibleVertical)
Sets whether ToolItem is visible when the toolbar is docked vertically.
|
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.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
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
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
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: 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.
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
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.
IfmenuItemId matches the string passed to ToolItem
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 ToolItem
if the menuItemId matches
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 setRelief. 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
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:
Returns: a ToolBarStyle indicating the toolbar style used for 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.
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.
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: 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.
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
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: 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.
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.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 ToolItem (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.
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
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
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 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
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. ThemenuItemId
is used to identify the caller of this function
and should also be used with getProxyMenuItem.
Parameters: menuItemId
a string used to identify menuItem
menuItem
a MenuItem to be used in the overflow menu
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
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
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. WhenTRUE
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
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
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. IfvisibleVertical
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