1 /* 2 * This file is part of gtkD. 3 * 4 * gtkD is free software; you can redistribute it and/or modify 5 * it under the terms of the GNU Lesser General Public License 6 * as published by the Free Software Foundation; either version 3 7 * of the License, or (at your option) any later version, with 8 * some exceptions, please read the COPYING file. 9 * 10 * gtkD is distributed in the hope that it will be useful, 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * GNU Lesser General Public License for more details. 14 * 15 * You should have received a copy of the GNU Lesser General Public License 16 * along with gtkD; if not, write to the Free Software 17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA 18 */ 19 20 // generated automatically - do not change 21 // find conversion definition on APILookup.txt 22 // implement new conversion functionalities on the wrap.utils pakage 23 24 25 module gio.AppInfoIF; 26 27 private import gio.AppInfo; 28 private import gio.AppInfoIF; 29 private import gio.AppLaunchContext; 30 private import gio.FileIF; 31 private import gio.Icon; 32 private import gio.IconIF; 33 private import glib.ErrorG; 34 private import glib.GException; 35 private import glib.ListG; 36 private import glib.Str; 37 private import gobject.ObjectG; 38 private import gtkc.gio; 39 public import gtkc.giotypes; 40 41 42 /** 43 * #GAppInfo and #GAppLaunchContext are used for describing and launching 44 * applications installed on the system. 45 * 46 * As of GLib 2.20, URIs will always be converted to POSIX paths 47 * (using g_file_get_path()) when using g_app_info_launch() even if 48 * the application requested an URI and not a POSIX path. For example 49 * for an desktop-file based application with Exec key `totem 50 * %U` and a single URI, `sftp://foo/file.avi`, then 51 * `/home/user/.gvfs/sftp on foo/file.avi` will be passed. This will 52 * only work if a set of suitable GIO extensions (such as gvfs 2.26 53 * compiled with FUSE support), is available and operational; if this 54 * is not the case, the URI will be passed unmodified to the application. 55 * Some URIs, such as `mailto:`, of course cannot be mapped to a POSIX 56 * path (in gvfs there's no FUSE mount for it); such URIs will be 57 * passed unmodified to the application. 58 * 59 * Specifically for gvfs 2.26 and later, the POSIX URI will be mapped 60 * back to the GIO URI in the #GFile constructors (since gvfs 61 * implements the #GVfs extension point). As such, if the application 62 * needs to examine the URI, it needs to use g_file_get_uri() or 63 * similar on #GFile. In other words, an application cannot assume 64 * that the URI passed to e.g. g_file_new_for_commandline_arg() is 65 * equal to the result of g_file_get_uri(). The following snippet 66 * illustrates this: 67 * 68 * |[ 69 * GFile *f; 70 * char *uri; 71 * 72 * file = g_file_new_for_commandline_arg (uri_from_commandline); 73 * 74 * uri = g_file_get_uri (file); 75 * strcmp (uri, uri_from_commandline) == 0; 76 * g_free (uri); 77 * 78 * if (g_file_has_uri_scheme (file, "cdda")) 79 * { 80 * // do something special with uri 81 * } 82 * g_object_unref (file); 83 * ]| 84 * 85 * This code will work when both `cdda://sr0/Track 1.wav` and 86 * `/home/user/.gvfs/cdda on sr0/Track 1.wav` is passed to the 87 * application. It should be noted that it's generally not safe 88 * for applications to rely on the format of a particular URIs. 89 * Different launcher applications (e.g. file managers) may have 90 * different ideas of what a given URI means. 91 */ 92 public interface AppInfoIF{ 93 /** Get the main Gtk struct */ 94 public GAppInfo* getAppInfoStruct(); 95 96 /** the main Gtk struct as a void* */ 97 protected void* getStruct(); 98 99 /** 100 */ 101 102 /** 103 * Creates a new #GAppInfo from the given information. 104 * 105 * Note that for @commandline, the quoting rules of the Exec key of the 106 * [freedesktop.org Desktop Entry Specification](http://freedesktop.org/Standards/desktop-entry-spec) 107 * are applied. For example, if the @commandline contains 108 * percent-encoded URIs, the percent-character must be doubled in order to prevent it from 109 * being swallowed by Exec key unquoting. See the specification for exact quoting rules. 110 * 111 * Params: 112 * commandline = the commandline to use 113 * applicationName = the application name, or %NULL to use @commandline 114 * flags = flags that can specify details of the created #GAppInfo 115 * 116 * Return: new #GAppInfo for given command. 117 * 118 * Throws: GException on failure. 119 */ 120 public static AppInfoIF createFromCommandline(string commandline, string applicationName, GAppInfoCreateFlags flags); 121 122 /** 123 * Gets a list of all of the applications currently registered 124 * on this system. 125 * 126 * For desktop files, this includes applications that have 127 * `NoDisplay=true` set or are excluded from display by means 128 * of `OnlyShowIn` or `NotShowIn`. See g_app_info_should_show(). 129 * The returned list does not include applications which have 130 * the `Hidden` key set. 131 * 132 * Return: a newly allocated #GList of references to #GAppInfos. 133 */ 134 public static ListG getAll(); 135 136 /** 137 * Gets a list of all #GAppInfos for a given content type, 138 * including the recommended and fallback #GAppInfos. See 139 * g_app_info_get_recommended_for_type() and 140 * g_app_info_get_fallback_for_type(). 141 * 142 * Params: 143 * contentType = the content type to find a #GAppInfo for 144 * 145 * Return: #GList of #GAppInfos 146 * for given @content_type or %NULL on error. 147 */ 148 public static ListG getAllForType(string contentType); 149 150 /** 151 * Gets the default #GAppInfo for a given content type. 152 * 153 * Params: 154 * contentType = the content type to find a #GAppInfo for 155 * mustSupportUris = if %TRUE, the #GAppInfo is expected to 156 * support URIs 157 * 158 * Return: #GAppInfo for given @content_type or 159 * %NULL on error. 160 */ 161 public static AppInfoIF getDefaultForType(string contentType, bool mustSupportUris); 162 163 /** 164 * Gets the default application for handling URIs with 165 * the given URI scheme. A URI scheme is the initial part 166 * of the URI, up to but not including the ':', e.g. "http", 167 * "ftp" or "sip". 168 * 169 * Params: 170 * uriScheme = a string containing a URI scheme. 171 * 172 * Return: #GAppInfo for given @uri_scheme or %NULL on error. 173 */ 174 public static AppInfoIF getDefaultForUriScheme(string uriScheme); 175 176 /** 177 * Gets a list of fallback #GAppInfos for a given content type, i.e. 178 * those applications which claim to support the given content type 179 * by MIME type subclassing and not directly. 180 * 181 * Params: 182 * contentType = the content type to find a #GAppInfo for 183 * 184 * Return: #GList of #GAppInfos 185 * for given @content_type or %NULL on error. 186 * 187 * Since: 2.28 188 */ 189 public static ListG getFallbackForType(string contentType); 190 191 /** 192 * Gets a list of recommended #GAppInfos for a given content type, i.e. 193 * those applications which claim to support the given content type exactly, 194 * and not by MIME type subclassing. 195 * Note that the first application of the list is the last used one, i.e. 196 * the last one for which g_app_info_set_as_last_used_for_type() has been 197 * called. 198 * 199 * Params: 200 * contentType = the content type to find a #GAppInfo for 201 * 202 * Return: #GList of #GAppInfos 203 * for given @content_type or %NULL on error. 204 * 205 * Since: 2.28 206 */ 207 public static ListG getRecommendedForType(string contentType); 208 209 /** 210 * Utility function that launches the default application 211 * registered to handle the specified uri. Synchronous I/O 212 * is done on the uri to detect the type of the file if 213 * required. 214 * 215 * Params: 216 * uri = the uri to show 217 * launchContext = an optional #GAppLaunchContext. 218 * 219 * Return: %TRUE on success, %FALSE on error. 220 * 221 * Throws: GException on failure. 222 */ 223 public static bool launchDefaultForUri(string uri, AppLaunchContext launchContext); 224 225 /** 226 * Removes all changes to the type associations done by 227 * g_app_info_set_as_default_for_type(), 228 * g_app_info_set_as_default_for_extension(), 229 * g_app_info_add_supports_type() or 230 * g_app_info_remove_supports_type(). 231 * 232 * Params: 233 * contentType = a content type 234 * 235 * Since: 2.20 236 */ 237 public static void resetTypeAssociations(string contentType); 238 239 /** 240 * Adds a content type to the application information to indicate the 241 * application is capable of opening files with the given content type. 242 * 243 * Params: 244 * contentType = a string. 245 * 246 * Return: %TRUE on success, %FALSE on error. 247 * 248 * Throws: GException on failure. 249 */ 250 public bool addSupportsType(string contentType); 251 252 /** 253 * Obtains the information whether the #GAppInfo can be deleted. 254 * See g_app_info_delete(). 255 * 256 * Return: %TRUE if @appinfo can be deleted 257 * 258 * Since: 2.20 259 */ 260 public bool canDelete(); 261 262 /** 263 * Checks if a supported content type can be removed from an application. 264 * 265 * Return: %TRUE if it is possible to remove supported 266 * content types from a given @appinfo, %FALSE if not. 267 */ 268 public bool canRemoveSupportsType(); 269 270 /** 271 * Tries to delete a #GAppInfo. 272 * 273 * On some platforms, there may be a difference between user-defined 274 * #GAppInfos which can be deleted, and system-wide ones which cannot. 275 * See g_app_info_can_delete(). 276 * 277 * Return: %TRUE if @appinfo has been deleted 278 * 279 * Since: 2.20 280 */ 281 public bool delet(); 282 283 /** 284 * Creates a duplicate of a #GAppInfo. 285 * 286 * Return: a duplicate of @appinfo. 287 */ 288 public AppInfoIF dup(); 289 290 /** 291 * Checks if two #GAppInfos are equal. 292 * 293 * Params: 294 * appinfo2 = the second #GAppInfo. 295 * 296 * Return: %TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise. 297 */ 298 public bool equal(AppInfoIF appinfo2); 299 300 /** 301 * Gets the commandline with which the application will be 302 * started. 303 * 304 * Return: a string containing the @appinfo's commandline, 305 * or %NULL if this information is not available 306 * 307 * Since: 2.20 308 */ 309 public string getCommandline(); 310 311 /** 312 * Gets a human-readable description of an installed application. 313 * 314 * Return: a string containing a description of the 315 * application @appinfo, or %NULL if none. 316 */ 317 public string getDescription(); 318 319 /** 320 * Gets the display name of the application. The display name is often more 321 * descriptive to the user than the name itself. 322 * 323 * Return: the display name of the application for @appinfo, or the name if 324 * no display name is available. 325 * 326 * Since: 2.24 327 */ 328 public string getDisplayName(); 329 330 /** 331 * Gets the executable's name for the installed application. 332 * 333 * Return: a string containing the @appinfo's application 334 * binaries name 335 */ 336 public string getExecutable(); 337 338 /** 339 * Gets the icon for the application. 340 * 341 * Return: the default #GIcon for @appinfo or %NULL 342 * if there is no default icon. 343 */ 344 public IconIF getIcon(); 345 346 /** 347 * Gets the ID of an application. An id is a string that 348 * identifies the application. The exact format of the id is 349 * platform dependent. For instance, on Unix this is the 350 * desktop file id from the xdg menu specification. 351 * 352 * Note that the returned ID may be %NULL, depending on how 353 * the @appinfo has been constructed. 354 * 355 * Return: a string containing the application's ID. 356 */ 357 public string getId(); 358 359 /** 360 * Gets the installed name of the application. 361 * 362 * Return: the name of the application for @appinfo. 363 */ 364 public string getName(); 365 366 /** 367 * Retrieves the list of content types that @app_info claims to support. 368 * If this information is not provided by the environment, this function 369 * will return %NULL. 370 * This function does not take in consideration associations added with 371 * g_app_info_add_supports_type(), but only those exported directly by 372 * the application. 373 * 374 * Return: a list of content types. 375 * 376 * Since: 2.34 377 */ 378 public string[] getSupportedTypes(); 379 380 /** 381 * Launches the application. Passes @files to the launched application 382 * as arguments, using the optional @launch_context to get information 383 * about the details of the launcher (like what screen it is on). 384 * On error, @error will be set accordingly. 385 * 386 * To launch the application without arguments pass a %NULL @files list. 387 * 388 * Note that even if the launch is successful the application launched 389 * can fail to start if it runs into problems during startup. There is 390 * no way to detect this. 391 * 392 * Some URIs can be changed when passed through a GFile (for instance 393 * unsupported URIs with strange formats like mailto:), so if you have 394 * a textual URI you want to pass in as argument, consider using 395 * g_app_info_launch_uris() instead. 396 * 397 * The launched application inherits the environment of the launching 398 * process, but it can be modified with g_app_launch_context_setenv() 399 * and g_app_launch_context_unsetenv(). 400 * 401 * On UNIX, this function sets the `GIO_LAUNCHED_DESKTOP_FILE` 402 * environment variable with the path of the launched desktop file and 403 * `GIO_LAUNCHED_DESKTOP_FILE_PID` to the process id of the launched 404 * process. This can be used to ignore `GIO_LAUNCHED_DESKTOP_FILE`, 405 * should it be inherited by further processes. The `DISPLAY` and 406 * `DESKTOP_STARTUP_ID` environment variables are also set, based 407 * on information provided in @launch_context. 408 * 409 * Params: 410 * files = a #GList of #GFile objects 411 * launchContext = a #GAppLaunchContext or %NULL 412 * 413 * Return: %TRUE on successful launch, %FALSE otherwise. 414 * 415 * Throws: GException on failure. 416 */ 417 public bool launch(ListG files, AppLaunchContext launchContext); 418 419 /** 420 * Launches the application. This passes the @uris to the launched application 421 * as arguments, using the optional @launch_context to get information 422 * about the details of the launcher (like what screen it is on). 423 * On error, @error will be set accordingly. 424 * 425 * To launch the application without arguments pass a %NULL @uris list. 426 * 427 * Note that even if the launch is successful the application launched 428 * can fail to start if it runs into problems during startup. There is 429 * no way to detect this. 430 * 431 * Params: 432 * uris = a #GList containing URIs to launch. 433 * launchContext = a #GAppLaunchContext or %NULL 434 * 435 * Return: %TRUE on successful launch, %FALSE otherwise. 436 * 437 * Throws: GException on failure. 438 */ 439 public bool launchUris(ListG uris, AppLaunchContext launchContext); 440 441 /** 442 * Removes a supported type from an application, if possible. 443 * 444 * Params: 445 * contentType = a string. 446 * 447 * Return: %TRUE on success, %FALSE on error. 448 * 449 * Throws: GException on failure. 450 */ 451 public bool removeSupportsType(string contentType); 452 453 /** 454 * Sets the application as the default handler for the given file extension. 455 * 456 * Params: 457 * extension = a string containing the file extension (without the dot). 458 * 459 * Return: %TRUE on success, %FALSE on error. 460 * 461 * Throws: GException on failure. 462 */ 463 public bool setAsDefaultForExtension(string extension); 464 465 /** 466 * Sets the application as the default handler for a given type. 467 * 468 * Params: 469 * contentType = the content type. 470 * 471 * Return: %TRUE on success, %FALSE on error. 472 * 473 * Throws: GException on failure. 474 */ 475 public bool setAsDefaultForType(string contentType); 476 477 /** 478 * Sets the application as the last used application for a given type. 479 * This will make the application appear as first in the list returned 480 * by g_app_info_get_recommended_for_type(), regardless of the default 481 * application for that content type. 482 * 483 * Params: 484 * contentType = the content type. 485 * 486 * Return: %TRUE on success, %FALSE on error. 487 * 488 * Throws: GException on failure. 489 */ 490 public bool setAsLastUsedForType(string contentType); 491 492 /** 493 * Checks if the application info should be shown in menus that 494 * list available applications. 495 * 496 * Return: %TRUE if the @appinfo should be shown, %FALSE otherwise. 497 */ 498 public bool shouldShow(); 499 500 /** 501 * Checks if the application accepts files as arguments. 502 * 503 * Return: %TRUE if the @appinfo supports files. 504 */ 505 public bool supportsFiles(); 506 507 /** 508 * Checks if the application supports reading files and directories from URIs. 509 * 510 * Return: %TRUE if the @appinfo supports URIs. 511 */ 512 public bool supportsUris(); 513 }