gtk.MenuItem — the widget used for an item in menus
class gtk.MenuItem(gtk.Item): |
+--gobject.GObject +-- gtk.Object +-- gtk.Widget +-- gtk.Container +-- gtk.Bin +-- gtk.Item +-- gtk.MenuItem
|
|
gtk.Container Signal Prototypes
"activate" | def callback( |
def callback( | |
def callback( | |
def callback( |
The gtk.MenuItem
widget implements the appearance and behavior of menu items. The gtk.MenuItem and
its derived widget subclasses are the only valid children of menus.
When menu items are selected and activated by a user they can:
As a gtk.MenuItem is a
subclass of gtk.Bin it can hold any
valid child widget.
gtk.MenuItem(label=None, use_underline=True)
| a string to be used as the text of the menu item
or None |
| if True, an underscore in the
label text indicates the next character should be underlined and used for the
mnemonic accelerator key if it is the first character so
marked. Available in PyGTK 2.4 and above. |
Returns : | a new gtk.MenuItem
widget |
Creates a new gtk.MenuItem
widget and sets the text of the menu item label to the value of
label. If label is
None no label is created for the menu item. The text of
label is parsed for underscore characters that indicate that the next
character is a mnemonic accelerator.
In PyGTK 2.4 and above the use_underline
parameter is available and defaults to True. If
use_underline is set to False the
label text will not be parsed for mnemonic characters.
def set_submenu(submenu)
| the menu to use as the submenu |
The set_submenu() method sets the menu
specified by submenu as the submenu for the menu
item.
def get_submenu()Returns : | the submenu for this menu item, or
None if there is no submenu. |
The get_submenu() method returns the
submenu widget associated with this menu item. If there is no submenu this
method returns None. See set_submenu().
def remove_submenu()The remove_submenu() method removes the
submenu associated with the menu item.
def deselect()The deselect() method emits the
"deselect" signal on the menu item.
def activate()The activate() method emits the
"activate" signal on the menu item.
def toggle_size_request()Returns : | the size requisition |
This method is available in PyGTK 2.4 and above.
The toggle_size_request() method emits
the "toggle-size-request" signal on the menuitem and returns the size
requested for the menuitem.
def toggle_size_allocate(allocation)
| the allocation size for the menu item |
The toggle_size_allocate() method emits
the "toggle-size-allocate" signal on the menu item.
def set_right_justified(right_justified)
| if True the menu item will
appear at the far right if added to a menu bar. |
The set_right_justified() method sets
the justification of the menu item according to the value of
right_justified. If
right_justified is True the menu
item will appear at the right side of a menu bar. If the widget layout is
reversed for a right-to-left language like Hebrew or Arabic,
right-justified-menu-items appear on the left.
def get_right_justified()Returns : | True if the menu item will
appear at the far right if added to a menu bar. |
The get_right_justified() method gets
the justification of the menu item. If True the menu item
appears justified at the right side of the menu bar.
def set_accel_path(accel_path)
| the accelerator path, corresponding to this menu item |
The set_accel_path() method sets the
accelerator path on the menu item. The accelerator path provides access to
the menu item's accelerator allowing user changes to be identified and saved
to persistent storage. See also the gtk.Menu.set_accel_path()
method for a more convenient variant of this function. This method is a
convenience wrapper that handles calling gtk.Widget.set_accel_path()
with the appropriate accelerator group for the menu item.
def get_accel_path()Returns : | the accelerator path corresponding to this menu
item's functionality, or None if not set |
The get_accel_path() method gets the accelerator
path that was previously set on menu_item.
def set_label(label)
| the text you want to set. |
This method is available in PyGTK 2.16 and above.
The set_label() method sets the text
specified by label on the menu_item label .
def get_label()Returns : | The text in the menu_item label. |
This method is available in PyGTK 2.16 and above.
The get_label() method gets the text in the menu_item label.
def set_use_underline(setting)
| True if underlines in the text indicate mnemonics. |
This method is available in PyGTK 2.16 and above.
The set_use_underline() method gets whether an underline in the text
indicates the next character should be used for the mnemonic accelerator key.
def get_use_underline()Returns : | True if an embedded underline in the label indicates the mnemonic accelerator key. |
This method is available in PyGTK 2.16 and above.
The get_use_underline() method checks if an underline in the text indicates
the next character should be used for the mnemonic accelerator key.
def callback(menuitem, user_param1, ...)
| the menuitem that received the signal |
| the first user parameter (if any) specified
with the connect() |
| additional user parameters (if any) |
The "activate" signal is emitted when the menu item is activated.
def callback(menuitem, user_param1, ...)
| the menuitem that received the signal |
| the first user parameter (if any) specified
with the connect() |
| additional user parameters (if any) |
The "activate-item" signal is emitted when the menu item is activated, but also if the menu item has a submenu. For normal applications, the relevant signal is "activate".
def callback(menuitem, allocation, user_param1, ...)
| the menuitem that received the signal |
| the size allocation for the menuitem |
| the first user parameter (if any) specified
with the connect() |
| additional user parameters (if any) |
The "toggle-size-allocate" signal is emitted when the size allocation is changed.
def callback(menuitem, requisition, user_param1, ...)
| the menuitem that received the signal |
| the pointer to the location to put the size request |
| the first user parameter (if any) specified
with the connect() |
| additional user parameters (if any) |
The "toggle-size-request" signal is emitted when a new size request is needed.