.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Gtk2::InfoBar 3pm" .TH Gtk2::InfoBar 3pm "2019-09-16" "perl v5.28.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Gtk2::InfoBar \- wrapper for GtkInfoBar .SH "HIERARCHY" .IX Header "HIERARCHY" .Vb 8 \& Glib::Object \& +\-\-\-\-Glib::InitiallyUnowned \& +\-\-\-\-Gtk2::Object \& +\-\-\-\-Gtk2::Widget \& +\-\-\-\-Gtk2::Container \& +\-\-\-\-Gtk2::Box \& +\-\-\-\-Gtk2::HBox \& +\-\-\-\-Gtk2::InfoBar .Ve .SH "INTERFACES" .IX Header "INTERFACES" .Vb 3 \& Glib::Object::_Unregistered::AtkImplementorIface \& Gtk2::Buildable \& Gtk2::Orientable .Ve .SH "METHODS" .IX Header "METHODS" .ie n .SS "$widget = Gtk2::InfoBar\->\fBnew\fP;" .el .SS "\f(CW$widget\fP = Gtk2::InfoBar\->\fBnew\fP;" .IX Subsection "$widget = Gtk2::InfoBar->new;" .ie n .SS "$widget = Gtk2::InfoBar\->\fBnew\fP (...)" .el .SS "\f(CW$widget\fP = Gtk2::InfoBar\->\fBnew\fP (...)" .IX Subsection "$widget = Gtk2::InfoBar->new (...)" .IP "\(bu" 4 \&... (list) of button-text => response-id pairs. .PP The multi-argument form takes the same list of text => response-id pairs as \&\f(CW\*(C`$infobar\->add_buttons\*(C'\fR. Do not pack widgets directly into the infobar; add them to \f(CW\*(C`$infobar\->get_content_area ()\*(C'\fR. .PP Here's a simple example: .PP .Vb 2 \& $infobar = Gtk2::InfoBar\->new (\*(Aqgtk\-ok\*(Aq => \*(Aqaccept\*(Aq, \& \*(Aqgtk\-cancel\*(Aq => \*(Aqreject\*(Aq); .Ve .ie n .SS "$widget = Gtk2::InfoBar\->\fBnew_with_buttons\fP (...)" .el .SS "\f(CW$widget\fP = Gtk2::InfoBar\->\fBnew_with_buttons\fP (...)" .IX Subsection "$widget = Gtk2::InfoBar->new_with_buttons (...)" .IP "\(bu" 4 \&... (list) of button-text => response-id pairs. .PP Alias for the multi-argument version of \f(CW\*(C`Gtk2::InfoBar\->new\*(C'\fR. .ie n .SS "widget = $info_bar\->\fBget_action_area\fP" .el .SS "widget = \f(CW$info_bar\fP\->\fBget_action_area\fP" .IX Subsection "widget = $info_bar->get_action_area" .ie n .SS "$info_bar\->\fBadd_action_widget\fP ($child, $response_id)" .el .SS "\f(CW$info_bar\fP\->\fBadd_action_widget\fP ($child, \f(CW$response_id\fP)" .IX Subsection "$info_bar->add_action_widget ($child, $response_id)" .IP "\(bu" 4 \&\f(CW$child\fR (Gtk2::Widget) .IP "\(bu" 4 \&\f(CW$response_id\fR (Gtk2::ResponseType) .ie n .SS "widget = $info_bar\->\fBadd_button\fP ($button_text, $response_id)" .el .SS "widget = \f(CW$info_bar\fP\->\fBadd_button\fP ($button_text, \f(CW$response_id\fP)" .IX Subsection "widget = $info_bar->add_button ($button_text, $response_id)" .IP "\(bu" 4 \&\f(CW$button_text\fR (string) .IP "\(bu" 4 \&\f(CW$response_id\fR (scalar) .ie n .SS "$info_bar\->\fBadd_buttons\fP (...)" .el .SS "\f(CW$info_bar\fP\->\fBadd_buttons\fP (...)" .IX Subsection "$info_bar->add_buttons (...)" .IP "\(bu" 4 \&... (list) of button-text => response-id pairs .PP Like calling \f(CW\*(C`$infobar\->add_button\*(C'\fR repeatedly, except you don't get the created widgets back. The buttons go from left to right, so the first button added will be the left-most one. .ie n .SS "widget = $info_bar\->\fBget_content_area\fP" .el .SS "widget = \f(CW$info_bar\fP\->\fBget_content_area\fP" .IX Subsection "widget = $info_bar->get_content_area" .ie n .SS "$info_bar\->\fBset_default_response\fP ($response_id)" .el .SS "\f(CW$info_bar\fP\->\fBset_default_response\fP ($response_id)" .IX Subsection "$info_bar->set_default_response ($response_id)" .IP "\(bu" 4 \&\f(CW$response_id\fR (Gtk2::ResponseType) .ie n .SS "messagetype = $info_bar\->\fBget_message_type\fP" .el .SS "messagetype = \f(CW$info_bar\fP\->\fBget_message_type\fP" .IX Subsection "messagetype = $info_bar->get_message_type" .ie n .SS "$info_bar\->\fBset_message_type\fP ($type)" .el .SS "\f(CW$info_bar\fP\->\fBset_message_type\fP ($type)" .IX Subsection "$info_bar->set_message_type ($type)" .IP "\(bu" 4 \&\f(CW$type\fR (Gtk2::MessageType) .ie n .SS "$info_bar\->\fBresponse\fP ($response_id)" .el .SS "\f(CW$info_bar\fP\->\fBresponse\fP ($response_id)" .IX Subsection "$info_bar->response ($response_id)" .IP "\(bu" 4 \&\f(CW$response_id\fR (Gtk2::ResponseType) .ie n .SS "$info_bar\->\fBset_response_sensitive\fP ($response_id, $setting)" .el .SS "\f(CW$info_bar\fP\->\fBset_response_sensitive\fP ($response_id, \f(CW$setting\fP)" .IX Subsection "$info_bar->set_response_sensitive ($response_id, $setting)" .IP "\(bu" 4 \&\f(CW$response_id\fR (Gtk2::ResponseType) .IP "\(bu" 4 \&\f(CW$setting\fR (boolean) .PP Enable or disable an action button by its \fI\f(CI$response_id\fI\fR. .SH "PROPERTIES" .IX Header "PROPERTIES" .ie n .IP "'message\-type' (Gtk2::MessageType : default ""info"" : readable / writable / construct / private)" 4 .el .IP "'message\-type' (Gtk2::MessageType : default ``info'' : readable / writable / construct / private)" 4 .IX Item "'message-type' (Gtk2::MessageType : default info : readable / writable / construct / private)" The type of message .SH "STYLE PROPERTIES" .IX Header "STYLE PROPERTIES" .IP "'action\-area\-border' (integer : default 5 : readable / private)" 4 .IX Item "'action-area-border' (integer : default 5 : readable / private)" Width of border around the action area .IP "'button\-spacing' (integer : default 6 : readable / private)" 4 .IX Item "'button-spacing' (integer : default 6 : readable / private)" Spacing between buttons .IP "'content\-area\-border' (integer : default 8 : readable / private)" 4 .IX Item "'content-area-border' (integer : default 8 : readable / private)" Width of border around the content area .IP "'content\-area\-spacing' (integer : default 16 : readable / private)" 4 .IX Item "'content-area-spacing' (integer : default 16 : readable / private)" Spacing between elements of the area .SH "SIGNALS" .IX Header "SIGNALS" .IP "\fBclose\fR (Gtk2::InfoBar)" 4 .IX Item "close (Gtk2::InfoBar)" .PD 0 .IP "\fBresponse\fR (Gtk2::InfoBar, integer)" 4 .IX Item "response (Gtk2::InfoBar, integer)" .PD .PP Note that currently in a Perl subclass of \f(CW\*(C`Gtk2::InfoBar\*(C'\fR a class closure, ie. class default signal handler, for the \f(CW\*(C`response\*(C'\fR signal will be called with the response \s-1ID\s0 just as an integer, it's not turned into an enum string like \f(CW"ok"\fR the way a handler setup with \&\f(CW\*(C`signal_connect\*(C'\fR receives. .PP Hopefully this will change in the future, so don't count on it. In the interim the easiest thing to do is install your default handler in \&\f(CW\*(C`INIT_INSTANCE\*(C'\fR with a \f(CW\*(C`signal_connect\*(C'\fR. (The subtleties of what order handlers are called in will differ, but often that doesn't matter.) .SH "ENUMS AND FLAGS" .IX Header "ENUMS AND FLAGS" .SS "enum Gtk2::MessageType" .IX Subsection "enum Gtk2::MessageType" .IP "\(bu" 4 \&'info' / '\s-1GTK_MESSAGE_INFO\s0' .IP "\(bu" 4 \&'warning' / '\s-1GTK_MESSAGE_WARNING\s0' .IP "\(bu" 4 \&'question' / '\s-1GTK_MESSAGE_QUESTION\s0' .IP "\(bu" 4 \&'error' / '\s-1GTK_MESSAGE_ERROR\s0' .IP "\(bu" 4 \&'other' / '\s-1GTK_MESSAGE_OTHER\s0' .SS "enum Gtk2::ResponseType" .IX Subsection "enum Gtk2::ResponseType" The response type is somewhat abnormal as far as gtk2\-perl enums go. In C, this enum lists named, predefined integer values for a field that is other composed of whatever integer values you like. In Perl, we allow this to be either one of the string constants listed here or any positive integer value. For example, 'ok', 'cancel', 4, and 42 are all valid response ids. You cannot use arbitrary string values, they must be integers. Be careful, because unknown string values tend to be mapped to 0. .IP "\(bu" 4 \&'none' / '\s-1GTK_RESPONSE_NONE\s0' .IP "\(bu" 4 \&'reject' / '\s-1GTK_RESPONSE_REJECT\s0' .IP "\(bu" 4 \&'accept' / '\s-1GTK_RESPONSE_ACCEPT\s0' .IP "\(bu" 4 \&'delete\-event' / '\s-1GTK_RESPONSE_DELETE_EVENT\s0' .IP "\(bu" 4 \&'ok' / '\s-1GTK_RESPONSE_OK\s0' .IP "\(bu" 4 \&'cancel' / '\s-1GTK_RESPONSE_CANCEL\s0' .IP "\(bu" 4 \&'close' / '\s-1GTK_RESPONSE_CLOSE\s0' .IP "\(bu" 4 \&'yes' / '\s-1GTK_RESPONSE_YES\s0' .IP "\(bu" 4 \&'no' / '\s-1GTK_RESPONSE_NO\s0' .IP "\(bu" 4 \&'apply' / '\s-1GTK_RESPONSE_APPLY\s0' .IP "\(bu" 4 \&'help' / '\s-1GTK_RESPONSE_HELP\s0' .SH "SEE ALSO" .IX Header "SEE ALSO" Gtk2, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget, Gtk2::Container, Gtk2::Box, Gtk2::HBox .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 2003\-2011 by the gtk2\-perl team. .PP This software is licensed under the \s-1LGPL.\s0 See Gtk2 for a full notice.