.\" 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::RecentManager 3pm" .TH Gtk2::RecentManager 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::RecentManager \- wrapper for GtkRecentManager .SH "HIERARCHY" .IX Header "HIERARCHY" .Vb 2 \& Glib::Object \& +\-\-\-\-Gtk2::RecentManager .Ve .SH "METHODS" .IX Header "METHODS" .SS "recentmanager = Gtk2::RecentManager\->\fBnew\fP" .IX Subsection "recentmanager = Gtk2::RecentManager->new" .ie n .SS "boolean = $manager\->\fBadd_full\fP ($uri, $data)" .el .SS "boolean = \f(CW$manager\fP\->\fBadd_full\fP ($uri, \f(CW$data\fP)" .IX Subsection "boolean = $manager->add_full ($uri, $data)" .IP "\(bu" 4 \&\f(CW$uri\fR (string) .IP "\(bu" 4 \&\f(CW$data\fR (scalar) .PP Add \fI\f(CI$uri\fI\fR to the list of recently used documents. Instead of letting the Gtk2::RecentManager object guess the meta-data, use \fI\f(CI$data\fI\fR to supply it. \&\fI\f(CI$data\fI\fR is a hash reference with these keys: .IP "display_name" 4 .IX Item "display_name" The name to be used when displaying the document inside the recently used documents list. .IP "description" 4 .IX Item "description" A short description of the document. .IP "mime_type" 4 .IX Item "mime_type" The \s-1MIME\s0 type of the document. [Mandatory] .IP "app_name" 4 .IX Item "app_name" The name of the application that is registering the document. You might use the same name you used in \f(CW\*(C`Glib::set_application_name\*(C'\fR (see Glib::Utils). .IP "app_exec" 4 .IX Item "app_exec" The command line needed to launch the application with the document. You can use the variable \f(CW"%u"\fR, which will be expanded to the document's \s-1URI,\s0 or the variable \f(CW"%f"\fR which will be expanded to the document's canonical full path. .IP "groups" 4 .IX Item "groups" An array reference, containing the group names the document belongs to. .IP "is_private" 4 .IX Item "is_private" Whether the document should be visible only to the applications and groups that have registered it. .ie n .SS "boolean = $manager\->\fBadd_item\fP ($uri)" .el .SS "boolean = \f(CW$manager\fP\->\fBadd_item\fP ($uri)" .IX Subsection "boolean = $manager->add_item ($uri)" .IP "\(bu" 4 \&\f(CW$uri\fR (string) .PP Add \fI\f(CI$uri\fI\fR to the list of recently used documents. The Gtk2::RecentManager object will try to guess the meta-data of the document from its \s-1URI,\s0 but if you know it you should use \f(CW\*(C`add_full\*(C'\fR above. .SS "recentmanager = Gtk2::RecentManager\->\fBget_default\fP" .IX Subsection "recentmanager = Gtk2::RecentManager->get_default" .SS "recentmanager = Gtk2::RecentManager\->\fBget_for_screen\fP ($screen)" .IX Subsection "recentmanager = Gtk2::RecentManager->get_for_screen ($screen)" .IP "\(bu" 4 \&\f(CW$screen\fR (Gtk2::Gdk::Screen) .ie n .SS "boolean = $manager\->\fBhas_item\fP ($uri)" .el .SS "boolean = \f(CW$manager\fP\->\fBhas_item\fP ($uri)" .IX Subsection "boolean = $manager->has_item ($uri)" .IP "\(bu" 4 \&\f(CW$uri\fR (string) .ie n .SS "(items) = $manager\->\fBget_items\fP" .el .SS "(items) = \f(CW$manager\fP\->\fBget_items\fP" .IX Subsection "(items) = $manager->get_items" .ie n .SS "integer = $manager\->\fBget_limit\fP" .el .SS "integer = \f(CW$manager\fP\->\fBget_limit\fP" .IX Subsection "integer = $manager->get_limit" .ie n .SS "$manager\->\fBset_limit\fP ($limit)" .el .SS "\f(CW$manager\fP\->\fBset_limit\fP ($limit)" .IX Subsection "$manager->set_limit ($limit)" .IP "\(bu" 4 \&\f(CW$limit\fR (integer) .ie n .SS "recentinfo = $manager\->\fBlookup_item\fP ($uri)" .el .SS "recentinfo = \f(CW$manager\fP\->\fBlookup_item\fP ($uri)" .IX Subsection "recentinfo = $manager->lookup_item ($uri)" .IP "\(bu" 4 \&\f(CW$uri\fR (string) .PP May croak with a Glib::Error in $@ on failure. .ie n .SS "$manager\->\fBmove_item\fP ($old_uri, $new_uri)" .el .SS "\f(CW$manager\fP\->\fBmove_item\fP ($old_uri, \f(CW$new_uri\fP)" .IX Subsection "$manager->move_item ($old_uri, $new_uri)" .IP "\(bu" 4 \&\f(CW$old_uri\fR (string) .IP "\(bu" 4 \&\f(CW$new_uri\fR (string or undef) .PP May croak with a Glib::Error in $@ on failure. .ie n .SS "integer = $manager\->\fBpurge_items\fP" .el .SS "integer = \f(CW$manager\fP\->\fBpurge_items\fP" .IX Subsection "integer = $manager->purge_items" May croak with a Glib::Error in $@ on failure. .ie n .SS "$manager\->\fBremove_item\fP ($uri)" .el .SS "\f(CW$manager\fP\->\fBremove_item\fP ($uri)" .IX Subsection "$manager->remove_item ($uri)" .IP "\(bu" 4 \&\f(CW$uri\fR (string) .PP May croak with a Glib::Error in $@ on failure. .ie n .SS "$manager\->\fBset_screen\fP ($screen)" .el .SS "\f(CW$manager\fP\->\fBset_screen\fP ($screen)" .IX Subsection "$manager->set_screen ($screen)" .IP "\(bu" 4 \&\f(CW$screen\fR (Gtk2::Gdk::Screen) .SH "PROPERTIES" .IX Header "PROPERTIES" .IP "'filename' (string : default undef : readable / writable / construct-only)" 4 .IX Item "'filename' (string : default undef : readable / writable / construct-only)" The full path to the file to be used to store and read the list .IP "'limit' (integer : default \-1 : readable / writable)" 4 .IX Item "'limit' (integer : default -1 : readable / writable)" The maximum number of items to be returned by \fBgtk_recent_manager_get_items()\fR .IP "'size' (integer : default 0 : readable)" 4 .IX Item "'size' (integer : default 0 : readable)" The size of the recently used resources list .SH "SIGNALS" .IX Header "SIGNALS" .IP "\fBchanged\fR (Gtk2::RecentManager)" 4 .IX Item "changed (Gtk2::RecentManager)" .SH "ENUMS AND FLAGS" .IX Header "ENUMS AND FLAGS" .SS "enum GtkRecentManagerError" .IX Subsection "enum GtkRecentManagerError" .PD 0 .IP "\(bu" 4 .PD \&'not\-found' / '\s-1GTK_RECENT_MANAGER_ERROR_NOT_FOUND\s0' .IP "\(bu" 4 \&'invalid\-uri' / '\s-1GTK_RECENT_MANAGER_ERROR_INVALID_URI\s0' .IP "\(bu" 4 \&'invalid\-encoding' / '\s-1GTK_RECENT_MANAGER_ERROR_INVALID_ENCODING\s0' .IP "\(bu" 4 \&'not\-registered' / '\s-1GTK_RECENT_MANAGER_ERROR_NOT_REGISTERED\s0' .IP "\(bu" 4 \&'read' / '\s-1GTK_RECENT_MANAGER_ERROR_READ\s0' .IP "\(bu" 4 \&'write' / '\s-1GTK_RECENT_MANAGER_ERROR_WRITE\s0' .IP "\(bu" 4 \&'unknown' / '\s-1GTK_RECENT_MANAGER_ERROR_UNKNOWN\s0' .SH "SEE ALSO" .IX Header "SEE ALSO" Gtk2, Glib::Object .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.