SimpleGtk2

sub use_gettext #( <locale_paths>, <translation_file>, <codeset> )

Activate localization via gettext.

Parameters

Returns

None.

Example

SimpleGtk2::use_gettext("fns-menu-configurator", "$ENV{FVWM_USERDIR}/locale:$ENV{FNS_SYSTEMDIR}/locale:+");

sub translate #( <text> )

Translation function used to translate text parts interrupted by variables.

Parameters

Returns

The translated text or its’ original.

Example

my $multi_menu_title = $win->translate('Menus in') . ' ' . $key;

sub internal_die #( <msg> )

Internal die function if a fatal error occurs.

This may be used to end the program with a corresponding message.  For a clean exit use <showError> instead.

Parameters

Returns

A die message before exiting the program.

Example

$win->internal_die($object, "No action defined!");

Output

[$win->$ExitButton]: No action defined! Exiting.

sub show_error #( <msg> )

Print an error message to standard error.

Parameters

Returns

None.

Example

$win->show_error($nb_object, "No notebook page with number \"$number\" found.");

Output

[$win->$nb1][err]: No notebook page with number "123" found.

sub show_message #( <msg> )

Print a message to standard error.

Parameters

Returns

None.

Example

$win->show_message("xcompmgr not installed. Ignoring.");

Output

[FNS-CompConfigurator][msg]: xcompmgr not installed. Ignoring.

sub add_signal_handler #( <name>, <signal>, <function>, [<data>] )

Adds a signal handler to a widget.

It connects a signal to a sub procedure related to the widget.

Parameters

Returns

None.

Examples

$win->add_signal_handler('closeButton', 'clicked', sub{Gtk2->main_quit;});
--------------------------------------
$win->add_signal_handler('changeIconDir', 'clicked', \&change_path, [$win, 'entryIconDir']);

sub remove_signal_handler #( <name>, <signal> )

Removes a signal handler (signal-function pair) from a widget.

Parameters

Returns

None.

Examples

$win->remove_signal_handler('closeButton', 'clicked');
--------------------------------------
$win->remove_signal_handler('changeIconDir', 'clicked');

sub get_object #( <name|widget> )

Get the SimpleGtk2 widget hash from internal objects list.

Parameters

Returns

Object hash

Examples

# with name
$win->get_object('NB_page' . $number)->{pagelabel}->set_sensitive($state);
--------------------------------------
# with widget reference
my $object_name = $win->get_object($widget)->{name};

sub exist_object #( <name|widget> )

Check function if SimpleGtk2 object xyz exists.

Parameters

Returns

1 if true else 0.

Example

if (defined($win->exist_object('entrySplashPath'))) { ... }

sub get_widget #( <name> )

Get a Gtk2 widget reference of a SimpleGtk2 object.

Restriction

Not available for the following widget: GtkNotebookPage.

Parameters

Returns

A Gtk2 widget reference.

Example

$win->add_signal_handler('checkEnabled' . $name_number, 'toggled', sub {&on_checkbox_enabled_toggled($win->get_widget('comboResolution' . $name_number), $name);});

sub hide_widget #( <name> )

Hide a widget.

Restriction

Not available for the following widgets: GtkMenu, GtkMenuItem, GtkMenuBar and GtkNotebookPage.

Parameters

Returns

None.

Example

$win->add_signal_handler('image1', 'button_press_event', sub{$win->hide_widget('frame1');});

sub show_widget #( <name> )

Show a hidden widget.

Restriction

Not available for the following widgets: GtkMenu, GtkMenuItem, GtkMenuBar and GtkNotebookPage.

Parameters

Returns

None.

Example

$win->add_signal_handler('image1', 'button_press_event', sub{$win->show_widget('frame1');});

sub is_sensitive #( <name> )

Returns the sensitive state of a widget.

Parameters

Returns

Example

my $state = $win->is_sensitive('Check1');

sub set_sensitive #( <name|group>, <state> )

Set sensitivity of a widget, a radio group or notebook page.

Parameters

Returns

None.

Example

# deactivation of a radio group
$win->set_sensitive('r_state', 0);

sub get_title #( <name> )

Returns the title text of a widget or the active value of a combo box.

Restriction

Not available for the following widgets: GtkSlider, GtkScrollBar, GtkImage, GtkTextView, GtkMenuBar, GtkNotebook.

Parameters

Returns

The title text or undef.

Examples

# check whether a combo box value is currently set
unless ($win->get_title('comboWindow') eq 'TopLeft') {
    &set_config_value('WindowsPlacement', $win->get_title('comboWindow'));
}
--------------------------------------
# print window title with message to standard error
print STDERR "[" . $win->get_title($win->{name}) . "]: $user_cfg saved.\n";

sub set_title #( <name>, <new_title> )

Sets the new title text of a widget or the active value of a combo box.

Restriction

Not available for the following widgets: GtkSlider, GtkScrollBar, GtkImage, GtkTextView, GtkMenuBar, GtkNotebook.

Parameters

Returns

None.

Examples

# set label text depending on the current max virt size
$win->set_title('labelMaxSizeValue', $xrandr->getMaxVirtSize());
--------------------------------------
# set new title of the notebook page 2
$win->set_title("NB_page2", "1Bibbile");

sub get_size #( <name> )

Returns the current width and height (in pixel) of a widget.

Restriction

Not available for the following widgets: GtkMenu, GtkMenuItem, GtkNotebookPage.

Parameters

Returns

An array of the current width and height or undef.

Example

my ($width, $height) = $win->get_size('Image1');

sub set_size #( <name>, <new_width>, <new_height> )

Sets the new size of a widget.

Restriction

Not available for the following widgets: GtkCheckButton, GtkRadioButton, GtkLabel, GtkMenu, GtkMenuItem, GtkNotebookPage.

Parameters

Returns

None.

Example

$win->set_size('image1', 200, 100);

sub get_pos #( <name> )

Returns the current position (in pixel) of a widget.

Restriction

Not available for the following widgets: GtkMenu, GtkMenuItem, GtkNotebookPage.

Parameters

Returns

An array of the current x and y position or undef.

Example

my ($pos_x, $pos_y) = $win->get_pos('cbox1');

sub set_pos #( <name>, <new_x>, <new_y> )

Sets the new position of a widget.

Restriction

Not available for the following widgets: GtkMenu, GtkMenuItem, GtkNotebookPage.

Parameters

Returns

None.

Example

$win->set_pos('check_button', 10, 45);

sub is_active #( <name>, [<value/string>] )

Returns the state of Check- and RadioButtons or for given combobox value/string.

Parameters

Returns

An array of the current x and y position or undef.

Example

my ($pos_x, $pos_y) = $win->get_pos('cbox1');

sub is_underlined #( <text> )

Returns the state of a text whether it has an underline.

Parameters

Returns

1 for underlined else 0.

Example

if ($win->is_underlined($object->{title})) { ... }

sub get_value #(   <name>,      <keyname>,    or  <keyname>  =  > <value> )

Returns a current value of a widget.

Parameters

KEYNAMES

GtkCheckButton

GtkRadioButton

GtkLinkButton

GtkFontButton

GtkLabel

GtkEntry

GtkSpinButton

GtkComboBox

GtkSlider

GtkScrollbar

GtkTextView

Note: “Path”, “Textview” and “Textbuf|Textbuffer” can get with get_textview.

GtkMenu

GtkMenuItem

GtkNotebook

GtkNotebookPage

GtkFontButton

GtkFontSelectionDialog

GtkStatusbar

GtkTreeView::List

GtkTreeView::Tree

Returns

The found value.

Examples

if ($win->get_value("comboMaxFreq" . $a, "active") != $win->get_value("comboMaxFreqCommon", "active")) { ... }
--------------------------------------
my $rowref = $window->get_value("slist", path => $index);

sub set_value #( <name>,    <keyname>  =  > <new_value> )

Sets a new value for a widget.

Parameters

KEYNAMES

GtkCheckButton

GtkRadioButton

GtkLinkButton

GtkFontButton

GtkLabel

GtkEntry

GtkSpinButton

GtkComboBox

GtkSlider

GtkScrollbar

GtkTextView

Note: ‘Path’, ‘Textview’ and ‘Textbuf|Textbuffer’ can set with set_textview.

GtkMenu

GtkMenuItem

GtkNotebook

GtkNotebookPage

GtkFontButton

GtkFontSelectionDialog

GtkTreeview::List

GtkTreeview::Tree

Returns

None.

Examples

$win->set_value('NB1', Currentpage => $win->get_value('NB1', Title2number => $out));
--------------------------------------
$spin_button->set_value($cell->get("value"));

sub set_values #( <name>,    <keyname>  =  > <new_value>, <keyname>  =  > <new_value>, ...    )

Set a bunch of new values for a widget.

Parameters

KEYNAMES

See set_value for possible keynames.

Returns

None.

Examples

$win->set_values('spinDesktopX', Start => $current_x_desks, Min => 1, Max => $max, Step => 1);
--------------------------------------
$win->set_values($name, Data => $item_list_ref, Start => $active_item_nr);

sub get_fontsize #( <name|widget> )

Returns the current font size of a widget.

Parameters

Returns

The font size.

Example

my $fontsize = get_fontsize($window);

sub get_fontfamily #( <name|widget> )

Returns the current font family of a widget.

Parameters

Returns

The font family.

Example

my $fontsize = get_fontsize($window);

sub get_fontweight #( <name|widget> )

Returns the current font weight of a widget.

Parameters

Returns

The font weight.

Example

my $fontweight = get_fontweight($window);

sub get_font_string #( <name> )

Returns the current font string of a widget.

Parameters

Returns

The font size.

Example

$testfont = $win->get_font_string('frame1');

sub get_font_array #( <name> )

Returns current font string of a widget as an array.

Parameters

Returns

A font array [family, size, weight].

Example

my @fontarray = $win->get_font_array('frame1');

sub font_array_to_string #( <font_array> )

Converts a font array into a font string.

Parameters

Returns

A font string.

Example

my @fontarray = (Sans, 12);
my $fontstring = font_array_to_string(@fontarray);

sub font_string_to_array #( <font_string> )

Converts a font string into a font array.

Parameters

Returns

A font array [family, size[, weight]].

Example

my @fontarray = font_string_to_array('Arial Rounded MT Bold, Bold Italic 12');

sub set_font #(   <name>,      <font_string>,    or  [family, size, [weight]],    or  Family  =  > <Family>,   Size  =  > <Size>,   Weight  =  > <Weight> )

Set new font of a widget.

Parameters

Returns

None.

Example

$win->set_font('frame1', Family => 'Bernard MT Condensed');

sub set_font_color #( <name>, <color>, [<state>] )

Set new font color of a widget.

Parameters

Returns

None.

Examples

$win->set_font_color('checkButton1','red');
--------------------------------------
$win->set_font_color('label1', '#8B008B');

sub new_window #( Name  =  > <name>, Title  =  > <window title>, [Version => <version-string>],    [Base => <font_size>],    [Size => [width, height]],    [Fixed => <0/1>],    [Iconpath => <icon_path>],    [ThemeIcon => <theme_icon_name>],    [Statusbar => <show_time|1>]    )

Creates a new GtkWindow, a toplevel window, that contain other widgets.

It contains by default a fixed container in a scrollable window widget.  So whether it is resized smaller than defined vertical and/or horizontal scrollbars appear.

Parameters

Returns

The main window object.

Example

my $win = SimpleGtk2->new_window(Name => 'mainWindow',
                        Title      => 'testem-all',
                        Size       => [400, 400],
                        ThemeIcon  => 'emblem-dropbox-syncing');

References

Gtk2-Perl, Gtk2

Available Support Function

show ()

show_and_run ()

sub show #()

Show toplevel window with all widgets without running Gtk2->main

This is the default loop function if library will be used in FVWM modules.

Parameters

None.

Returns

None.

sub show_and_run #()

Show toplevel window with all widgets and start Gtk2->main.

This is the default loop function.

Parameters

None.

Returns

None.

sub add_msg_dialog #( Name  =  > <name>, Modal  =  > <0/1>, DType  =  > <dialog_type>, MTyp  =  > <message_type>, [Icon => <path|stock|name>],    [RFunc => <response_function>]    )

Creates a new GtkMessageDialog object.

GtkMessageDialog presents a dialog with an image representing the type of message (Error, Question, etc.) alongside some message text.

Internal Name Type

MessageDialog

Parameters

Returns

None.

Examples

# a modal message dialog
$win->add_msg_dialog(Name => 'diag1',
        DType   => 'ok-cancel',
        MType   => 'warning',
        Icon    => 'gtk-quit');
--------------------------------------
# a non modal message dialog
$win->add_msg_dialog(Name => 'diag2',
        DType   => 'yes-no',
        MType   => 'info',
        RFunc   => \&nonModal,
        Modal   => 0);

References

Gtk2-Perl, Gtk2

Available Support Function

sub show_msg_dialog #(   <name>,   <message_text1>,   <message_text2>, or  <dialog_type>,   <message_type>,   <message_text> )

Shows a standalone, simple or normal message dialog.

The normal message dialog needs a message dialog object created with add_msg_dialog.

The standalone and the simple message dialog don’t need this object.

Parameters for a normal

Parameters for a standalone or simple

Returns

The response.  Can be “ok”, “close”, “cancel”, “yes”, “no” depending on the dialog type.

Examples

# A standalone message dialog
my $response = SimpleGtk2::show_msg_dialog('warning', 'yes-no', "This is a simple standalone");
--------------------------------------
# A simple one
my $response = $win->show_msg_dialog('warning', 'yes-no', "This is a simple one");
--------------------------------------
# A normal non-modal message dialog

sub nonModal{
    my $response = shift;
    if ($response eq 'yes') {print "Yes\n";}
    else {print "No\n";}
}

my $FirstMsg = "<span foreground=\"blue\" size=\"x-large\">Message Type</span>";
my $SecondMsg = "<span foreground='red' size=\"small\" style ='italic'>Info box.</span>";

$win->add_button(Name => 'Button2',
        Pos     => [60, 60],
        Size    => [80, 40],
        Title   => "_NonModal");
$win->add_signal_handler('Button2', 'clicked', sub{$win->show_msg_dialog('diag2', $FirstMsg, $SecondMsg);});

$win->add_msg_dialog(Name => 'diag2',
        DType   => 'yes-no',
        MType   => 'info',
        RFunc   => \&nonModal,
        Modal   => 0);

sub add_image #(   Name  =  > <name>,   Path  =  > <file_path>, or  Pixbuffer  =  > <pix_buffer_object>, or  Stock  =  > [<stock_name>[,<stock_size>]],   Size  =  > [width, height],   Position  =  > [pos_x, pos_y],   [Frame => <frame_name>],      [Tooltip => <tooltip_text>],      [Function => <function_click>],      [Signal => <signal>],      [Sensitive => <sensitive>]    )

Creates a new GtkImage widget.

The GtkImage widget displays an image.  Various kinds of object can be displayed as an image; most typically, you would load a GdkPixbuf (“pixel buffer”) from a file, and then display that.  Additionally it is possible to bind a left click action to the image.  Also a tooltip is possible.

Internal Name Type

Image

Parameters

Returns

None.

Example

# with pixbuf object
my $pixbuf = Gtk2::Gdk::Pixbuf->new_from_file("./myimage.png");
$win->add_image(Name => 'image2',
        Pos     => [240, 100],
        Size    => [50, 50],
        Tip     => 'A second picture',
        Frame   => 'frame1',
        Pixbuf  => $pixbuf);
$win->add_signal_handler('image2', 'button_press_event', \&Maximize);

References

Gtk2-Perl, Gtk2

Available Support Functions

image_reference = get_image (<name>, [<keyname>])

set_image (Name => <name>, Path => <file_path> or Pixbuffer => <pix_buffer_object> or Image => <image_object> or Stock => [<stock_name>, <stock_size>])

string = get_value (<name>, “Justify” or “Wrap|Wrapped”)

set_value (<name>, Justify|Wrap|Wrapped => <new_value>)

hide_widget (<name>)

show_widget (<name>)

(width, height) = get_size (<name>)

set_size (<name>, <new_width>, <new_height>)

(x_pos, y_pos) = get_pos (<name>)

set_pos (<name>, <new_x>, <new_y>)

state = is_sensitive (<name>)

set_sensitive (<name>, <state>)

string = get_tooltip (<name>)

set_tooltip (<name>, <tooltip_text>)

sub get_image #( <name>, [<keyname>] )

Returns the image reference, the pixbuffer or the path.  If no key is given the current Gtk2::Image reference will be returned.  Else an object or path depending to the key.

Parameters

Returns

The image reference, the pixbuffer or the path.

Examples

# get the pixbuffer
my $pixbuff = $win->get_image('Image1', 'Pixbuf');
--------------------------------------
# get path of the picture
my $file_path = $win->get_image('Image1', 'Image');

sub set_image #(   Name  =  > <name>,   Path  =  > <file_path>, or  Pixbuffer  =  > <pix_buffer_object>, or  Image  =  > <image_object>, or  Stock  =  > [<stock_name>, <stock_size>] )

Sets a new image, stock icon, pixbuffer or file path.

Parameters

Returns

None.

Example

# set a new image by path
$win->set_image('Image1', Path => '/usr/share/icons/gnome/256x256/actions/appointment-new');

sub add_label #( Name  =  > <name>, Position  =  > [pos_x, pos_y], Title  =  > <title>, [Frame => <frame_name>],    [Font => [family, size, weight]],    [Widget => <name_of_linked_widget>],    [Justify => <justify>],    [Wrapped => <0/1>],    [Tooltip => <tooltip_text>],    [Sensitive => <sensitive>]    )

Creates a new GtkLabel widget.

The GtkLabel widget displays a small amount of text.  As the name implies, most labels are used to label another widget such as a GtkButton or a GtkMenuItem.

Internal Name Type

Label

Parameters

Returns

None.

Example

$win->add_label(Name => 'label1',
        Pos     => [10, 20],
        Title   => "A Label.\n"."A new line",
        Justify => 'left');

References

Gtk2-Perl, Gtk2

Available Support Functions

string = get_value (<name>, “Justify” or “Wrap|Wrapped”)

set_value (<name>, Justify|Wrap|Wrapped => <new_value>)

hide_widget (<name>)

show_widget (<name>)

(x_pos, y_pos) = get_pos (<name>)

set_pos (<name>, <new_x>, <new_y>)

state = is_sensitive (<name>)

set_sensitive (<name>, <state>)

string = get_title (<name>)

set_title (<name>, <text>)

string = get_tooltip (<name>)

set_tooltip (<name>, <tooltip_text>)

sub add_statusbar #( Name  =  > <name>, Position  =  > [pos_x, pos_y], [Size => [width, height]],    [Frame => <frame_name>],    [Timeout => <show_time>],    [Sensitive => <sensitive>]    )

Creates a new GtkStatusbar widget.

A GtkStatusbar is usually placed along the bottom of an application’s main GtkWindow.

It may provide a regular commentary of the application’s status, or may be used to simply output a message when the status changes.

Internal Name Type

Statusbar

Parameters

Returns

None.

Example

$win->add_statusbar(Name => 'sbar1',
        Pos     => [0, 0],
        Timeout => 2000);

Note

The main window supports a statusbar at the bottom, too.  See new_window for more details.

References

Gtk2-Perl, Gtk2

Available Support Functions

set_sb_text ([<name>], <text>)

remove_sb_text ([<name>], [<text>|<msg-id>])

clear_sb_stack (<name>)

string = get_value (<name>, “message” or “msgid” or “stackref” or “stackcount”)

set_value (<name>, message|msgid|stackref|stackcount => <new_value>)

hide_widget (<name>)

show_widget (<name>)

(x_pos, y_pos) = get_pos (<name>)

set_pos (<name>, <new_x>, <new_y>)

state = is_sensitive (<name>)

set_sensitive (<name>, <state>)

sub set_sb_text #( [<name>], <text> )

Sets/display a new status bar message.

Parameters

Returns

Message id.

Example

$win->set_sb_text('sbar1', $text);

sub remove_sb_text #( [<name>], [<text>|<msg-id>] )

Removes a message from the status bar.

Parameters

Returns

None.

Example

$win->remove_sb_text('sbar1', $msg_id[3]);

sub clear_sb_stack #( <name> )

Clears the message stack of a status bar.

Parameters

Returns

None.

Example

$win->clear_sb_stack();

sub add_button #( Name  =  > <name>, Position  =  > [pos_x, pos_y], Title  =  > <title>, [Frame => <frame_name>],    [Font => [family, size, weight]],    [Color => [<color>, <state>]],    [Size => [width, height]],    [Tooltip => <tooltip_text>],    [Function => <function_click>],    [Signal => <signal>],    [Sensitive => <sensitive>]    )

Creates a new GtkButton widget.

The GtkButton widget is generally used to attach a function to that is called when the button is pressed.

Internal Name Type

Button

Parameters

Returns

None.

Example

$win->add_button(Name => 'closeButton',
        Pos    => [10, 45],
        Title  => "_Close",
        Tip    => 'Closes the Application',
        Frame  => 'frame2');
$win->add_signal_handler('closeButton', 'clicked', sub{Gtk2->main_quit;});

References

Gtk2-Perl, Gtk2

Available Support Functions

hide_widget (<name>)

show_widget (<name>)

(x_pos, y_pos) = get_pos (<name>)

set_pos (<name>, <new_x>, <new_y>)

state = is_sensitive (<name>)

set_sensitive (<name>, <state>)

(width, height) = get_size (<name>)

set_size (<name>, <new_width>, <new_height>)

string = get_title (<name>)

set_title (<name>, <text>)

string = get_tooltip (<name>)

set_tooltip (<name>, <tooltip_text>)

sub add_check_button #( Name  =  > <name>, Position  =  > [pos_x, pos_y], Title  =  > <title>, [Frame => <frame_name>],    [Active => <0/1>],    [Font => [family, size, weight]],    [Color => [<color>, <state>]],    [Tooltip => <tooltip_text>],    [Function => <function_click>],    [Signal => <signal>],    [Sensitive => <sensitive>]    )

Creates a new GtkCheckButton widget.

A GtkCheckButton places a discrete toggle button next to a label.

Internal Name Type

CheckButton

Parameters

Returns

None.

Examples

$win->add_check_button( Name => 'checkEnabled' . $name_number,
        Pos     => [170, 10],
        Title   => 'Enabled',
        Tip     => "Enables or disables this output.",
        Active  => $enabled,
        Frame   => "NB_page" . $nr);
$win->add_signal_handler('checkEnabled' . $name_number, 'toggled', \&on_checkbox_enabled_toggled, $name);
--------------------------------------
$win->add_check_button(Name => 'checkButton1',
        Pos     => [80, 20],
        Title   => 'Check button',
        Tip     => 'This is a checkbox',
        Sig     => 'toggled',
        Func    => [\&DeleteFile, 'bla.txt']);

References

Gtk2-Perl, Gtk2

Available Support Functions

state = get_value (<name>, “active”)

set_value (<name>, Active => <0/1>)

state = is_active (<name>)

hide_widget (<name>)

show_widget (<name>)

(x_pos, y_pos) = get_pos (<name>)

set_pos (<name>, <new_x>, <new_y>)

state = is_sensitive (<name>)

set_sensitive (<name>, <state>)

(width, height) = get_size (<name>)

string = get_title (<name>)

set_title (<name>, <text>)

string = get_tooltip (<name>)

set_tooltip (<name>, <tooltip_text>)

sub add_radio_button #( Name  =  > <name>, Position  =  > [pos_x, pos_y], Title  =  > <title>, Group  =  > <button_group>, [Frame => <frame_name>],    [Active => <0/1>],    [Font => [family, size, weight]],    [Color => [<color>, <state>]],    [Tooltip => <tooltip_text>],    [Function => <function_click>],    [Signal => <signal>],    [Sensitive => <sensitive>]    )

Creates a new GtkRadioButton widget.

A single radio button performs the same basic function as a GtkCheckButton, as its position in the object hierarchy reflects.  It is only when multiple radio buttons are grouped together that they become a different user interface component in their own right.

Every radio button is a member of some group of radio buttons.  When one is selected, all other radio buttons in the same group are deselected.

Internal Name Type

RadioButton

Parameters

Returns

None.

Example

# Group of 3 Radio Buttons
$win->add_radio_button(Name => 'radio1', Pos => [10, 90],
        Title   => "First", Group => "radio1",
        Active  => 1, Tip => "1st radio button",
        Frame   => 'frame1');
$win->add_radio_button(Name => 'radio2', Pos => [10, 110],
        Title   => "_Second", Group => "radio1",
        Tip     => "2nd radio button", Frame => 'frame1');
$win->add_radio_button(Name => 'radio3', Pos => [10, 130],
        Title   => "Third", Group => "radio1",
        Tip     => "3rd radio button", Frame => 'frame1');

References

Gtk2-Perl, Gtk2

Available Support Functions

value = get_value (<name>, “active” or “Group” or “Groupname|Gname”)

set_value (<name>, Active => <0/1>)

state = is_active (<name>)

hide_widget (<name>)

show_widget (<name>)

(x_pos, y_pos) = get_pos (<name>)

set_pos (<name>, <new_x>, <new_y>)

state = is_sensitive (<name>)

set_sensitive (<name>, <state>)

(width, height) = get_size (<name>)

string = get_title (<name>)

set_title (<name>, <text>)

string = get_tooltip (<name>)

set_tooltip (<name>, <tooltip_text>)

sub add_link_button #( Name  =  > <name>, Position  =  > [pos_x, pos_y], Title  =  > <title>, Uri  =  > <uri-text>, [Frame => <frame_name>],    [Font => [family, size, weight]],    [Color => [<color>, <state>]],    [Size => [width, height]],    [Function => <function_click>],    [Signal => <signal>],    [Sensitive => <sensitive>]    )

Creates a new GtkLinkButton widget.

A GtkLinkButton is a GtkButton with a hyperlink, similar to the one used by web browsers, which triggers an action when clicked.  It is useful to show quick links to resources.

Internal Name Type

LinkButton

Parameters

Returns

None.

Example

$win->add_link_button(Name => 'linkButton',
        Pos     => [10, 45],
        Title   => "To SimpleGtk2 site",
        Uri     => 'https://github.com/ThomasFunk/SimpleGtk2',
        Frame   => 'frame2');
$win->add_signal_handler('linkButton', 'clicked',
                        [\&openPage, $win->get_value('linkButton', 'Uri')]);

References

Gtk2-Perl, Gtk2

Available Support Functions

state = get_value (<name>, “Uri”)

set_value (<name>, Uri => <uri-text>)

hide_widget (<name>)

show_widget (<name>)

(x_pos, y_pos) = get_pos (<name>)

set_pos (<name>, <new_x>, <new_y>)

state = is_sensitive (<name>)

set_sensitive (<name>, <state>)

(width, height) = get_size (<name>)

set_size (<name>, <new_width>, <new_height>)

string = get_title (<name>)

set_title (<name>, <text>)

sub add_entry #( Name  =  > <name>, Position  =  > [pos_x, pos_y], Size  =  > [width, height], [Title => <title>],    [Frame => <frame_name>],    [Font => [family, size, weight]],    [Align => <xalign>],    [Tooltip => <tooltip_text>],    [Function => <function_click>],    [Signal => <signal>],    [Sensitive => <sensitive>]    )

Creates a new GtkEntry widget.

The GtkEntry widget is a single line text entry widget.  A fairly large set of key bindings are supported by default.  If the entered text is longer than the allocation of the widget, the widget will scroll so that the cursor position is visible.

Internal Name Type

Entry

Parameters

Returns

None.

Example

$win->add_entry(Name => 'entry1',
        Pos     => [200, 20],
        Size    => [100, 20],
        Title   => 'A text entry field',
        Align   => 'right');

References

Gtk2-Perl, Gtk2

Available Support Functions

string = get_value (<name>, “Align”)

set_value (<name>, Align => “<xalign>”)

hide_widget (<name>)

show_widget (<name>)

(x_pos, y_pos) = get_pos (<name>)

set_pos (<name>, <new_x>, <new_y>)

state = is_sensitive (<name>)

set_sensitive (<name>, <state>)

string = get_title (<name>)

set_title (<name>, <text>)

string = get_tooltip (<name>)

set_tooltip (<name>, <tooltip_text>)

sub add_slider #( Name  =  > <name>, Position  =  > [pos_x, pos_y], Orientation  =  > <orientation>, [Size => [width, height]],    [Start => <start_value>],    Minimum  =  > <min_value>, Maximum  =  > <max_value>, Step  =  > <step_in/decrease>, [DrawValue => <1/0>],    [ValuePosition => <value_position>],    [Digits => <used_digits>],    [Frame => <frame_name>],    [Tooltip => <tooltip_text>],    [Function => <function_click>],    [Signal => <signal>],    [Sensitive => <sensitive>]    )

Creates a new GtkSlider widget.

The GtkSlider (GtkHScale/GtkVScale) widget is used to allow the user to select a value using a horizontal or vertical slider.  The position to show the current value and/or the number of decimal places can be shown, too.

Internal Name Type

Slider

Parameters

Returns

None.

Example

$win->add_slider(Name => 'hslider',
        Pos     => [10, 220],
        Size    => [200, -1],
        Orient  => 'horizontal',
        Start   => 5,
        Min     => 0,
        Max     => 100,
        Step    => 0.1,
        Digits  => 1,
        Tip     => 'Round and round we go',
        Frame   => 'frame2');

References

Gtk2-Perl HScale, Gtk2-Perl VScale, Gtk2 HScale, Gtk2 VScale

Available Support Functions

string = get_value (<name>, “Active” or “Min|Minimum” or “Max|Maximum” or “Step” or “DrawValue” or “ValuePos|ValuePosition” or “Digits”)

set_value (<name>, Start => <start_value> or Active => <active_value> or Min => <min_value> or Max => <max_value> or Step => <step_in/decrease> or DrawValue => <1/0> or ValuePos|ValuePosition => “<value_position>” or Digits => <used_digits>)

hide_widget (<name>)

show_widget (<name>)

(x_pos, y_pos) = get_pos (<name>)

set_pos (<name>, <new_x>, <new_y>)

state = is_sensitive (<name>)

set_sensitive (<name>, <state>)

string = get_tooltip (<name>)

set_tooltip (<name>, <tooltip_text>)

sub add_spin_button #( Name  =  > <name>, Position  =  > [pos_x, pos_y], [Size => [width, height]],    [Start => <start_value>],    Minimum  =  > <min_value>, Maximum  =  > <max_value>, Step  =  > <step_in/decrease>, Page  =  > <page_in/decrease>, [Snap => <snap_to_tick>],    [Align => <xalign>],    [Rate => <from 0.0 to 1.0>],    [Digits => <used_digits>],    [Frame => <frame_name>],    [Tooltip => <tooltip_text>],    [Function => <function_click>],    [Signal => <signal>],    [Sensitive => <sensitive>]    )

Creates a new GtkSpinButton widget.

A GtkSpinButton is an ideal way to allow the user to set the value of some attributes.

Rather than having to directly type a number into a GtkEntry, GtkSpinButton allows the user to click on one of two arrows to increment or decrement the displayed value.

A value can still be typed in, with the bonus that it can be checked to ensure it is in a given range.

Internal Name Type

SpinButton

Parameters

Returns

None.

Example

$win->add_spin_button(Name => 'spin1',
        Pos     => [10, 60],
        Start   => 5,
        Min     => 0,
        Max     => 10,
        Step    => 1,
        Tip     => 'Thats a spin button',
        Align   => 'right',
        Frame   => 'frame1');

References

Gtk2-Perl, Gtk2

Available Support Functions

string = get_value (<name>, “Active” or “Align” or “Min|Minimum” or “Max|Maximum” or “Step” or “Snap” or “Rate|Climbrate” or “Digits”)

set_value (<name>, Min => <min_value> or Max => <max_value> or Step => <step_in/decrease> or Page => <page_in/decrease> or Snap => <snap_to_tick> or Align => <xalign> or Rate => <from 0.0 to 1.0> or Digits => <used_digits>)

hide_widget (<name>)

show_widget (<name>)

(x_pos, y_pos) = get_pos (<name>)

set_pos (<name>, <new_x>, <new_y>)

state = is_sensitive (<name>)

set_sensitive (<name>, <state>)

string = get_tooltip (<name>)

set_tooltip (<name>, <tooltip_text>)

sub add_text_view #(   Name  =  > <name>,   Position  =  > [pos_x, pos_y],   Size  =  > [width, height],   Path  =  > <file_path>, or  Textbuffer  =  > <text_buffer_object>, or  Text  =  > <text_string>,   [LeftMargin => <in_pixel>],      [RightMargin => <in_pixel>],      [Wrapped => <wrap_mode>],      [Justify => <justification>],      [Frame => <frame_name>],      [Tooltip => <tooltip_text>],      [Function => <function_click>],      [Signal => <signal>],      [Sensitive => <sensitive>]    )

Creates a new GtkTextView widget.

A GtkTextView is a widget which can display a GtkTextBuffer, which represents the text being edited or viewed.

Internal Name Type

TextView

Parameters

Returns

None.

Example

# with file
$win->add_text_view(Name => 'tview1',
        Pos         => [40, 260],
        Size        => [200, 120],
        Tip         => 'A text',
        Frame       => 'frame2',
        Path        => './testem.txt',
        Wrapped     => 'char',
        LeftMargin  => 10,
        RightMargin => 10);

References

Gtk2-Perl, Gtk2

Available Support Functions

value = get_textview (<name>, “Path” or “Textview” or “Textbuf|Textbuffer”)

set_textview (<name>, Path => <file_path> or Textbuf|Textbuffer => <text_buffer_object> or Text => <text_string>)

string = get_value (<name>, “LeftMargin” or “RightMargin” or “Wrap|Wrapped” or “Justify”)

set_value (<name>, LeftMargin => <in_pixel> or RightMargin => <in_pixel> or Wrap|Wrapped => <wrap_mode> or Justify => <justification>)

hide_widget (<name>)

show_widget (<name>)

(x_pos, y_pos) = get_pos (<name>)

set_pos (<name>, <new_x>, <new_y>)

(width, height) = get_size (<name>)

set_size (<name>, <new_width>, <new_height>)

state = is_sensitive (<name>)

set_sensitive (<name>, <state>)

string = get_tooltip (<name>)

set_tooltip (<name>, <tooltip_text>)

sub get_textview #( <name>, [<keyname>] )

Returns the textview reference, its’ textbuffer or the file path.  If no <keyname> is given it returns the textview reference only.

Parameters

Returns

The textview reference, its’ textbuffer or the file path.

sub set_textview #(   Name  =  > <name>,   Path  =  > <file_path>, or  Textbuffer  =  > <text_buffer_object>, or  Text  =  > <text_string> )

Sets a new text, textbuffer or file path.

Parameters

Returns

None.

sub add_treeview #( Name  =  > <name>, Type  =  > <List|Tree>, Position  =  > [pos_x, pos_y], Size  =  > [width, height], Headers  =  > [<Array_of_column_pairs>], [Data => [<Array_of_arrays>]],    [Treeview => <Gtk2::TreeView>],    [Mode => <selection mode>],    [Frame => <frame_name>],    [Function => <function_click>],    [Signal => <signal>],    [Sensitive => <sensitive>]    )

Creates a new GtkTreeView widget.

A Widget that displays List and Tree objects implemented by the GtkTreeModel interface.

Internal Name Type

List or Tree

Parameters

Possible column types

Returns

None.

Example

# list
$win->add_treeview(Name => 'slist',
        Type    => 'List',
        Pos     => [10, 10],
        Size    => [150, 150],
        Headers => ['No'    => 'int',
                    'Text1' => 'text',
                    'Text2' => 'text'],
        Data    => [[1, 'bla', 'lol'],
                    [2, 'snore', 'moe'],
                    [3, 'yalla', 'meh']]);
$window->add_signal_handler('slist', 'cursor-changed', \&show_index);
--------------------------------------
# tree
$win->add_treeview(Name => 'stree',
        Type    => 'Tree',
        Pos     => [10, 10],
        Size    => [350, 320],
        Headers => $headers,
        Data    => \@tree,
        Sens    => 1);

References

Gtk2-Perl, Gtk2

Available Support Functions

reference = get_treeview (<name>, “List” or “Tree”)

set_value (<name>, mode => <selection_mode> or sortable => <0/1> or reordable => <0/1>)

hide_widget (<name>)

show_widget (<name>)

(x_pos, y_pos) = get_pos (<name>)

set_pos (<name>, <new_x>, <new_y>)

(width, height) = get_size (<name>)

set_size (<name>, <new_width>, <new_height>)

state = is_sensitive (<name>)

set_sensitive (<name>, <state>)

List only Support Functions

value = get_value (<name>, “Editable” or “Path” or “Cell”)

set_value (<name>, select => <row|[row_list]> or unselect => <row|[row_list]>)

Tree only Support Functions

value = get_value (<name>, “Iter” or “Path” or “Row”)

set_value (<name>, iter => <iter> or path => <path_object> or row => [row_values])

sub get_treeview #( <name>, [<keyname>] )

Returns the treeview reference.

Parameters

Returns

The textview reference, its’ textbuffer or the file path.

sub add_combo_box #( Name  =  > <name>, Position  =  > [pos_x, pos_y], Data  =  > [Array_of_values>], [Start => <start_value>],    [Size => [width, height]],    [Frame => <frame_name>],    [Tooltip => <tooltip_text>],    [Function => <function_click>],    [Signal => <signal>],    [Sensitive => <sensitive>]    )

Creates a new GtkComboBox widget.

A GtkComboBox is a widget that allows the user to choose from a list of valid choices.  The GtkComboBox displays the selected choice.  When activated, the GtkComboBox displays a popup which allows the user to make a new choice.

Internal Name Type

ComboBox

Parameters

Returns

None.

Example

$win->add_combo_box(Name => 'combo1',
        Pos     => [100, 60],
        Data    => ['one', 'two', 'three', 'four'],
        Start   => 1,
        Tip     => 'Jup',
        Frame   => 'frame1');

References

Gtk2-Perl, Gtk2

Available Support Functions

state = is_active (<name>, <value|string>)

string = get_value (<name>, “Active” or “Data” or “Columns”)

set_value (<name>, Active => “<active_index>” or Data => [<Array_of_values>] or Columns => <wrap_list_to_x_columns>)

hide_widget (<name>)

show_widget (<name>)

(x_pos, y_pos) = get_pos (<name>)

set_pos (<name>, <new_x>, <new_y>)

state = is_sensitive (<name>)

set_sensitive (<name>, <state>)

string = get_title (<name>)

set_title (<name>, <text>)

string = get_tooltip (<name>)

set_tooltip (<name>, <tooltip_text>)

sub add_menu_bar #( Name  =  > <name>, Position  =  > [pos_x, pos_y], [Size => [width, height]]    )

Creates a new GtkMenuBar widget.

The GtkMenuBar is a subclass of GtkMenuShell which contains one to many GtkMenuItem.  The result is a standard menu bar which can hold many menu items.

Internal Name Type

MenuBar

Parameters

Returns

None.

Example

$win->add_menu_bar(Name => 'menubar1', Pos => [0,0]);

References

Gtk2-Perl, Gtk2

Available Support Functions

hide_widget (<name>)

show_widget (<name>)

(width, height) = get_size (<name>)

set_size (<name>, <new_width>, <new_height>)

(x_pos, y_pos) = get_pos (<name>)

set_pos (<name>, <new_x>, <new_y>)

sub add_menu #( Name  =  > <name>, Menubar  =  > <menu_bar>, Title  =  > <title>, [Justify => <justification>],    [Sensitive => <sensitive>]    )

Creates a new GtkMenu widget.

A GtkMenu is a GtkMenuShell that implements a drop down menu consisting of a list of GtkMenuItem objects which can be navigated and activated by the user to perform application functions.

A GtkMenu is most commonly dropped down by activating a GtkMenuItem in a GtkMenuBar or popped up by activating a GtkMenuItem in another GtkMenu.

Internal Name Type

Menu

Parameters

Returns

None.

Example

# menu Edit
$win->add_menu(Name => 'menu_edit',
        Title   => '_Edit',
        Menubar => 'menubar1');

References

Gtk2-Perl, Gtk2

Available Support Functions

string = get_value (<name>, “Justify”)

set_value (Justify => <justification>)

state = is_sensitive (<name>)

set_sensitive (<name>, <state>)

(width, height) = get_size (<name>)

string = get_title (<name>)

set_title (<name>, <text>)

sub add_menu_item #( Name  =  > <name>, Menu  =  > <menu_name>, [Type => <type>],    [Title => <title>],    [Tip|Tooltip => <tooltip_text>],    [Icon => <path|stock|name>],    Group  =  > <group_name>, Active  =  > <0/1>, [Func|Function => <function>],    [Sig|Signal => <signal>],    [Sens|Sensitive => <sensitive>]    )

Creates a new GtkMenuItem widget.

The GtkMenuItem widget and the derived widgets are the only valid childs for menus.

Their function is to correctly handle highlighting, alignment, events and submenus.

Internal Name Types

MenuItem, TearOffMenuItem, SeparatorMenuItem, RadioMenuItem or CheckMenuItem

Parameters

Returns

None.

Example

# menu tearoff
$win->add_menu_item(Name => 'menu_item_toff',
        Type    => 'tearoff',
        Menu    => 'menu_edit',
        Tip     => 'This is a tearoff');

# menu item Save
$win->add_menu_item(Name => 'menu_item_save',
        Icon    => 'gtk-save',
        Menu    => 'menu_edit',
        Tip     => 'This is the Save entry');

# separator
$win->add_menu_item(Name => 'menu_item_sep1',
        Type    => 'separator',
        Menu    => 'menu_edit');

# icon
$win->add_menu_item(Name => 'menu_item_icon',
        Title   => 'Burger',
        Icon    => './1.png',
        Menu    => 'menu_edit',
        Tip     => 'This is a Burger');

# check menu
$win->add_menu_item(Name => 'menu_item_check',
        Type    => 'check',
        Title   => 'Check em',
        Menu    => 'menu_edit',
        Tip     => 'This is a Check menu',
        Active  => 1);

# radio menu
$win->add_menu_item(Name => 'menu_item_radio1',
        Type    => 'radio',
        Title   => 'First',
        Menu    => 'menu_edit',
        Tip     => 'First radio',
        Group   => 'Yeah',
        Active  => 1);
$win->add_menu_item(Name => 'menu_item_radio2',
        Type    => 'radio',
        Title   => 'Second',
        Menu    => 'menu_edit',
        Tip     => 'Second radio',
        Group   => 'Yeah');
$win->add_menu_item(Name => 'menu_item_radio3',
        Type    => 'radio',
        Title   => '_Third',
        Menu    => 'menu_edit',
        Tip     => 'Third radio',
        Group   => 'Yeah');

References

Gtk2-Perl MenuItem, RadioMenuItem, CheckMenuItem, SeparatorMenuItem, TearoffMenuItem

Gtk2 MenuItem, RadioMenuItem, CheckMenuItem, SeparatorMenuItem, TearoffMenuItem

Available Support Functions

string = get_value (<name>, “IconPath” or “StockIcon” or “IconName” or “Icon” or “Active” or “Group” or “Groupname|Gname”)

set_value (Icon => <path|stock|name> or Active => <0/1>)

state = is_sensitive (<name>)

set_sensitive (<name>, <state>)

(width, height) = get_size (<name>)

string = get_title (<name>)

set_title (<name>, <text>)

string = get_tooltip (<name>)

set_tooltip (<name>, <tooltip_text>)

sub add_filechooser_button #(     Name  =  > <name>,     Position  =  > [pos_x, pos_y],     Title  =  > <title>,     Action  =  > <open_mode>,     [Frame => <frame_name>],        [File => <file_path>],        [Filter => <pattern|mimetype> | [<name>, <pattern|mimetype>]],        [Folder => <directory>],        [Size => [width, height]],        [Function => <function_click>],        [Signal => <signal>],        [Sensitive => <sensitive>]    )

Creates a new GtkFileChooserButton widget.

The GtkFileChooserButton is a widget that lets the user select a file or folder.  It implements the GtkFileChooser interface.

Internal Name Type

FileChooserButton

Parameters

Returns

None.

Example

# show only images. Start folder is ~/Pictures
$win->add_filechooser_button(Name => 'FButton2',
        Pos     => [40, 70],
        Size    => [120, 40],
        Title   => "Select an image",
        Action  => 'open',
        Folder  => "$ENV{HOME}/Pictures",
        Filter  => ['Images', '*.png']);

References

Gtk2-Perl, Gtk2

Available Support Functions

string = get_value (<name>, )

set_value ()

hide_widget (<name>)

show_widget (<name>)

(x_pos, y_pos) = get_pos (<name>)

set_pos (<name>, <new_x>, <new_y>)

state = is_sensitive (<name>)

set_sensitive (<name>, <state>)

(width, height) = get_size (<name>)

set_size (<name>, <new_width>, <new_height>)

string = get_title (<name>)

set_title (<name>, <text>)

string = get_tooltip (<name>)

set_tooltip (<name>, <tooltip_text>)

sub add_filechooser_dialog #(     Name  =  > <name>,     Action  =  > <open_mode>,     [Title => <title>],        [FName => <file_name>],        [Filter => <pattern|mimetype> | [<name>, <pattern|mimetype>]],        [Folder => <directory>],        [RFunc => <response_function>]    )

Creates a new GtkFileChooserDialog widget.

GtkFileChooserDialog is a dialog box suitable for use with “File/Open” or “File/Save as” commands.

Internal Name Type

FileChooserDialog

Parameters

Returns

The chosen path/folder or 0.

Example

sub response {
    my $resp = shift;
    print "response: " . $resp . "\n";
}

my $win = SimpleGtk2->new_window(Name => 'mainWindow',
                        Title   => 'File Chooser dialog',
                        Size    => [200, 100]);

$win->add_button( Name => 'tryButton',
        Pos     => [20, 15],
        Size    => [80, 25],
        Title   => "Try");
$win->add_signal_handler('tryButton', 'clicked', sub{$win->show_filechooser_dialog('fchooserdiag');});

$win->add_filechooser_dialog(Name => 'fchooserdiag',
        Title   => 'Open a file',
        Action  => 'open',
        RFunc   => \&response);

References

Gtk2-Perl, Gtk2

Available Support Functions

response = show_filechooser_dialog (<name>, <filename|file|folder>)

string = get_value (<name>, )

set_value ()

string = get_title (<name>)

set_title (<name>, <text>)

sub show_filechooser_dialog #(     <name>,     <filename|file|folder> ), or (<action_type>, <filename|file|folder>, <pattern|mimetype>, or [<name>, <pattern|mimetype>])

Shows a simple or normal filechooser dialog.

The normal filechooser dialog needs a filechooser dialog object created with add_filechooser_dialog.

The simple filechooser dialog doesn’t need this object.

Parameters for normal

Parameters for simple

Returns

The chosen path/folder or 0.

Examples

# A simple filechooser dialog

sub response {
    my $win = shift;
    my $resp = $win->show_filechooser_dialog('create-folder');
    print "response: " . $resp . "\n";
}

$win->add_button( Name => 'tryButton',
        Pos     => [70, 45],
        Size    => [80, 25],
        Tip     => "Shows a simple filechooser dialog.",
        Title   => "Simple");
$win->add_signal_handler('tryButton', 'clicked', sub{&response($win);});
--------------------------------------
# A normal filechooser dialog

sub response {
    my $resp = shift;
    print "response: " . $resp . "\n";
}

$win->add_button( Name => 'tryButton',
        Pos     => [70, 15],
        Size    => [80, 25],
        Tip     => "Shows a normal filechooser dialog.",
        Title   => "Normal");
$win->add_signal_handler('tryButton', 'clicked', sub{$win->show_filechooser_dialog('fchooserdiag');});

$win->add_filechooser_dialog(Name => 'fchooserdiag',
        Title   => 'Open a file',
        Action  => 'open',
        RFunc => \&response);

sub add_font_button #( Name  =  > <name>, Position  =  > [pos_x, pos_y], Title  =  > <title>, Action  =  > <open_mode>, [Frame => <frame_name>],    [Font => [family, size, weight]],    [Size => [width, height]],    [Function => <function_click>],    [Signal => <signal>],    [Sensitive => <sensitive>]    )

Creates a new GtkFontButton widget.

The GtkFontButton is a button which displays the currently selected font an allows to open a font selection dialog to change the font.

Internal Name Type

FontButton

Parameters

Returns

None.

Example

$window->add_font_button(Name => 'font_button',
            Pos     => [20, 40],
            Font    => ["Arial", 12]);

References

Gtk2-Perl, Gtk2

Available Support Functions

string = get_value (<name>, “Uri”)

set_value (<name>, Uri => <uri-text>)

hide_widget (<name>)

show_widget (<name>)

(x_pos, y_pos) = get_pos (<name>)

set_pos (<name>, <new_x>, <new_y>)

state = is_sensitive (<name>)

set_sensitive (<name>, <state>)

(width, height) = get_size (<name>)

set_size (<name>, <new_width>, <new_height>)

string = get_title (<name>)

set_title (<name>, <text>)

string = get_tooltip (<name>)

set_tooltip (<name>, <tooltip_text>)

sub add_fontselection_dialog #( Name  =  > <name>, Title  =  > <title>, [Font => [family, size, weight]],    [Preview => <preview text>],    [RFunc => <response_function>]    )

Creates a new GtkFontSelectionDialog widget.

The GtkFontSelectionDialog widget is a dialog box for selecting a font.

Internal Name Type

FontSelectionDialog

Parameters

Returns

The font string: “fontname weight size” or 0.

Example

References

Gtk2-Perl, Gtk2

Available Support Functions

response = <show_font_dialog> (<name>)

string = get_value (<name>, “previewstring” or “fontstring” or “fontfamily” or “fontsize” or “fontweight”)

set_value (<name>, previewstring => <preview_text> or fontstring => <font_string> or fontfamily => <font_family> or fontsize => <font_size> or fontweight => <font_weight>)

string = get_title (<name>)

set_title (<name>, <text>)

sub show_fontselection_dialog #( <name> ) or (<family>, <size>, <weight>)

Shows simple or normal fontselection dialog.

The normal fontselection dialog needs a fontselection dialog object created with add_fontselection_dialog.

The simple fontselection dialog doesn’t need this object.

Parameters for normal

Parameters for simple

Returns

The font string: “fontname weight size” or 0.

Examples

# A simple fontselection dialog
--------------------------------------
# A normal fontselection dialog

sub add_notebook #( Name  =  > <name> , Pos|Position  =  > [pos_x, pos_y], Size  =  > [width, height], [Tabs => <position>],    [Scroll|Scrollable => <0/1>],    [Popup => <0/1>],    [Frame => <frame_name>],    [Sens|Sensitive => <sensitive>]    )

Creates a new GtkNotebook widget.

The GtkNotebook widget is a GtkContainer whose children are pages that can be switched between using tab labels along one edge.

There are many configuration options for GtkNotebook.  Among other things, you can choose on which edge the tabs appear (whether, if there are too many tabs to fit the notebook should be made bigger or scrolling arrows added, and whether there will be a popup menu allowing the users to switch pages.

Internal Name Type

Notebook

Parameters

Returns

None.

Example

$win->add_notebook(Name => 'NB1',
        Pos     => [10, 10],
        Size    => [200, 200],
        Tabs    => 'top',
        Popup   => 1);

References

Gtk2-Perl, Gtk2

Available Support Functions

add_nb_page (Name => <name>, Notebook => <notebook_name>, [Font => [family, size, weight]], [Color => [<color>, <state>]], [Pos_n|PositionNumber => <number>], [Tip|Tooltip => <tooltip_text>], [Sens|Sensitive => <sensitive>])

remove_nb_page (<nb_name>, <title|number>)

string = get_value (<name>, “Current|CurrentPage” or “Pages” or “Popup” or “No2Name|Number2Name” or “Scroll|Scrollable” or “Tabs”)

set_value (<name>, Current|CurrentPage => <page_number|next|prev> or Popup => <0/1> or Scroll|Scrollable => <0/1> or Tabs => <edges>)

hide_widget (<name>)

show_widget (<name>)

(x_pos, y_pos) = get_pos (<name>)

set_pos (<name>, <new_x>, <new_y>)

state = is_sensitive (<name>)

set_sensitive (<name>, <state>)

(width, height) = get_size (<name>)

set_size (<name>, <new_width>, <new_height>)

sub add_nb_page #( Name  =  > <name>, Notebook  =  > <notebook_name>, [Font => [family, size, weight]],    [Color => [<color>, <state>]],    [Pos_n|PositionNumber => <number>],    [Tip|Tooltip => <tooltip_text>],    [Sens|Sensitive => <sensitive>]    )

Creates a new GtkNotebook page.

Appends a new page to a notebook.  The index starting from 0.

Internal Name Type

NotebookPage

Parameters

Returns

None.

Example

$win->add_nb_page(Name => "NB_page1",
        Pos_n   => 0,
        Title   => "Page 1",
        Notebook => 'NB1',
        Tip     => "This is the first page");

References

Gtk2-Perl, Gtk2

Available Support Functions

string = get_value (<name>, “PageNumber” or “Notebook”)

set_value (<name>, Reorder => <0/1>)

state = is_sensitive (<name>)

set_sensitive (<name>, <state>)

string = get_title (<name>)

set_title (<name>, <text>)

string = get_tooltip (<name>)

set_tooltip (<name>, <tooltip_text>)

sub remove_nb_page #( <nb_name>, <title|number> )

Removes a notebook page from a notebook.

Parameters

Returns

None.

sub add_frame #( Name  =  > <name>, Position  =  > [pos_x, pos_y], [Title => <title>],    [Frame => <frame_name>],    [Font => [family, size, weight]],    [Tooltip => <tooltip_text>],    [Sensitive => <sensitive>]    )

Creates a new GtkFrame widget.

The frame widget is a Bin that surrounds its child with a decorative frame and an optional label.  If present, the label is drawn in a gap in the top side of the frame.

Internal Name Type

Frame

Parameters

Returns

None.

Example

$win->add_frame(Name => 'frame1',
                Pos => [5, 5],
                Size => [390, 190],
                Title => ' A Frame around ');

References

Gtk2-Perl, Gtk2

Available Support Functions

hide_widget (<name>)

show_widget (<name>)

(x_pos, y_pos) = get_pos (<name>)

set_pos (<name>, <new_x>, <new_y>)

state = is_sensitive (<name>)

set_sensitive (<name>, <state>)

string = get_title (<name>)

set_title (<name>, <text>)

string = get_tooltip (<name>)

set_tooltip (<name>, <tooltip_text>)

sub add_separator #( Name  =  > <name>, Orient|Orientation  =  > <orientation>, Pos|Position  =  > [pos_x, pos_y], [Size => [width, height]],    [Frame => <frame_name>],    [Sens|Sensitive => <sensitive>]    )

Creates a new GtkSeparator widget.

The GtkSeparator (GtkHSeparator/GtkVSeparator) widget is a horizontal or vertical separator, used to group the widgets within a window.  It displays a horizontal/vertical line with a shadow to make it appear sunken into the interface.

Note: The GtkSeparator widget is not used as a separator within menus.  To create a separator in a menu create an empty GtkSeparatorMenuItem in add_menu_item.

Internal Name Type

Separator

Parameters

Returns

None.

Example

References

Gtk2-Perl GtkHSeparator, Gtk2-Perl GtkVSeparator, Gtk2 GtkHSeparator Gtk2 GtkVSeparator

Available Support Functions

hide_widget (<name>)

show_widget (<name>)

(x_pos, y_pos) = get_pos (<name>)

set_pos (<name>, <new_x>, <new_y>)

state = is_sensitive (<name>)

set_sensitive (<name>, <state>)

sub add_scrollbar #( Name  =  > <name>, Position  =  > [pos_x, pos_y], Orientation  =  > <orientation>, [Size => [width, height]],    [Start => <start_value>],    Minimum  =  > <min_value>, Maximum  =  > <max_value>, Step  =  > <step_value>, [Digits => <used_digits>],    [Frame => <frame_name>],    [Tooltip => <tooltip_text>],    [Function => <function_click>],    [Signal => <signal>],    [Sensitive => <sensitive>]    )

Creates a new GtkScrollBar widget.

The GtkScrollBar widget is a widget arranged horizontally or vertically creating a scrollbar.

Internal Name Type

Scrollbar

Parameters

Returns

None.

Examples

# Horizontal
$win->add_scrollbar(Name => 'hscroll',
        Pos     => [10, 220],
        Size    => [200, -1],
        Orient  => 'horizontal',
        Start   => 5,
        Min     => 0,
        Max     => 100,
        Step    => 1,
        Digits  => 1,
        Tip     => 'From left to right',
        Frame   => 'frame2');

# Vertical
$win->add_scrollbar(Name => 'vscroll',
        Pos     => [320, 30],
        Size    => [-1, 150],
        Orient  => 'vertical',
        Start   => 1.5,
        Min     => 0,
        Max     => 100,
        Step    => 1,
        Digits  => 1,
        Tip     => 'Up and down',
        Frame   => 'frame1');

References

Gtk2-Perl HScrollbar, Gtk2-Perl VScrollbar, Gtk2 HScrollbar, Gtk2 VScrollbar

Available Support Functions

string = get_value (<name>, “Active” or “Min|Minimum” or “Max|Maximum” or “Step” or “Digits”)

set_value (<name>, Start => <start_value> or Active => <active_value> or Min => <min_value> or Max => <max_value> or Step => <step_in/decrease> or Digits => <used_digits>)

hide_widget (<name>)

show_widget (<name>)

(x_pos, y_pos) = get_pos (<name>)

set_pos (<name>, <new_x>, <new_y>)

state = is_sensitive (<name>)

set_sensitive (<name>, <state>)

string = get_tooltip (<name>)

set_tooltip (<name>, <tooltip_text>)

sub add_drawing_area #( Name  =  > <name>, Pos  =  > [pos_x, pos_y], Size  =  > [width, height], [Frame => <frame_name>],    [Function => <function_click>],    [Signal => <signal>],    [Sensitive => <sensitive>]    )

Creates a new GtkImage widget.

The GtkDrawingArea widget is used for creating custom user interface elements.  It’s essentially a blank widget.  After creating a drawing area, the application may want to connect to:

• Mouse and button press signals to respond to input from the user.  Use add_signal_handler for that.
• The “realize” signal to take any necessary actions when the widget is instantiated on a particular display.  (Create GDK resources in response to this signal.)
• The “configure_event” signal to take any necessary actions when the widget changes size.
• The “expose_event” signal to handle redrawing the contents of the widget.

Internal Name Type

DrawingArea

Parameters

Returns

None.

Example

$win->add_drawing_area(Name => 'drawArea',
        Pos     => [10, 10],
        Size    => [$draw_surface[0], $draw_surface[1]]);
$win->add_signal_handler('drawArea', 'button_press_event', \&button_press_event);
$win->add_signal_handler('drawArea', 'button_release_event', \&button_release_event);
$win->add_signal_handler('drawArea', 'motion_notify_event', \&motion_notify_event);

References

Gtk2-Perl, Gtk2

Available Support Functions

initial_draw (<drawing_area_name>, <function>, [<data>])

string = get_value (<name>, “” or “”)

set_value (<name>, => <new_value>)

hide_widget (<name>)

show_widget (<name>)

(width, height) = get_size (<name>)

set_size (<name>, <new_width>, <new_height>)

(x_pos, y_pos) = get_pos (<name>)

set_pos (<name>, <new_x>, <new_y>)

state = is_sensitive (<name>)

set_sensitive (<name>, <state>)

sub initial_draw #( <drawing_area_name>, <function>, [<data>] )

Base function to draw with the drawing area.

This base function is needed to draw in SimpleGtk2 because drawings need to initialize before Gtk2->main() is called.

Parameters

Returns

None.

Example

$win->initial_draw('drawArea', sub{&draw_rect($win->get_object('drawArea'), \@{$rects{$rect}[0]},$rects{$rect}[1]);});

sub add_tooltip #( <name>, <text> )

Add a tooltip to a widget.

The tooltip text should be written in double quotes to support control characters.  Longer text can break with ‘\’ at the end for better overview.

Restriction

Not available for the following widgets: GtkMenu, GtkMenuBar, GtkFileChooserDialog, GtkFontSelectionDialog, GtkMessageDialog, GtkTreeView, GtkStatusbar, GtkTextView, GtkSeparator and GtkNotebook.

Parameters

Returns

None.

Examples

$win->add_tooltip('image1', "This is a tooltip");
--------------------------------------
$win->add_tooltip('image1', "This is a longer tooltip text \
                             with a visual break to handle \
                             it nicer in the code.\nAlso line \
                             breaks can be added, too.");

sub get_tooltip #( <name> )

Returns the current tooltip text of a widget.

Restriction

Not available for the following widgets: GtkMenu, GtkMenuBar, GtkFileChooserDialog, GtkFontSelectionDialog, GtkMessageDialog, GtkTreeView, GtkStatusbar, GtkTextView, GtkSeparator and GtkNotebook.

Parameters

Returns

Tooltip text or undef.

Example

my $text = $win->get_tooltip('image1');

sub set_tooltip #( <name>, <tooltip_text> )

Sets a new tooltip text on a widget.

If no tooltip exists function will add it.

Restriction

Not available for the following widgets: GtkMenu, GtkMenuBar, GtkFileChooserDialog, GtkFontSelectionDialog, GtkMessageDialog, GtkTreeView, GtkStatusbar, GtkTextView, GtkSeparator and GtkNotebook.

Parameters

Returns

None.

Example

my $text = $win->set_tooltip('image1');