org.gnu.gtk
public class ToolItem extends Bin
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.
|
Returns: TRUE
if ToolItem is allocated extra space
Returns: TRUE
if the item is the same size as other
homogeneous items
Returns: a IconSize indicating the icon size used for ToolItem
Returns: TRUE
if ToolItem is considered important
See Also: ToolItem
Returns: a Orientation indicating the orientation used for ToolItem
menuItemId 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
Returns: a ReliefStyle indicating the relief style used for ToolItem
Possibilities are:
Returns: a ToolBarStyle indicating the toolbar style used for ToolItem.
This is an internal static factory method that should be used by Java-Gnome only.
Returns: TRUE
if toolitem uses a drag window
See Also: ToolItem
Returns: TRUE
if ToolItem is visible on toolbars that are
docked horizontally
See Also: ToolItem
Returns: TRUE
if ToolItem is visible on toolbars that are
docked vertically
See Also: ToolItem
Returns: the MenuItem that is going to appear in the overflow menu for tool_item.
Parameters: expand whether ToolItem is allocated extra space
Parameters: homogeneous
TRUE
if the item is the same size as other
homogeneous items
Parameters: isImportant whether the tool item should be considered important
menuItemId
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:
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
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
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
Parameters: visibleHorizontal whether ToolItem is visible when the toolbar is in horizontal mode
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