logo top
Main Page   Widgets   Namespaces   Book  

Gtk::RecentAction Class Reference
[RecentFiles]

Inheritance diagram for Gtk::RecentAction:

List of all members.


Detailed Description

An action of which represents a list of recently used files.

A Gtk::RecentAction represents a list of recently used files, which can be shown by widgets such as Gtk::RecentChooserDialog or Gtk::RecentChooserMenu. To construct a submenu showing recently used files, use a Gtk::RecentAction as the action for a <menuitem>. To construct a menu toolbutton showing the recently used files in the popup menu, use a Gtk::RecentAction as the action for a <toolitem> element.

See also the methods in the RecentChooser base class.

Since gtkmm 2.12:

Public Member Functions

bool get_show_numbers ()
 Return value: true if numbers should be shown.
const GtkRecentAction* gobj () const
 Provides access to the underlying C GObject.
GtkRecentAction* gobj ()
 Provides access to the underlying C GObject.
GtkRecentAction* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::PropertyProxy_ReadOnly
<bool> 
property_show_numbers () const
 Whether the items should be displayed with a number.
Glib::PropertyProxy<bool> property_show_numbers ()
 Whether the items should be displayed with a number.
void set_show_numbers (bool show_numbers=true)
 Sets whether a number should be added to the items shown by the widgets representing action.
virtual ~RecentAction ()

Static Public Member Functions

static Glib::RefPtr<RecentActioncreate (const Glib::ustring& name, const Gtk::StockID& stock_id, const Glib::ustring& label, const Glib::ustring& tooltip, const Glib::RefPtr<RecentManager>& manager)
static Glib::RefPtr<RecentActioncreate (const Glib::ustring& name, const Gtk::StockID& stock_id, const Glib::ustring& label=Glib::ustring(), const Glib::ustring& tooltip=Glib::ustring())
 Creates an action with a stock ID.
static Glib::RefPtr<RecentActioncreate (const Glib::ustring& name, const Glib::ustring& label=Glib::ustring(), const Glib::ustring& tooltip=Glib::ustring())
 Creates an action.
static Glib::RefPtr<RecentActioncreate ()

Protected Member Functions

 RecentAction (const Glib::ustring& name, const StockID& stock_id, const Glib::ustring& label, const Glib::ustring& tooltip, const Glib::RefPtr<RecentManager>& manager)
 RecentAction (const Glib::ustring& name, const StockID& stock_id=StockID(), const Glib::ustring& label=Glib::ustring(), const Glib::ustring& tooltip=Glib::ustring())
 RecentAction ()

Related Functions

(Note that these are not member functions.)

Glib::RefPtr<Gtk::RecentActionwrap (GtkRecentAction* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Constructor & Destructor Documentation

virtual Gtk::RecentAction::~RecentAction (  )  [virtual]

Gtk::RecentAction::RecentAction (  )  [protected]

Gtk::RecentAction::RecentAction ( const Glib::ustring name,
const StockID stock_id = StockID(),
const Glib::ustring label = Glib::ustring(),
const Glib::ustring tooltip = Glib::ustring() 
) [explicit, protected]

Gtk::RecentAction::RecentAction ( const Glib::ustring name,
const StockID stock_id,
const Glib::ustring label,
const Glib::ustring tooltip,
const Glib::RefPtr<RecentManager>&  manager 
) [explicit, protected]


Member Function Documentation

static Glib::RefPtr<RecentAction> Gtk::RecentAction::create ( const Glib::ustring name,
const Gtk::StockID stock_id,
const Glib::ustring label,
const Glib::ustring tooltip,
const Glib::RefPtr<RecentManager>&  manager 
) [static]

static Glib::RefPtr<RecentAction> Gtk::RecentAction::create ( const Glib::ustring name,
const Gtk::StockID stock_id,
const Glib::ustring label = Glib::ustring(),
const Glib::ustring tooltip = Glib::ustring() 
) [static]

Creates an action with a stock ID.

The stock ID is used to set a default icon, text and accelerator for the action.

Parameters:
name A unique name for the action.
stock_id The stock icon to display in widgets representing the action.
label The label displayed in menu items and on buttons.
tooltip A tooltip for the action.
Returns:
A new Action.

Reimplemented from Gtk::Action.

static Glib::RefPtr<RecentAction> Gtk::RecentAction::create ( const Glib::ustring name,
const Glib::ustring label = Glib::ustring(),
const Glib::ustring tooltip = Glib::ustring() 
) [static]

Creates an action.

Parameters:
name A unique name for the action.
label The label displayed in menu items and on buttons.
tooltip A tooltip for the action.
Returns:
A new Action.

Reimplemented from Gtk::Action.

static Glib::RefPtr<RecentAction> Gtk::RecentAction::create (  )  [static]

Reimplemented from Gtk::Action.

bool Gtk::RecentAction::get_show_numbers (  ) 

Return value: true if numbers should be shown.

Returns:
true if numbers should be shown.
Since gtkmm 2.12:

const GtkRecentAction* Gtk::RecentAction::gobj (  )  const [inline]

Provides access to the underlying C GObject.

Reimplemented from Gtk::Action.

GtkRecentAction* Gtk::RecentAction::gobj (  )  [inline]

Provides access to the underlying C GObject.

Reimplemented from Gtk::Action.

GtkRecentAction* Gtk::RecentAction::gobj_copy (  ) 

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

Reimplemented from Gtk::Action.

Glib::PropertyProxy_ReadOnly<bool> Gtk::RecentAction::property_show_numbers (  )  const

Whether the items should be displayed with a number.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gtk::RecentAction::property_show_numbers (  ) 

Whether the items should be displayed with a number.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

void Gtk::RecentAction::set_show_numbers ( bool  show_numbers = true  ) 

Sets whether a number should be added to the items shown by the widgets representing action.

The numbers are shown to provide a unique character for a mnemonic to be used inside the menu item's label. Only the first ten items get a number to avoid clashes.

Since gtkmm 2.12:
Parameters:
show_numbers true if the shown items should be numbered.


Friends And Related Function Documentation

Glib::RefPtr<Gtk::RecentAction> wrap ( GtkRecentAction *  object,
bool  take_copy = false 
) [related]

A Glib::wrap() method for this object.

Parameters:
object The C instance.
take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.


The documentation for this class was generated from the following file:

Generated for gtkmm 2.4 by Doxygen 1.5.6 © 1997-2001