root/trunk/src/gio/AppInfoIF.d

/*
 * This file is part of gtkD.
 *
 * gtkD 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 3
 * of the License, or (at your option) any later version, with
 * some exceptions, please read the COPYING file.
 *
 * gtkD 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 gtkD; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
 */
 
// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage

/*
 * Conversion parameters:
 * inFile  = GAppInfo.html
 * outPack = gio
 * outFile = AppInfoIF
 * strct   = GAppInfo
 * realStrct=
 * ctorStrct=
 * clss    = AppInfoT
 * interf  = AppInfoIF
 * class Code: No
 * interface Code: No
 * template for:
 * extend  = 
 * implements:
 * prefixes:
 *  - g_app_info_
 * omit structs:
 * omit prefixes:
 *  - g_app_launch_context_
 * omit code:
 * omit signals:
 * imports:
 *  - glib.Str
 *  - glib.ErrorG
 *  - glib.GException
 *  - glib.ListG
 *  - gio.AppInfoIF
 *  - gio.AppLaunchContext
 *  - gio.Icon
 *  - gio.IconIF
 * structWrap:
 *  - GAppInfo* -> AppInfoIF
 *  - GAppLaunchContext* -> AppLaunchContext
 *  - GIcon* -> IconIF
 *  - GList* -> ListG
 * module aliases:
 * local aliases:
 * overrides:
 */

module gio.AppInfoIF;

public  import gtkc.giotypes;

private import gtkc.gio;
private import glib.ConstructionException;


private import glib.Str;
private import glib.ErrorG;
private import glib.GException;
private import glib.ListG;
private import gio.AppInfoIF;
private import gio.AppLaunchContext;
private import gio.Icon;
private import gio.IconIF;




/**
 * Description
 * GAppInfo and GAppLaunchContext are used for describing and launching
 * applications installed on the system.
 * As of GLib 2.20, URIs will always be converted to POSIX paths
 * (using g_file_get_path()) when using g_app_info_launch() even if
 * the application requested an URI and not a POSIX path. For example
 * for an desktop-file based application with Exec key totem
 * %U and a single URI,
 * sftp://foo/file.avi, then
 * /home/user/.gvfs/sftp on foo/file.avi will be
 * passed. This will only work if a set of suitable GIO extensions
 * (such as gvfs 2.26 compiled with FUSE support), is available and
 * operational; if this is not the case, the URI will be passed
 * unmodified to the application. Some URIs, such as
 * mailto:, of course cannot be mapped to a POSIX
 * path (in gvfs there's no FUSE mount for it); such URIs will be
 * passed unmodified to the application.
 * Specifically for gvfs 2.26 and later, the POSIX URI will be mapped
 * back to the GIO URI in the GFile constructors (since gvfs
 * implements the GVfs extension point). As such, if the application
 * needs to examine the URI, it needs to use g_file_get_uri() or
 * similar on GFile. In other words, an application cannot assume
 * that the URI passed to e.g. g_file_new_for_commandline_arg() is
 * equal to the result of g_file_get_uri(). The following snippet
 * illustrates this:
 * GFile *f;
 * char *uri;
 * file = g_file_new_for_commandline_arg (uri_from_commandline);
 * uri = g_file_get_uri (file);
 * strcmp (uri, uri_from_commandline) == 0; // FALSE
 * g_free (uri);
 * if (g_file_has_uri_scheme (file, "cdda"))
 *  {
     *  // do something special with uri
 *  }
 * g_object_unref (file);
 * This code will work when both cdda://sr0/Track
 * 1.wav and /home/user/.gvfs/cdda on sr0/Track
 * 1.wav is passed to the application. It should be noted
 * that it's generally not safe for applications to rely on the format
 * of a particular URIs. Different launcher applications (e.g. file
 * managers) may have different ideas of what a given URI means.
 */
public interface AppInfoIF
{
    
    
    public GAppInfo* getAppInfoTStruct();
    
    /** the main Gtk struct as a void* */
    protected void* getStruct();
    
    
    /**
     */
    
    /**
     * Creates a new GAppInfo from the given information.
     * Params:
     * commandline = the commandline to use
     * applicationName = the application name, or NULL to use commandline. [allow-none]
     * flags = flags that can specify details of the created GAppInfo
     * Returns: new GAppInfo for given command. [transfer full]
     * Throws: GException on failure.
     */
    public static AppInfoIF createFromCommandline(string commandline, string applicationName, GAppInfoCreateFlags flags);
    
    /**
     * Creates a duplicate of a GAppInfo.
     * Returns: a duplicate of appinfo. [transfer full]
     */
    public AppInfoIF dup();
    
    /**
     * Checks if two GAppInfos are equal.
     * Params:
     * appinfo2 = the second GAppInfo.
     * Returns: TRUE if appinfo1 is equal to appinfo2. FALSE otherwise.
     */
    public int equal(AppInfoIF appinfo2);
    
    /**
     * Gets the ID of an application. An id is a string that
     * identifies the application. The exact format of the id is
     * platform dependent. For instance, on Unix this is the
     * desktop file id from the xdg menu specification.
     * Note that the returned ID may be NULL, depending on how
     * the appinfo has been constructed.
     * Returns: a string containing the application's ID.
     */
    public string getId();
    
    /**
     * Gets the installed name of the application.
     * Returns: the name of the application for appinfo.
     */
    public string getName();
    
    /**
     * Gets the display name of the application. The display name is often more
     * descriptive to the user than the name itself.
     * Since 2.24
     * Returns: the display name of the application for appinfo, or the name if no display name is available.
     */
    public string getDisplayName();
    
    /**
     * Gets a human-readable description of an installed application.
     * Returns: a string containing a description of the application appinfo, or NULL if none.
     */
    public string getDescription();
    
    /**
     * Gets the executable's name for the installed application.
     * Returns: a string containing the appinfo's application binaries name
     */
    public string getExecutable();
    
    /**
     * Gets the commandline with which the application will be
     * started.
     * Since 2.20
     * Returns: a string containing the appinfo's commandline, or NULL if this information is not available
     */
    public string getCommandline();
    
    /**
     * Gets the icon for the application.
     * Returns: the default GIcon for appinfo. [transfer none]
     */
    public IconIF getIcon();
    
    /**
     * Launches the application. Passes files to the launched application
     * as arguments, using the optional launch_context to get information
     * about the details of the launcher (like what screen it is on).
     * On error, error will be set accordingly.
     * To launch the application without arguments pass a NULL files list.
     * Note that even if the launch is successful the application launched
     * can fail to start if it runs into problems during startup. There is
     * no way to detect this.
     * Some URIs can be changed when passed through a GFile (for instance
     * unsupported uris with strange formats like mailto:), so if you have
     * a textual uri you want to pass in as argument, consider using
     * g_app_info_launch_uris() instead.
     * On UNIX, this function sets the GIO_LAUNCHED_DESKTOP_FILE
     * environment variable with the path of the launched desktop file and
     * GIO_LAUNCHED_DESKTOP_FILE_PID to the process
     * id of the launched process. This can be used to ignore
     * GIO_LAUNCHED_DESKTOP_FILE, should it be inherited
     * by further processes. The DISPLAY and
     * DESKTOP_STARTUP_ID environment variables are also
     * set, based on information provided in launch_context.
     * Params:
     * files = a GList of GFile objects. [element-type GFile]
     * launchContext = a GAppLaunchContext or NULL. [allow-none]
     * Returns: TRUE on successful launch, FALSE otherwise.
     * Throws: GException on failure.
     */
    public int launch(ListG files, AppLaunchContext launchContext);
    
    /**
     * Checks if the application accepts files as arguments.
     * Returns: TRUE if the appinfo supports files.
     */
    public int supportsFiles();
    
    /**
     * Checks if the application supports reading files and directories from URIs.
     * Returns: TRUE if the appinfo supports URIs.
     */
    public int supportsUris();
    
    /**
     * Launches the application. Passes uris to the launched application
     * as arguments, using the optional launch_context to get information
     * about the details of the launcher (like what screen it is on).
     * On error, error will be set accordingly.
     * To lauch the application without arguments pass a NULL uris list.
     * Note that even if the launch is successful the application launched
     * can fail to start if it runs into problems during startup. There is
     * no way to detect this.
     * Params:
     * uris = a GList containing URIs to launch. [element-type utf8]
     * launchContext = a GAppLaunchContext or NULL. [allow-none]
     * Returns: TRUE on successful launch, FALSE otherwise.
     * Throws: GException on failure.
     */
    public int launchUris(ListG uris, AppLaunchContext launchContext);
    
    /**
     * Checks if the application info should be shown in menus that
     * list available applications.
     * Returns: TRUE if the appinfo should be shown, FALSE otherwise.
     */
    public int shouldShow();
    
    /**
     * Obtains the information whether the GAppInfo can be deleted.
     * See g_app_info_delete().
     * Since 2.20
     * Returns: TRUE if appinfo can be deleted
     */
    public int canDelete();
    
    /**
     * Tries to delete a GAppInfo.
     * On some platforms, there may be a difference between user-defined
     * GAppInfos which can be deleted, and system-wide ones which
     * cannot. See g_app_info_can_delete().
     * Virtual: do_delete
     * Since 2.20
     * Returns: TRUE if appinfo has been deleted
     */
    public int delet();
    
    /**
     * Removes all changes to the type associations done by
     * g_app_info_set_as_default_for_type(),
     * g_app_info_set_as_default_for_extension(),
     * g_app_info_add_supports_type() or g_app_info_remove_supports_type().
     * Since 2.20
     * Params:
     * contentType = a content type
     */
    public static void resetTypeAssociations(string contentType);
    
    /**
     * Sets the application as the default handler for a given type.
     * Params:
     * contentType = the content type.
     * Returns: TRUE on success, FALSE on error.
     * Throws: GException on failure.
     */
    public int setAsDefaultForType(string contentType);
    
    /**
     * Sets the application as the default handler for the given file extension.
     * Params:
     * extension = a string containing the file extension (without the dot).
     * Returns: TRUE on success, FALSE on error.
     * Throws: GException on failure.
     */
    public int setAsDefaultForExtension(string extension);
    
    /**
     * Sets the application as the last used application for a given type.
     * This will make the application appear as first in the list returned by
     * g_app_info_get_recommended_for_type, regardless of the default application
     * for that content type.
     * Params:
     * contentType = the content type.
     * Returns: TRUE on success, FALSE on error.
     * Throws: GException on failure.
     */
    public int setAsLastUsedForType(string contentType);
    
    /**
     * Adds a content type to the application information to indicate the
     * application is capable of opening files with the given content type.
     * Params:
     * contentType = a string.
     * Returns: TRUE on success, FALSE on error.
     * Throws: GException on failure.
     */
    public int addSupportsType(string contentType);
    
    /**
     * Checks if a supported content type can be removed from an application.
     * Returns: TRUE if it is possible to remove supported content types from a given appinfo, FALSE if not.
     */
    public int canRemoveSupportsType();
    
    /**
     * Removes a supported type from an application, if possible.
     * Params:
     * contentType = a string.
     * Returns: TRUE on success, FALSE on error.
     * Throws: GException on failure.
     */
    public int removeSupportsType(string contentType);
    
    /**
     * Gets a list of all of the applications currently registered
     * on this system.
     * For desktop files, this includes applications that have
     * NoDisplay=true set or are excluded from
     * display by means of OnlyShowIn or
     * NotShowIn. See g_app_info_should_show().
     * The returned list does not include applications which have
     * the Hidden key set.
     * Returns: a newly allocated GList of references to GAppInfos. [element-type GAppInfo][transfer full]
     */
    public static ListG getAll();
    
    /**
     * Gets a list of all GAppInfos for a given content type.
     * Params:
     * contentType = the content type to find a GAppInfo for
     * Returns: GList of GAppInfos for given content_type or NULL on error. [element-type GAppInfo][transfer full]
     */
    public static ListG getAllForType(string contentType);
    
    /**
     * Gets the GAppInfo that corresponds to a given content type.
     * Params:
     * contentType = the content type to find a GAppInfo for
     * mustSupportUris = if TRUE, the GAppInfo is expected to
     * support URIs
     * Returns: GAppInfo for given content_type or NULL on error. [transfer full]
     */
    public static AppInfoIF getDefaultForType(string contentType, int mustSupportUris);
    
    /**
     * Gets the default application for launching applications
     * using this URI scheme. A URI scheme is the initial part
     * of the URI, up to but not including the ':', e.g. "http",
     * "ftp" or "sip".
     * Params:
     * uriScheme = a string containing a URI scheme.
     * Returns: GAppInfo for given uri_scheme or NULL on error. [transfer full]
     */
    public static AppInfoIF getDefaultForUriScheme(string uriScheme);
    
    /**
     * Gets a list of fallback GAppInfos for a given content type, i.e.
     * those applications which claim to support the given content type
     * by MIME type subclassing and not directly.
     * Since 2.28
     * Params:
     * contentType = the content type to find a GAppInfo for
     * Returns: GList of GAppInfos for given content_type or NULL on error. [element-type GAppInfo][transfer full]
     */
    public static ListG getFallbackForType(string contentType);
    
    /**
     * Gets a list of recommended GAppInfos for a given content type, i.e.
     * those applications which claim to support the given content type exactly,
     * and not by MIME type subclassing.
     * Note that the first application of the list is the last used one, i.e.
     * the last one for which g_app_info_set_as_last_used_for_type has been
     * called.
     * Since 2.28
     * Params:
     * contentType = the content type to find a GAppInfo for
     * Returns: GList of GAppInfos for given content_type or NULL on error. [element-type GAppInfo][transfer full]
     */
    public static ListG getRecommendedForType(string contentType);
    
    /**
     * Utility function that launches the default application
     * registered to handle the specified uri. Synchronous I/O
     * is done on the uri to detect the type of the file if
     * required.
     * Params:
     * uri = the uri to show
     * launchContext = an optional GAppLaunchContext. [allow-none]
     * Returns: TRUE on success, FALSE on error.
     * Throws: GException on failure.
     */
    public static int launchDefaultForUri(string uri, AppLaunchContext launchContext);
}