GtkRecentManager            package:RGtk2            R Documentation

_G_t_k_R_e_c_e_n_t_M_a_n_a_g_e_r

_D_e_s_c_r_i_p_t_i_o_n:

     Managing Recently Used Files

_M_e_t_h_o_d_s _a_n_d _F_u_n_c_t_i_o_n_s:

     'gtkRecentManagerNew()'
      'gtkRecentManagerGetDefault()'
      'gtkRecentManagerGetForScreen(screen)'
      'gtkRecentManagerGetForScreen(screen)'
      'gtkRecentManagerSetScreen(object, screen)'
      'gtkRecentManagerSetScreen(object, screen)'
      'gtkRecentManagerAddItem(object, uri)'
      'gtkRecentManagerAddFull(object, uri, recent.data)'
      'gtkRecentManagerRemoveItem(object, uri, .errwarn = TRUE)'
      'gtkRecentManagerLookupItem(object, uri, .errwarn = TRUE)'
      'gtkRecentManagerHasItem(object, uri)'
      'gtkRecentManagerMoveItem(object, uri, new.uri, .errwarn = TRUE)'
      'gtkRecentManagerGetLimit(object)'
      'gtkRecentManagerSetLimit(object, limit)'
      'gtkRecentManagerGetItems(object)'
      'gtkRecentManagerPurgeItems(object, .errwarn = TRUE)'
      'gtkRecentInfoRef(object)'
      'gtkRecentInfoUnref(object)'
      'gtkRecentInfoGetUri(object)'
      'gtkRecentInfoGetDisplayName(object)'
      'gtkRecentInfoGetDescription(object)'
      'gtkRecentInfoGetMimeType(object)'
      'gtkRecentInfoGetAdded(object)'
      'gtkRecentInfoGetModified(object)'
      'gtkRecentInfoGetVisited(object)'
      'gtkRecentInfoGetPrivateHint(object)'
      'gtkRecentInfoGetApplicationInfo(object, app.name)'
      'gtkRecentInfoGetApplications(object, length)'
      'gtkRecentInfoLastApplication(object)'
      'gtkRecentInfoGetGroups(object)'
      'gtkRecentInfoHasGroup(object, group.name)'
      'gtkRecentInfoHasApplication(object, app.name)'
      'gtkRecentInfoGetIcon(object, size)'
      'gtkRecentInfoGetShortName(object)'
      'gtkRecentInfoGetUriDisplay(object)'
      'gtkRecentInfoGetAge(object)'
      'gtkRecentInfoIsLocal(object)'
      'gtkRecentInfoExists(object)'
      'gtkRecentInfoMatch(object, info.b)'
      'gtkRecentManager()'

_H_i_e_r_a_r_c_h_y:

     GObject
        +----GtkRecentManager 

_D_e_t_a_i_l_e_d _D_e_s_c_r_i_p_t_i_o_n:

     'GtkRecentManager' provides a facility for adding, removing and
     looking up recently used files.  Each recently used file is
     identified by its URI, and has meta-data associated to it, like
     the names and command lines of the applications that have
     registered it, the number of time each application has registered
     the same file, the mime type of the file and whether the file
     should be displayed only by the applications that have registered
     it.

     The 'GtkRecentManager' acts like a database of all the recently
     used files.  You can create new 'GtkRecentManager' objects, but it
     is more efficient to use the standard recent manager for the
     'GdkScreen' so that informations about the recently used files is
     shared with other people using them.  In case the default screen
     is being used, adding a new recently used file is as simple as:


     manager <- gtkRecentManagerGetDefault()
     manager$addItem(file_uri)


     manager <- gtkRecentManagerGetDefault()
     lookup <- manager$lookupItem(file_uri)
     if (lookup$error)
       warning("Could not find the file:", lookup$error$message)
     else use_info_object(lookup$retval)
      Recently used files are supported since GTK+ 2.10.

_S_t_r_u_c_t_u_r_e_s:


     '_G_t_k_R_e_c_e_n_t_M_a_n_a_g_e_r' Acts as a database of information about the
          list of recently used files.  Normally, you retrieve the
          recent manager for a particular screen using
          'gtkRecentManagerGetForScreen' and it will contain
          information about current recent manager for that screen.


     '_G_t_k_R_e_c_e_n_t_I_n_f_o' Contains informations found when looking up an
          entry of the recently used files list.


     '_G_t_k_R_e_c_e_n_t_D_a_t_a' Meta-data to be passed to
          'gtkRecentManagerAddFull' when registering a recently used
          resource.   *'GtkRecentData' is a transparent-type.*

          '_d_i_s_p_l_a_y_N_a_m_e' [character]  a UTF-8 encoded string, containing
               the name of the recently used resource to be displayed,
               or 'NULL';

          '_d_e_s_c_r_i_p_t_i_o_n' [character]  a UTF-8 encoded string, containing
               a short description of the resource, or 'NULL';

          '_m_i_m_e_T_y_p_e' [character]  the MIME type of the resource;

          '_a_p_p_N_a_m_e' [character]  the name of the application that is
               registering this recently used resource;

          '_a_p_p_E_x_e_c' [character]  command line used to launch this
               resource; may contain the "%f" and "%u" escape
               characters which will be expanded  to the resource file
               path and URI respectively when the command line  is
               retrieved;

          '_g_r_o_u_p_s' [character]  a vector of strings containing groups
               names;

          '_i_s_P_r_i_v_a_t_e' [logical]  whether this resource should be
               displayed only by the applications that have registered
               it or not.


_C_o_n_v_e_n_i_e_n_t _C_o_n_s_t_r_u_c_t_i_o_n:

     'gtkRecentManager' is the equivalent of 'gtkRecentManagerNew'.

_E_n_u_m_s _a_n_d _F_l_a_g_s:


     '_G_t_k_R_e_c_e_n_t_M_a_n_a_g_e_r_E_r_r_o_r' Error codes for GtkRecentManager
          operations  

          '_n_o_t-_f_o_u_n_d' the URI specified does not exists in the recently
               used resources list.

          '_i_n_v_a_l_i_d-_u_r_i' the URI specified is not valid.

          '_i_n_v_a_l_i_d-_e_n_c_o_d_i_n_g' the supplied string is not UTF-8 encoded.

          '_n_o_t-_r_e_g_i_s_t_e_r_e_d' no application has registered the specified
               item.

          '_r_e_a_d' failure while reading the recently used resources
               file.

          '_w_r_i_t_e' failure while writing the recently used resources
               file.

          '_u_n_k_n_o_w_n' unspecified error.


_S_i_g_n_a_l_s:


     '_c_h_a_n_g_e_d(_r_e_c_e_n_t._m_a_n_a_g_e_r, _u_s_e_r._d_a_t_a)' Emitted when the current
          recently used resources manager changes its contents.  

          Since  2.10

          '_r_e_c_e_n_t._m_a_n_a_g_e_r' ['GtkRecentManager']  the recent manager

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


_P_r_o_p_e_r_t_i_e_s:


     '_f_i_l_e_n_a_m_e' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e / _C_o_n_s_t_r_u_c_t _O_n_l_y] The full
          path to the file to be used to store and read the recently
          used resources list  

          Default value: NULL  Since  2.10


     '_l_i_m_i_t' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] The maximum number of items to be
          returned by the 'gtkRecentManagerGetItems' function.  

          Allowed values: >= -1  Default value: -1  Since  2.10


     '_s_i_z_e' [_i_n_t_e_g_e_r : _R_e_a_d] The size of the recently used resources
          list.  

          Allowed values: >= -1  Default value: 0  Since  2.10


_A_u_t_h_o_r(_s):

     Derived by RGtkGen from GTK+ documentation

_R_e_f_e_r_e_n_c_e_s:

     <URL:
     http://developer.gnome.org/doc/API/2.0/gtk/GtkRecentManager.html>

