Gtk2-Perl

Description A set of Perl bindings for Gtk+ 2.0 and various related libraries
Gtk2-Perl > Perl Manuals > Gtk2-RecentManager
Source

Index


NAME ^

Gtk2::RecentManager

HIERARCHY ^

  Glib::Object
  +----Gtk2::RecentManager







METHODS ^

recentmanager = Gtk2::RecentManager->new

boolean = $manager->add_full ($uri, $data)

* $uri (string)
* $data (scalar)

Add $uri to the list of recently used documents. Instead of letting the Gtk2::RecentManager object guess the meta-data, use $data to supply it. $data is a hash reference with these keys:

display_name

The name to be used when displaying the document inside the recently used documents list.

description

A short description of the document.

mime_type

The MIME type of the document. [Mandatory]

app_name

The name of the application that is registering the document. You might use the same name you used in Glib::set_application_name.

app_exec

The command line needed to launch the application with the document. You can use the variable "%u", which will be expanded to the document's URI, or the variable "%f" which will be expanded to the document's canonical full path.

groups

An array reference, containing the group names the document belongs to.

is_private

Whether the document should be visible only to the applications and groups that have registered it.

boolean = $manager->add_item ($uri)

* $uri (string)

Add $uri to the list of recently used documents. The Gtk2::RecentManager object will try to guess the meta-data of the document from its URI, but if you know it you should use Gtk2::RecentManager::add_full.

recentmanager = Gtk2::RecentManager->get_default

recentmanager = Gtk2::RecentManager->get_for_screen ($screen)

* $screen (Gtk2::Gdk::Screen)

boolean = $manager->has_item ($uri)

* $uri (string)

(items) = $manager->get_items

integer = $manager->get_limit

$manager->set_limit ($limit)

* $limit (integer)

recentinfo = $manager->lookup_item ($uri)

* $uri (string)

May croak with a Glib::Error in $@ on failure.

$manager->move_item ($old_uri, $new_uri)

* $old_uri (string)
* $new_uri (string or undef)

May croak with a Glib::Error in $@ on failure.

integer = $manager->purge_items

May croak with a Glib::Error in $@ on failure.

$manager->remove_item ($uri)

* $uri (string)

May croak with a Glib::Error in $@ on failure.

$manager->set_screen ($screen)

* $screen (Gtk2::Gdk::Screen)

PROPERTIES ^

'filename' (string : readable / writable / construct-only)

The full path to the file to be used to store and read the list

'limit' (integer : readable / writable)

The maximum number of items to be returned by gtk_recent_manager_get_items()

'size' (integer : readable)

The size of the recently used resources list

SIGNALS ^

changed (Gtk2::RecentManager)

ENUMS AND FLAGS ^

enum GtkRecentManagerError

* 'not-found' / 'GTK_RECENT_MANAGER_ERROR_NOT_FOUND'
* 'invalid-uri' / 'GTK_RECENT_MANAGER_ERROR_INVALID_URI'
* 'invalid-encoding' / 'GTK_RECENT_MANAGER_ERROR_INVALID_ENCODING'
* 'not-registered' / 'GTK_RECENT_MANAGER_ERROR_NOT_REGISTERED'
* 'read' / 'GTK_RECENT_MANAGER_ERROR_READ'
* 'write' / 'GTK_RECENT_MANAGER_ERROR_WRITE'
* 'unknown' / 'GTK_RECENT_MANAGER_ERROR_UNKNOWN'

SEE ALSO ^

Gtk2, Glib::Object

COPYRIGHT ^

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

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