Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
GObject
org.gnu.gtk.GtkObject
org.gnu.gtk.Widget
org.gnu.gtk.Container
org.gnu.gtk.Bin
org.gnu.gtk.ToolItem
public class ToolItem
extends Bin
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 | |
|
Method Summary | |
boolean |
|
boolean |
|
IconSize |
|
boolean |
|
Orientation |
|
MenuItem |
|
ReliefStyle |
|
static ToolItem |
|
ToolBarStyle |
|
boolean |
|
boolean |
|
boolean |
|
void |
|
MenuItem |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
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 |
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.
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
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
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
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)
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
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.
IfmenuItemId
matches the string passed to
setProxyMenuItem(String,MenuItem)
returns the correspondingMenuItem
. Custom subclasses of ToolItem should use this function to update their menu item when the ToolItem changes. That themenuItemId
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 tosetProxyMenuItem(String,MenuItem)
if the menuItemId matches
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. SeeButton.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
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.
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.
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)
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)
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)
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.
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 theMenuItem
that was last set bysetProxyMenuItem(String,MenuItem)
(ie theMenuItem
that is going to appear in the overflow menu).
- Returns:
- the
MenuItem
that is going to appear in the overflow menu for tool_item.
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
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
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. TheToolButton
class uses this property to determine whether to show or hide its label when the toolbar style isToolBarStyle.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
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 theMenuItem
used in the toolbar overflow menu. ThemenuItemId
is used to identify the caller of this function and should also be used withgetProxyMenuItem(String)
.
- Parameters:
menuItemId
- a string used to identifymenuItem
menuItem
- aMenuItem
to be used in the overflow menu
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 theToolTips
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
- theToolTips
object to be usedtipText
- text to be used as tooltip text for ToolItemtipPrivate
- text to be used as private tooltip text
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 theToolTips
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
- theToolTips
object to be usedtipText
- text to be used as tooltip text for ToolItemtipPrivate
- text to be used as private tooltip text
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. 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
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
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. IfvisibleVertical
isFALSE
ToolItem will not appear on toolbars that are docked vertically.
- Parameters:
visibleVertical
- whether toolitem is visible when the toolbar is in vertical mode