recentchooser.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_RECENTCHOOSER_H
#define _GTKMM_RECENTCHOOSER_H
 
 
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
 
/* Copyright (C) 2006 The gtkmm Development Team
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
#include <glibmm/interface.h>
#include <gtkmm/recentinfo.h>
#include <gtkmm/recentfilter.h>
#include <gtkmm/recentmanager.h>
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
extern "C"
{
typedef struct _GtkRecentChooserIface GtkRecentChooserIface;
}
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkRecentChooser GtkRecentChooser;
typedef struct _GtkRecentChooserClass GtkRecentChooserClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{ class RecentChooser_Class; } // namespace Gtk
#endif // DOXYGEN_SHOULD_SKIP_THIS
 
namespace Gtk
{
 
enum RecentSortType
{
  RECENT_SORT_NONE,
  RECENT_SORT_MRU,
  RECENT_SORT_LRU,
  RECENT_SORT_CUSTOM
};
 
} // namespace Gtk
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
 
template <>
class Value<Gtk::RecentSortType> : public Glib::Value_Enum<Gtk::RecentSortType>
{
public:
  static GType value_type() G_GNUC_CONST;
};
 
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{
 
 
class RecentChooserError : public Glib::Error
{
public:
  enum Code
  {
    NOT_FOUND,
    INVALID_URI
  };
 
  RecentChooserError(Code error_code, const Glib::ustring& error_message);
  explicit RecentChooserError(GError* gobject);
  Code code() const;
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
 
  static void throw_func(GError* gobject);
 
  friend void wrap_init(); // uses throw_func()
 
  #endif //DOXYGEN_SHOULD_SKIP_THIS
};
 
} // namespace Gtk
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
 
template <>
class Value<Gtk::RecentChooserError::Code> : public Glib::Value_Enum<Gtk::RecentChooserError::Code>
{
public:
  static GType value_type() G_GNUC_CONST;
};
 
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
namespace Gtk
{
 
 
class RecentChooser : public Glib::Interface
{
  
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
public:
  typedef RecentChooser CppObjectType;
  typedef RecentChooser_Class CppClassType;
  typedef GtkRecentChooser BaseObjectType;
  typedef GtkRecentChooserIface BaseClassType;
 
private:
  friend class RecentChooser_Class;
  static CppClassType recentchooser_class_;
 
  // noncopyable
  RecentChooser(const RecentChooser&);
  RecentChooser& operator=(const RecentChooser&);
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
protected:
  RecentChooser();
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  explicit RecentChooser(const Glib::Interface_Class& interface_class);
 
public:
  // This is public so that C++ wrapper instances can be
  // created for C instances of unwrapped types.
  // For instance, if an unexpected C type implements the C interface. 
  explicit RecentChooser(GtkRecentChooser* castitem);
 
protected:
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
public:
  virtual ~RecentChooser();
 
  static void add_interface(GType gtype_implementer);
 
  static GType get_type()      G_GNUC_CONST;
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  static GType get_base_type() G_GNUC_CONST;
#endif
 
  GtkRecentChooser*       gobj()       { return reinterpret_cast<GtkRecentChooser*>(gobject_); }
 
  const GtkRecentChooser* gobj() const { return reinterpret_cast<GtkRecentChooser*>(gobject_); }
 
private:
 
public:
 
  
  void set_show_private(bool show_private =  true);
  
  bool get_show_private() const;
  
  void set_show_not_found(bool show_not_found =  true);
  
  bool get_show_not_found() const;
  
  void set_select_multiple(bool select_multiple =  true);
  
  bool get_select_multiple() const;
  
  void set_limit(int limit);
  void unset_limit();
  
  int get_limit() const;
  
  void set_local_only(bool local_only =  true);
  
  bool get_local_only() const;
  
  void set_show_tips(bool show_tips =  true);
  
  bool get_show_tips() const;
 
  // Deprecated in GTK+ 2.12. murrayc:
  
 
  void set_show_icons(bool show_icons =  true);
  
  bool get_show_icons() const;
  
  void set_sort_type(RecentSortType sort_type);
  
  RecentSortType get_sort_type() const;
 
 
  typedef sigc::slot<int, const Glib::RefPtr<RecentInfo>&, const Glib::RefPtr<RecentInfo>&> SlotCompare;
  
 
  void set_sort_func(const SlotCompare& slot);
 
  // TODO: Return type should be void since it will never return false but
  // throwing RecentChooserError instead
  
  bool set_current_uri(const Glib::ustring& uri);
  
  Glib::ustring get_current_uri() const;
  
  Glib::RefPtr<RecentInfo> get_current_item();
  
  Glib::RefPtr<const RecentInfo> get_current_item() const;
  // TODO: Same here
  
  bool select_uri(const Glib::ustring& uri);
  
  void unselect_uri(const Glib::ustring& uri);
  
  void select_all();
  
  void unselect_all();
 
  typedef Glib::ListHandle<RecentInfo, RecentInfoTraits> ListHandle_RecentInfos;
  
 
  ListHandle_RecentInfos get_items() const;
 
  Glib::StringArrayHandle get_uris() const;
  
 
  void add_filter(const RecentFilter& filter);
  
  void remove_filter(const RecentFilter& filter);
  
  Glib::SListHandle<RecentFilter*> list_filters();
  
  Glib::SListHandle<const RecentFilter*> list_filters() const;
  
  void set_filter(const RecentFilter& filter);
  
  RecentFilter* get_filter();
  
  const RecentFilter* get_filter() const;
 
  
  Glib::SignalProxy0< void > signal_selection_changed();
 
 
  Glib::SignalProxy0< void > signal_item_activated();
 
 
  //Not wrapped because it's write-only and construct-only: _WRAP_PROPERTY("recent-manager", Glib::RefPtr<RecentManager>)
  Glib::PropertyProxy< bool > property_show_private() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_show_private() const;
 
  Glib::PropertyProxy< bool > property_show_tips() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_show_tips() const;
 
  Glib::PropertyProxy< bool > property_show_icons() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_show_icons() const;
 
  Glib::PropertyProxy< bool > property_show_not_found() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_show_not_found() const;
 
  Glib::PropertyProxy< bool > property_select_multiple() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_select_multiple() const;
 
  Glib::PropertyProxy< bool > property_local_only() ;
 
  Glib::PropertyProxy_ReadOnly< bool > property_local_only() const;
 
  Glib::PropertyProxy< int > property_limit() ;
 
  Glib::PropertyProxy_ReadOnly< int > property_limit() const;
 
  Glib::PropertyProxy< RecentSortType > property_sort_type() ;
 
  Glib::PropertyProxy_ReadOnly< RecentSortType > property_sort_type() const;
 
  Glib::PropertyProxy< RecentFilter* > property_filter() ;
 
  Glib::PropertyProxy_ReadOnly< RecentFilter* > property_filter() const;
 
 
protected:
 
 
  // TODO: How to wrap those vfuncs?
 
  //__CONVERSION(`ListHandle_RecentInfos', `GList*', `($3).data()')
  //__CONVERSION(`Glib::SListHandle<RecentFilter*>', `GSList*', `($3).data()')
 
  //_WRAP_VFUNC(bool set_current_uri(const Glib::ustring& uri), "set_current_uri", errthrow)
    virtual Glib::ustring get_current_uri_vfunc() const;
 
 
  //_WRAP_VFUNC(bool select_uri(const Glib::ustring& uri), "select_uri", errthrow)
    virtual void unselect_uri_vfunc(const Glib::ustring& uri);
 
    virtual void select_all_vfunc();
 
    virtual void unselect_all_vfunc();
 
  //_WRAP_VFUNC(ArrayHandle_RecentInfos get_items() const, "get_items")
    virtual Glib::RefPtr<RecentManager> get_recent_manager_vfunc();
 
    virtual void add_filter_vfunc(const RecentFilter& filter);
 
    virtual void remove_filter_vfunc(const RecentFilter& filter);
 
  //_WRAP_VFUNC(Glib::SListHandle<RecentFilter*> list_filters(), "list_filters")
  //_WRAP_VFUNC(void set_sort_func(const SlotCompare& slot), "set_sort_func")
 
 
public:
 
public:
  //C++ methods used to invoke GTK+ virtual functions:
 
protected:
  //GTK+ Virtual Functions (override these to change behaviour):
 
  //Default Signal Handlers::
 
 
};
 
} // namespace Gtk
 
 
namespace Glib
{
  Glib::RefPtr<Gtk::RecentChooser> wrap(GtkRecentChooser* object, bool take_copy = false);
 
} // namespace Glib
 
 
#endif /* _GTKMM_RECENTCHOOSER_H */