Manpages

Manpage of PERL-GTK-REF

PERL-GTK-REF

Section: User Contributed Perl Documentation (1)
Updated: perl v5.6.1
Index
Return to Main Contents
 

NAME

Reference documentation for the Gtk module  

Gtk

 

$func->_bootstrap ()

 

Gtk->_exit ($status)


* $status (integer)

Exits the program with status as the result code (useful after a fork() call).  

string Gtk->check_version ($req_maj, $req_min, $req_micro)


* $req_maj (integer)

* $req_min (integer)

* $req_micro (integer)
 

scalar $data->constsubstr ($offset, $len)


* $offset (integer)

* $len (integer)
 

Gtk->error ($text)


* $text (string)

Print text as an error using Gtk+'s output facilities. This function also exits the program with an error.  

integer Gtk->events_pending ()

Check if there are any events pending for the toolkit to service.  

Gtk->exit ($status)


* $status (integer)

Exits the program with status as the result code.  

boolean Gtk->false ()

Utility function that always return a FALSE value. Most useful in some signal handler.  

Gtk->gc ()

Perform a garbage collection run.  

Gtk::Gdk::Event Gtk->get_current_event ()

 

Gtk::Widget Gtk->get_event_widget ($event)


* $event (Gtk::Gdk::Event)

Get the widget the event event is destined for.  

Gtk->grab_add ($widget)


* $widget (Gtk::Widget)

Add widget to the grab list (events are sent to this widgets first).  

Gtk::Widget Gtk->grab_get_current ()

Get current grabbing widget.  

Gtk->grab_remove ($widget)


* $widget (Gtk::Widget)

Remove widget to the grab list.  

integer Gtk->idle_add ($handler, ...)


* $handler (subroutine) generic subroutine

* ... (list) additional args for $handler

Add an idle handler (a function that gets called when the main loop is not busy servicing toolkit events). handler is called with the additional arguments as parameters.  

integer Gtk->idle_add_priority ($priority, $handler, ...)


* $priority (integer)

* $handler (subroutine) generic subroutine

* ... (list) additional args for $handler

Add an idle handler (a function that gets called when the main loop is not busy servicing toolkit events). handler is called with the additional arguments as parameters. The lower the value of priority, the highter the priority of the handler.  

Gtk->idle_remove ($tag)


* $tag (integer)

Remove an idle handler identified by tag.  

Gtk->init ()

Initialize the Gtk module. Parses the args out of @ARGV.  

Gtk->init_add ($handler, ...)


* $handler (subroutine) generic subroutine

* ... (list) additional args for $handler

Add an handler to be called at initialization time.  

boolean Gtk->init_check ()

Initialize the Gtk module checking for a connection to the display.  

Gtk->init_types ()

 

integer Gtk->key_snooper_install ($handler, ...)


* $handler (subroutine) key snooper subroutine

* ... (list) additional arguments for $handler

Install a key snooper handler: the subroutine will get a Gtk::Widget, a If the function returns a TRUE value the key event will not be handed over to the Gtk internals.  

Gtk->key_snooper_remove ($tag)


* $tag (integer)

Removes the key snooper handler identified by tag.  

Gtk->main ()

Run an instance of the main loop.  

integer Gtk->main_iteration ()

Performs a (blocking) iteration of the main loop.  

integer Gtk->main_iteration_do ($blocking)


* $blocking (boolean)

Performs a (optionally blocking) iteration of the main loop.  

integer Gtk->main_level ()

Returns the current main loop level (main loops can be nested).  

Gtk->main_quit (...)


* ... (list)

Quit the main loop.  

integer Gtk->major_version ()

 

integer Gtk->micro_version ()

 

integer Gtk->minor_version ()

 

Gtk->mod_init_add ($module, $handler, ...)


* $module (string)

* $handler (scalar)

* ... (list)
 

Gtk->module_configure ($data)


* $data (scalar)
 

Gtk->print ($text)


* $text (string)

Print text using Gtk+'s output facilities.  

integer Gtk->quit_add ($main_level, $handler, ...)


* $main_level (integer)

* $handler (subroutine) generic subroutine

* ... (list) additional arguments for $handler

Add an handler to be called when the main loop of level main_level quits.  

Gtk->quit_remove ($tag)


* $tag (integer)

Remove the main loop quit handler identified by tag.  

string Gtk->set_locale ()

Tells the library to use the locale support. This function must be called before any of the init ones.  

integer Gtk->timeout_add ($interval, $handler, ...)


* $interval (integer)

* $handler (subroutine) generic subroutine

* ... (list) additional args for $handler

Add a timeout handler. interval is the interval in milliseconds. handler is called every interval milliseconds with the additional arguments as parameters.  

Gtk->timeout_remove ($tag)


* $tag (integer)

Remove a timeout handler identified by tag.  

boolean Gtk->true ()

Utility function that always returns a TRUE value. Most useful in some signal handler.  

Gtk->warning ($text)


* $text (string)

Print text as a warning using Gtk+'s output facilities.  

integer Gtk->watch_add ($sv, $priority, $handler, ...)


* $sv (scalar)

* $priority (integer)

* $handler (scalar)

* ... (list)
 

Gtk->watch_remove ($tag)


* $tag (integer)
 

Gtk::AccelGroup

 

boolean $accel_group->activate ($accel_key, $accel_mods)


* $accel_key (integer)

* $accel_mods (Gtk::Gdk::ModifierType)
 

$accel_group->add ($accel_key, $accel_mods, $accel_flags, $object, $accel_signal)


* $accel_key (integer)

* $accel_mods (Gtk::Gdk::ModifierType)

* $accel_flags (Gtk::AccelFlags)

* $object (Gtk::Object)

* $accel_signal (string)
 

$accel_group->attach ($object)


* $object (Gtk::Object)
 

$accel_group->detach ($object)


* $object (Gtk::Object)
 

Gtk::AccelGroup Gtk::AccelGroup->get_default ()

 

$accel_group->lock ()

 

$accel_group->lock_entry ($accel_key, $accel_mods)


* $accel_key (integer)

* $accel_mods (Gtk::Gdk::ModifierType)
 

Gtk::AccelGroup Gtk::AccelGroup->new ()

 

$accel_group->remove ($accel_key, $accel_mods, $object)


* $accel_key (integer)

* $accel_mods (Gtk::Gdk::ModifierType)

* $object (Gtk::Object)
 

$accel_group->unlock ()

 

$accel_group->unlock_entry ($accel_key, $accel_mods)


* $accel_key (integer)

* $accel_mods (Gtk::Gdk::ModifierType)
 

Gtk::AccelLabel

 

integer $accel_label->accelerator_width ()

 

integer $accel_label->get_accel_width ()

 

Gtk::AccelLabel Gtk::AccelLabel->new ($string)


* $string (string)
 

boolean $accel_label->refetch ()

 

$accel_label->set_accel_widget ($accel_widget)


* $accel_widget (Gtk::Widget)
 

Gtk::Accelerator

 

Gtk::Gdk::ModifierType Gtk::Accelerator->get_default_mod_mask ()

 

string Gtk::Accelerator->name ($accel_key, $accel_mods)


* $accel_key (integer)

* $accel_mods (Gtk::Gdk::ModifierType)
 

Gtk::Accelerator->parse ($accelerator)


* $accelerator (string)
 

Gtk::Accelerator->set_default_mod_mask ($default_mod_mask)


* $default_mod_mask (Gtk::Gdk::ModifierType)
 

boolean Gtk::Accelerator->valid ($keyval, $modifiers)


* $keyval (integer)

* $modifiers (Gtk::Gdk::ModifierType)
 

Gtk::Adjustment

 

$adj->changed ()

 

$adj->clamp_page ($lower, $upper)


* $lower (double)

* $upper (double)
 

float $adjustment->get_value ()

 

float $adjustment->lower ($new_value)


* $new_value (float)
 

Gtk::Adjustment Gtk::Adjustment->new ($value, $lower, $upper, $step_increment, $page_increment, $page_size)


* $value (double)

* $lower (double)

* $upper (double)

* $step_increment (double)

* $page_increment (double)

* $page_size (double)
 

float $adjustment->page_increment ($new_value)


* $new_value (scalar)
 

float $adjustment->page_size ($new_value)


* $new_value (scalar)
 

$adjustment->set_value ($value)


* $value (double)
 

float $adjustment->step_increment ($new_value)


* $new_value (scalar)
 

float $adjustment->upper ($new_value)


* $new_value (scalar)
 

float $adjustment->value ($new_value)


* $new_value (scalar)
 

$adj->value_changed ()

 

Gtk::Alignment

 

Gtk::Alignment Gtk::Alignment->new ($xalign, $yalign, $xscale, $yscale)


* $xalign (double)

* $yalign (double)

* $xscale (double)

* $yscale (double)
 

$alignment->set ($xalign, $yalign, $xscale, $yscale)


* $xalign (double)

* $yalign (double)

* $xscale (double)

* $yscale (double)
 

Gtk::Arrow

 

Gtk::Arrow Gtk::Arrow->new ($arrow_type, $shadow_type)


* $arrow_type (Gtk::ArrowType)

* $shadow_type (Gtk::ShadowType)
 

$arrow->set ($arrow_type, $shadow_type)


* $arrow_type (Gtk::ArrowType)

* $shadow_type (Gtk::ShadowType)
 

Gtk::AspectFrame

 

Gtk::AspectFrame Gtk::AspectFrame->new ($label, $xalign, $yalign, $ratio, $obey_child)


* $label (string)

* $xalign (double)

* $yalign (double)

* $ratio (double)

* $obey_child (boolean)
 

$aspect_frame->set ($xalign, $yalign, $ratio, $obey_child)


* $xalign (double)

* $yalign (double)

* $ratio (double)

* $obey_child (boolean)
 

Gtk::Bin

 

Gtk::Widget $widget->child ($newvalue)


* $newvalue (Gtk::Widget) may be undef
 

Gtk::Box

 

$box->children ()

 

$box->pack_end ($child, $expand, $fill, $padding)


* $child (Gtk::Widget)

* $expand (integer)

* $fill (integer)

* $padding (integer)
 

$box->pack_end_defaults ($child)


* $child (Gtk::Widget)
 

$box->pack_start ($child, $expand, $fill, $padding)


* $child (scalar)

* $expand (scalar)

* $fill (scalar)

* $padding (scalar)
 

$box->pack_start_defaults ($child)


* $child (scalar)
 

$box->query_child_packing ($child)


* $child (Gtk::Widget)
 

$box->reorder_child ($child, $pos)


* $child (Gtk::Widget)

* $pos (integer)
 

$box->set_child_packing ($child, $expand, $fill, $padding, $pack_type)


* $child (Gtk::Widget)

* $expand (integer)

* $fill (integer)

* $padding (integer)

* $pack_type (Gtk::PackType)
 

$box->set_homogeneous ($homogeneous)


* $homogeneous (integer)
 

$box->set_spacing ($spacing)


* $spacing (integer)
 

Gtk::BoxChild

 

integer $child->expand ()

 

integer $child->fill ()

 

integer $child->pack ()

 

integer $child->padding ()

 

Gtk::Widget $child->widget ()

 

Gtk::Button

 

$button->clicked ()

 

$button->enter ()

 

Gtk::ReliefStyle $button->get_relief ()

 

$button->leave ()

 

Gtk::Button Gtk::Button->new ($label)


* $label (string)
 

Gtk::Button Gtk::Button->new_with_label ($label)


* $label (scalar)
 

$button->pressed ()

 

$button->released ()

 

$button->set_relief ($style)


* $style (Gtk::ReliefStyle)
 

Gtk::ButtonBox

 

$buttonbox->get_child_ipadding ()

 

Gtk::ButtonBox->get_child_ipadding_default ()

 

$buttonbox->get_child_size ()

 

Gtk::ButtonBox->get_child_size_default ()

 

integer $buttonbox->get_layout ()

 

integer $buttonbox->get_spacing ()

 

$buttonbox->set_child_ipadding ($ipad_x, $ipad_y)


* $ipad_x (integer)

* $ipad_y (integer)
 

Gtk::ButtonBox->set_child_ipadding_default ($ipad_x, $ipad_y)


* $ipad_x (integer)

* $ipad_y (integer)
 

$buttonbox->set_child_size ($min_width, $min_height)


* $min_width (integer)

* $min_height (integer)
 

Gtk::ButtonBox->set_child_size_default ($min_width, $min_height)


* $min_width (integer)

* $min_height (integer)
 

$buttonbox->set_layout ($layout_style)


* $layout_style (Gtk::ButtonBoxStyle)
 

$buttonbox->set_spacing ($spacing)


* $spacing (integer)
 

Gtk::CList

 

integer $clist->append ($text, ...)


* $text (string) text to put in the first column

* ... (list) additional strings to put in the second, third... columns
 

$clist->clear ()

 

Gtk::Gdk::Window $clist->clist_window ()

 

$clist->column_title_active ($column)


* $column (integer)
 

$clist->column_title_passive ($column)


* $column (integer)
 

$clist->column_titles_active ()

 

$clist->column_titles_hide ()

 

$clist->column_titles_passive ()

 

$clist->column_titles_show ()

 

integer $clist->columns ()

 

integer $clist->columns_autosize ()

 

integer $clist->find_row_from_data ($data)


* $data (scalar)
 

integer $clist->focus_row ()

 

$clist->freeze ()

 

Gtk::Style $clist->get_cell_style ($row, $column)


* $row (integer)

* $column (integer)
 

Gtk::CellType $clist->get_cell_type ($row, $column)


* $row (integer)

* $column (integer)
 

string $clist->get_column_title ($column)


* $column (integer)
 

Gtk::Widget $clist->get_column_widget ($column)


* $column (integer)
 

Gtk::Adjustment $clist->get_hadjustment ()

 

$clist->get_pixmap ($row, $column)


* $row (integer)

* $column (integer)
 

$clist->get_pixtext ($row, $column)


* $row (integer)

* $column (integer)
 

scalar $clist->get_row_data ($row)


* $row (integer)
 

Gtk::Style $clist->get_row_style ($row)