Gtk2::Button

Section: User Contributed Perl Documentation (3)
Updated: 2008-05-05
Index Return to Main Contents
 

NAME

Gtk2::Button  

HIERARCHY

  Glib::Object
  +----Glib::InitiallyUnowned
       +----Gtk2::Object
            +----Gtk2::Widget
                 +----Gtk2::Container
                      +----Gtk2::Bin
                           +----Gtk2::Button

 

INTERFACES

  Glib::Object::_Unregistered::AtkImplementorIface

 

MNEMONICS

Mnemonics are ``memory aids''; in GTK+, a mnemonic is an underlined character which corresponds to a keyboard accelerator. For a button, that means pressing Alt and that key activates the button.

For convenience, Gtk2-Perl uses mnemonics by default on widgets that support them. If characters in label string are preceded by an underscore, they are underlined. If you need a literal underscore character in a label, use '__' (two underscores). If you don't want to use mnemonics at all, use the non-mnemonic version explicitly (e.g. "Gtk2::Button::new_with_label").  

METHODS

 

widget = Gtk2::Button->new

 

widget = Gtk2::Button->new ($mnemonic)

* $mnemonic (string) used to label the widget, see MNEMONICS
 

widget = Gtk2::Button->new_from_stock ($stock_id)

* $stock_id (string) creates a new button using the icon and text from the

specified stock item, see Gtk2::Stock

 

widget = Gtk2::Button->new_with_label ($label)

* $label (string) used to label the widget
 

widget = Gtk2::Button->new_with_mnemonic ($mnemonic)

* $mnemonic (string) used to label the widget, see MNEMONICS
 

(xalign, yalign) = $button->get_alignment

Since: gtk+ 2.4
 

$button->set_alignment ($xalign, $yalign)

* $xalign (double)
* $yalign (double)

Since: gtk+ 2.4

 

$button->clicked

 

$button->enter

 

boolean = $button->get_focus_on_click

Since: gtk+ 2.4
 

$button->set_focus_on_click ($focus_on_click)

* $focus_on_click (boolean)

Since: gtk+ 2.4

 

widget or undef = $button->get_image

Since: gtk+ 2.6
 

positiontype = $button->get_image_position

Since: gtk+ 2.9
 

$button->set_image_position ($position)

* $position (Gtk2::PositionType)

Since: gtk+ 2.9

 

$button->set_image ($image)

* $image (Gtk2::Widget or undef)

Since: gtk+ 2.6

 

string = $button->get_label

 

$button->set_label ($label)

* $label (string)
 

$button->leave

 

$button->pressed

 

$button->released

 

reliefstyle = $button->get_relief

 

$button->set_relief ($newstyle)

* $newstyle (Gtk2::ReliefStyle)
 

boolean = $button->get_use_stock

 

$button->set_use_stock ($use_stock)

* $use_stock (boolean)
 

boolean = $button->get_use_underline

 

$button->set_use_underline ($use_underline)

* $use_underline (boolean)
 

PROPERTIES

'focus-on-click' (boolean : readable / writable / private)
Whether the button grabs focus when it is clicked with the mouse
'image' (Gtk2::Widget : readable / writable / private)
Child widget to appear next to the button text
'image-position' (Gtk2::PositionType : readable / writable / private)
The position of the image relative to the text
'label' (string : readable / writable / construct / private)
Text of the label widget inside the button, if the button contains a label widget
'relief' (Gtk2::ReliefStyle : readable / writable / private)
The border relief style
'use-stock' (boolean : readable / writable / construct / private)
If set, the label is used to pick a stock item instead of being displayed
'use-underline' (boolean : readable / writable / construct / private)
If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key
'xalign' (Glib::Float : readable / writable / private)
Horizontal position of child in available space. 0.0 is left aligned, 1.0 is right aligned
'yalign' (Glib::Float : readable / writable / private)
Vertical position of child in available space. 0.0 is top aligned, 1.0 is bottom aligned
 

SIGNALS

pressed (Gtk2::Button)
released (Gtk2::Button)
clicked (Gtk2::Button)
enter (Gtk2::Button)
leave (Gtk2::Button)
activate (Gtk2::Button)
 

ENUMS AND FLAGS

 

enum Gtk2::PositionType

* 'left' / 'GTK_POS_LEFT'
* 'right' / 'GTK_POS_RIGHT'
* 'top' / 'GTK_POS_TOP'
* 'bottom' / 'GTK_POS_BOTTOM'
 

enum Gtk2::ReliefStyle

* 'normal' / 'GTK_RELIEF_NORMAL'
* 'half' / 'GTK_RELIEF_HALF'
* 'none' / 'GTK_RELIEF_NONE'
 

SEE ALSO

Gtk2, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget, Gtk2::Container, Gtk2::Bin  

COPYRIGHT

Copyright (C) 2003-2008 by the gtk2-perl team.

This software is licensed under the LGPL. See Gtk2 for a full notice.


 

Index

NAME
HIERARCHY
INTERFACES
MNEMONICS
METHODS
widget = Gtk2::Button->new
widget = Gtk2::Button->new ($mnemonic)
widget = Gtk2::Button->new_from_stock ($stock_id)
widget = Gtk2::Button->new_with_label ($label)
widget = Gtk2::Button->new_with_mnemonic ($mnemonic)
(xalign, yalign) = $button->get_alignment
$button->set_alignment ($xalign, $yalign)
$button->clicked
$button->enter
boolean = $button->get_focus_on_click
$button->set_focus_on_click ($focus_on_click)
widget or undef = $button->get_image
positiontype = $button->get_image_position
$button->set_image_position ($position)
$button->set_image ($image)
string = $button->get_label
$button->set_label ($label)
$button->leave
$button->pressed
$button->released
reliefstyle = $button->get_relief
$button->set_relief ($newstyle)
boolean = $button->get_use_stock
$button->set_use_stock ($use_stock)
boolean = $button->get_use_underline
$button->set_use_underline ($use_underline)
PROPERTIES
SIGNALS
ENUMS AND FLAGS
enum Gtk2::PositionType
enum Gtk2::ReliefStyle
SEE ALSO
COPYRIGHT

linux.jgfs.net manual pages