/usr/include/giomm-2.4/giomm/resource.h is in libglibmm-2.4-dev 2.56.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 | // Generated by gmmproc 2.54.1 -- DO NOT MODIFY!
#ifndef _GIOMM_RESOURCE_H
#define _GIOMM_RESOURCE_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
/* Copyright (C) 2012 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, see <http://www.gnu.org/licenses/>.
*/
#include <glibmm/error.h>
#include <glibmm/refptr.h>
#include <glibmm/bytes.h>
#include <giomm/inputstream.h>
#include <vector>
#include <string>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GResource GResource;
#endif
namespace Gio
{
/** %Exception class for resource file handling errors.
*
* @newin{2,34}
*/
class ResourceError : public Glib::Error
{
public:
/** @var Code NOT_FOUND
* No file was found at the requested path.
*
* @var Code INTERNAL
* Unknown error.
*
* @enum Code
*
* An error code used with G_RESOURCE_ERROR in a Error returned
* from a Resource routine.
*
* @newin{2,34}
*/
enum Code
{
NOT_FOUND,
INTERNAL
};
ResourceError(Code error_code, const Glib::ustring& error_message);
explicit ResourceError(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
};
/** @addtogroup giommEnums giomm Enums and Flags */
/**
* @var ResourceFlags RESOURCE_FLAGS_NONE
* No flags set.
*
* @var ResourceFlags RESOURCE_FLAGS_COMPRESSED
* The file is compressed.
*
* @enum ResourceFlags
*
* GResourceFlags give information about a particular file inside a resource
* bundle.
*
* @newin{2,44}
*
* @ingroup giommEnums
* @par Bitwise operators:
* <tt>%ResourceFlags operator|(ResourceFlags, ResourceFlags)</tt><br>
* <tt>%ResourceFlags operator&(ResourceFlags, ResourceFlags)</tt><br>
* <tt>%ResourceFlags operator^(ResourceFlags, ResourceFlags)</tt><br>
* <tt>%ResourceFlags operator~(ResourceFlags)</tt><br>
* <tt>%ResourceFlags& operator|=(ResourceFlags&, ResourceFlags)</tt><br>
* <tt>%ResourceFlags& operator&=(ResourceFlags&, ResourceFlags)</tt><br>
* <tt>%ResourceFlags& operator^=(ResourceFlags&, ResourceFlags)</tt><br>
*/
enum ResourceFlags
{
RESOURCE_FLAGS_NONE = 0x0,
RESOURCE_FLAGS_COMPRESSED = (1<<0)
};
/** @ingroup giommEnums */
inline ResourceFlags operator|(ResourceFlags lhs, ResourceFlags rhs)
{ return static_cast<ResourceFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline ResourceFlags operator&(ResourceFlags lhs, ResourceFlags rhs)
{ return static_cast<ResourceFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline ResourceFlags operator^(ResourceFlags lhs, ResourceFlags rhs)
{ return static_cast<ResourceFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline ResourceFlags operator~(ResourceFlags flags)
{ return static_cast<ResourceFlags>(~static_cast<unsigned>(flags)); }
/** @ingroup giommEnums */
inline ResourceFlags& operator|=(ResourceFlags& lhs, ResourceFlags rhs)
{ return (lhs = static_cast<ResourceFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline ResourceFlags& operator&=(ResourceFlags& lhs, ResourceFlags rhs)
{ return (lhs = static_cast<ResourceFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline ResourceFlags& operator^=(ResourceFlags& lhs, ResourceFlags rhs)
{ return (lhs = static_cast<ResourceFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
} // namespace Gio
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gio::ResourceFlags> : public Glib::Value_Flags<Gio::ResourceFlags>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{
/**
* @var ResourceLookupFlags RESOURCE_LOOKUP_FLAGS_NONE
* No flags set.
*
* @enum ResourceLookupFlags
*
* GResourceLookupFlags determine how resource path lookups are handled.
*
* @newin{2,44}
*
* @ingroup giommEnums
* @par Bitwise operators:
* <tt>%ResourceLookupFlags operator|(ResourceLookupFlags, ResourceLookupFlags)</tt><br>
* <tt>%ResourceLookupFlags operator&(ResourceLookupFlags, ResourceLookupFlags)</tt><br>
* <tt>%ResourceLookupFlags operator^(ResourceLookupFlags, ResourceLookupFlags)</tt><br>
* <tt>%ResourceLookupFlags operator~(ResourceLookupFlags)</tt><br>
* <tt>%ResourceLookupFlags& operator|=(ResourceLookupFlags&, ResourceLookupFlags)</tt><br>
* <tt>%ResourceLookupFlags& operator&=(ResourceLookupFlags&, ResourceLookupFlags)</tt><br>
* <tt>%ResourceLookupFlags& operator^=(ResourceLookupFlags&, ResourceLookupFlags)</tt><br>
*/
enum ResourceLookupFlags
{
RESOURCE_LOOKUP_FLAGS_NONE = 0x0
};
/** @ingroup giommEnums */
inline ResourceLookupFlags operator|(ResourceLookupFlags lhs, ResourceLookupFlags rhs)
{ return static_cast<ResourceLookupFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline ResourceLookupFlags operator&(ResourceLookupFlags lhs, ResourceLookupFlags rhs)
{ return static_cast<ResourceLookupFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline ResourceLookupFlags operator^(ResourceLookupFlags lhs, ResourceLookupFlags rhs)
{ return static_cast<ResourceLookupFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline ResourceLookupFlags operator~(ResourceLookupFlags flags)
{ return static_cast<ResourceLookupFlags>(~static_cast<unsigned>(flags)); }
/** @ingroup giommEnums */
inline ResourceLookupFlags& operator|=(ResourceLookupFlags& lhs, ResourceLookupFlags rhs)
{ return (lhs = static_cast<ResourceLookupFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline ResourceLookupFlags& operator&=(ResourceLookupFlags& lhs, ResourceLookupFlags rhs)
{ return (lhs = static_cast<ResourceLookupFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline ResourceLookupFlags& operator^=(ResourceLookupFlags& lhs, ResourceLookupFlags rhs)
{ return (lhs = static_cast<ResourceLookupFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
} // namespace Gio
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gio::ResourceLookupFlags> : public Glib::Value_Flags<Gio::ResourceLookupFlags>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{
/** %Resource framework.
*
* Applications and libraries often contain binary or textual data that is
* really part of the application, rather than user data. For instance
* Gtk::Builder .ui files, splashscreen images, Gio::Menu markup xml, CSS files,
* icons, etc. These are often shipped as files in `$datadir/appname`, or
* manually included as literal strings in the code.
*
* The Gio::Resource API and the <tt>glib-compile-resources</tt> program
* provide a convenient and efficient alternative to this which has some nice properties. You
* maintain the files as normal files, so it's easy to edit them, but during the build the files
* are combined into a binary bundle that is linked into the executable. This means that loading
* the resource files is efficient (as they are already in memory, shared with other instances) and
* simple (no need to check for things like I/O errors or locate the files in the filesystem). It
* also makes it easier to create relocatable applications.
*
* %Resource files can also be marked as compressed. Such files will be included in the resource bundle
* in a compressed form, but will be automatically uncompressed when the resource is used. This
* is very useful e.g. for larger text files that are parsed once (or rarely) and then thrown away.
*
* %Resource files can also be marked to be preprocessed, by setting the value of the
* `preprocess` attribute to a comma-separated list of preprocessing options.
* The only options currently supported are:
*
* <dl>
* <dt>xml-stripblanks</dt>
* <dd>which will use the <tt>xmllint</tt> command
* to strip ignorable whitespace from the xml file. For this to work,
* the `XMLLINT` environment variable must be set to the full path to
* the <tt>xmllint</tt> executable, or <tt>xmllint</tt> must be in the `PATH`; otherwise
* the preprocessing step is skipped.</dd>
*
* <dt>to-pixdata</dt>
* <dd>which will use the <tt>gdk-pixbuf-pixdata</tt> command to convert
* images to the GdkPixdata format, which allows you to create pixbufs directly using the data inside
* the resource file, rather than an (uncompressed) copy of it. For this, the <tt>gdk-pixbuf-pixdata</tt>
* program must be in the PATH, or the `GDK_PIXBUF_PIXDATA` environment variable must be
* set to the full path to the <tt>gdk-pixbuf-pixdata</tt> executable; otherwise the resource compiler will
* abort.</dd>
* </dl>
*
* %Resource bundles are created by the <tt>glib-compile-resources</tt> program
* which takes an xml file that describes the bundle, and a set of files that the xml references. These
* are combined into a binary resource bundle.
*
* An example resource description:
* @code
* <?xml version="1.0" encoding="UTF-8"?>
* <gresources>
* <gresource prefix="/org/gtk/Example">
* <file>data/splashscreen.png</file>
* <file compressed="true">dialog.ui</file>
* <file preprocess="xml-stripblanks">menumarkup.xml</file>
* </gresource>
* </gresources>
* @endcode
*
* This will create a resource bundle with the following files:
* @code
* /org/gtk/Example/data/splashscreen.png
* /org/gtk/Example/dialog.ui
* /org/gtk/Example/menumarkup.xml
* @endcode
*
* Note that all resources in the process share the same namespace, so use java-style
* path prefixes (like in the above example) to avoid conflicts.
*
* You can then use <tt>glib-compile-resources</tt> to compile the xml to a binary bundle
* that you can load with Gio::Resource::create_from_file(). However, it's more common to use the --generate-source and
* --generate-header arguments to create a source file and header to link directly into your application.
*
* Once a Gio::Resource has been created and registered all the data in it can be accessed globally in the process by
* using API calls like Gio::Resource::open_stream_from_global_resources() to stream the data
* or Gio::Resource::lookup_data_in_global_resources() to get a direct pointer
* to the data. You can also use uris like "resource:///org/gtk/Example/data/splashscreen.png" with Gio::File to access
* the resource data.
*
* There are two forms of the generated source, the default version uses the compiler support for constructor
* and destructor functions (where available) to automatically create and register the Gio::Resource on startup
* or library load time. If you pass --manual-register, two functions to register/unregister the resource is instead
* created. This requires an explicit initialization call in your application/library, but it works on all platforms,
* even on the minor ones where this is not available. (Constructor support is available for at least Win32, MacOS and Linux.)
*
* Note that resource data can point directly into the data segment of e.g. a library, so if you are unloading libraries
* during runtime you need to be very careful with keeping around pointers to data from a resource, as this goes away
* when the library is unloaded. However, in practice this is not generally a problem, since most resource accesses
* is for your own resources, and resource data is often used once, during parsing, and then released.
*
* @newin{2,44}
*/
class Resource final
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
using CppObjectType = Resource;
using BaseObjectType = GResource;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
/** Increment the reference count for this object.
* You should never need to do this manually - use the object via a RefPtr instead.
*/
void reference() const;
/** Decrement the reference count for this object.
* You should never need to do this manually - use the object via a RefPtr instead.
*/
void unreference() const;
///Provides access to the underlying C instance.
GResource* gobj();
///Provides access to the underlying C instance.
const GResource* gobj() const;
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GResource* gobj_copy() const;
Resource() = delete;
// noncopyable
Resource(const Resource&) = delete;
Resource& operator=(const Resource&) = delete;
protected:
// Do not derive this. Gio::Resource can neither be constructed nor deleted.
void operator delete(void*, std::size_t);
private:
public:
/** Creates a GResource from a reference to the binary resource bundle.
* This will keep a reference to @a data while the resource lives, so
* the data should not be modified or freed.
*
* If you want to use this resource in the global resource namespace you need
* to register it with g_resources_register().
*
* @note @a data must be backed by memory that is at least pointer aligned.
* Otherwise this function will internally create a copy of the memory since
* GLib 2.56, or in older versions fail and exit the process.
*
* @newin{2,44}
*
* @param data A Bytes.
* @return A new Resource, or <tt>nullptr</tt> on error.
*
* @throws Glib::Error
*/
static Glib::RefPtr<Resource> create_from_data(const Glib::RefPtr<const Glib::Bytes>& data);
/** Loads a binary resource bundle and creates a Resource representation of it, allowing
* you to query it for data.
*
* If you want to use this resource in the global resource namespace you need
* to register it with g_resources_register().
*
* @newin{2,44}
*
* @param filename The path of a filename to load, in the GLib filename encoding.
* @return A new Resource, or <tt>nullptr</tt> on error.
*
* @throws Glib::Error
*/
static Glib::RefPtr<Resource> create_from_file(const std::string& filename);
/** Looks for a file at the specified @a path in the resource and
* returns a InputStream that lets you read the data.
*
* @a lookup_flags controls the behaviour of the lookup.
*
* @newin{2,44}
*
* @param path A pathname inside the resource.
* @param lookup_flags A ResourceLookupFlags.
* @return InputStream or <tt>nullptr</tt> on error.
* Free the returned object with Glib::object_unref().
*
* @throws Glib::Error
*/
Glib::RefPtr<InputStream> open_stream(const std::string& path, ResourceLookupFlags lookup_flags = RESOURCE_LOOKUP_FLAGS_NONE) const;
/** Looks for a file at the specified @a path in the resource and
* returns a Bytes that lets you directly access the data in
* memory.
*
* The data is always followed by a zero byte, so you
* can safely use the data as a C string. However, that byte
* is not included in the size of the GBytes.
*
* For uncompressed resource files this is a pointer directly into
* the resource bundle, which is typically in some readonly data section
* in the program binary. For compressed files we allocate memory on
* the heap and automatically uncompress the data.
*
* @a lookup_flags controls the behaviour of the lookup.
*
* @newin{2,44}
*
* @param path A pathname inside the resource.
* @param lookup_flags A ResourceLookupFlags.
* @return Bytes or <tt>nullptr</tt> on error.
* Free the returned object with Glib::bytes_unref().
*
* @throws Glib::Error
*/
Glib::RefPtr<const Glib::Bytes> lookup_data(const std::string& path, ResourceLookupFlags lookup_flags = RESOURCE_LOOKUP_FLAGS_NONE) const;
/** Returns all the names of children at the specified @a path in the resource.
*
* If @a path is invalid or does not exist in the Resource,
* RESOURCE_ERROR_NOT_FOUND will be returned.
*
* @a lookup_flags controls the behaviour of the lookup.
*
* @newin{2,44}
*
* @param path A pathname inside the resource.
* @param lookup_flags A ResourceLookupFlags.
* @return An array of constant strings.
*
* @throws Glib::Error
*/
std::vector<std::string> enumerate_children(const std::string& path, ResourceLookupFlags lookup_flags = RESOURCE_LOOKUP_FLAGS_NONE) const;
/** Looks for a file at the specified @a path in the resource and
* if found returns information about it.
*
* @a lookup_flags controls the behaviour of the lookup.
*
* @newin{2,44}
*
* @param path A pathname inside the resource.
* @param[out] size A location to place the length of the contents of the file.
* @param[out] flags A location to place the flags about the file.
* @param lookup_flags A ResourceLookupFlags.
* @throw Gio::ResourceError if the file was not found.
*/
void get_info(const std::string& path, gsize& size, ResourceFlags& flags, ResourceLookupFlags lookup_flags = RESOURCE_LOOKUP_FLAGS_NONE) const;
/** Looks for a file at the specified @a path in the resource.
*
* @a lookup_flags controls the behaviour of the lookup.
*
* @newin{2,44}
*
* @param path A pathname inside the resource.
* @param lookup_flags A ResourceLookupFlags.
* @throw Gio::ResourceError if the file was not found.
*/
void get_file_exists(const std::string& path, ResourceLookupFlags lookup_flags = RESOURCE_LOOKUP_FLAGS_NONE) const;
/** Looks for a file at the specified @a path in the resource.
*
* @a lookup_flags controls the behaviour of the lookup.
* This method returns a <tt>bool</tt> instead of throwing in exception in case of errors.
*
* @newin{2,44}
*
* @param path A pathname inside the resource.
* @param lookup_flags A ResourceLookupFlags.
* @return <tt>true</tt> if the file was found, <tt>false</tt> if there were errors.
*/
bool get_file_exists_nothrow(const std::string& path, ResourceLookupFlags lookup_flags = RESOURCE_LOOKUP_FLAGS_NONE) const;
// 'register' is a keyword. Can't be the name of a method.
/** Registers the resource with the process-global set of resources.
* Once a resource is registered the files in it can be accessed
* with the global resource lookup functions like g_resources_lookup_data().
*
* @newin{2,44}
*/
void register_global();
/** Unregisters the resource from the process-global set of resources.
*
* @newin{2,44}
*/
void unregister_global();
/** Looks for a file at the specified @a path in the set of
* globally registered resources and returns a InputStream
* that lets you read the data.
*
* @a lookup_flags controls the behaviour of the lookup.
*
* @newin{2,44}
*
* @param path A pathname inside the resource.
* @param lookup_flags A ResourceLookupFlags.
* @return InputStream or <tt>nullptr</tt> on error.
* Free the returned object with Glib::object_unref().
*
* @throws Glib::Error
*/
static Glib::RefPtr<InputStream> open_stream_global(const std::string& path, ResourceLookupFlags lookup_flags = RESOURCE_LOOKUP_FLAGS_NONE);
/** Looks for a file at the specified @a path in the set of
* globally registered resources and returns a Bytes that
* lets you directly access the data in memory.
*
* The data is always followed by a zero byte, so you
* can safely use the data as a C string. However, that byte
* is not included in the size of the GBytes.
*
* For uncompressed resource files this is a pointer directly into
* the resource bundle, which is typically in some readonly data section
* in the program binary. For compressed files we allocate memory on
* the heap and automatically uncompress the data.
*
* @a lookup_flags controls the behaviour of the lookup.
*
* @newin{2,44}
*
* @param path A pathname inside the resource.
* @param lookup_flags A ResourceLookupFlags.
* @return Bytes or <tt>nullptr</tt> on error.
* Free the returned object with Glib::bytes_unref().
*
* @throws Glib::Error
*/
static Glib::RefPtr<const Glib::Bytes> lookup_data_global(const std::string& path, ResourceLookupFlags lookup_flags = RESOURCE_LOOKUP_FLAGS_NONE);
/** Returns all the names of children at the specified @a path in the set of
* globally registered resources.
*
* @a lookup_flags controls the behaviour of the lookup.
*
* @newin{2,44}
*
* @param path A pathname inside the resource.
* @param lookup_flags A ResourceLookupFlags.
* @return An array of constant strings.
*
* @throws Glib::Error
*/
static std::vector<std::string> enumerate_children_global(const std::string& path, ResourceLookupFlags lookup_flags = RESOURCE_LOOKUP_FLAGS_NONE);
/** Looks for a file at the specified @a path in the set of
* globally registered resources and if found returns information about it.
*
* @a lookup_flags controls the behaviour of the lookup.
*
* @newin{2,44}
*
* @param path A pathname inside the resource.
* @param[out] size A location to place the length of the contents of the file.
* @param[out] flags A location to place the flags about the file.
* @param lookup_flags A ResourceLookupFlags.
* @throw Gio::ResourceError if the file was not found.
*/
static void get_info_global(const std::string& path, gsize& size, ResourceFlags& flags, ResourceLookupFlags lookup_flags = RESOURCE_LOOKUP_FLAGS_NONE);
/** Looks for a file at the specified @a path in the set of
* globally registered resources.
*
* @a lookup_flags controls the behaviour of the lookup.
*
* @newin{2,44}
*
* @param path A pathname inside the resource.
* @param lookup_flags A ResourceLookupFlags.
* @throw Gio::ResourceError if the file was not found.
*/
static void get_file_exists_global(const std::string& path, ResourceLookupFlags lookup_flags = RESOURCE_LOOKUP_FLAGS_NONE);
/** Looks for a file at the specified @a path in the set of
* globally registered resources.
*
* @a lookup_flags controls the behaviour of the lookup.
* This method returns a <tt>bool</tt> instead of throwing in exception in case of errors.
*
* @newin{2,44}
*
* @param path A pathname inside the resource.
* @param lookup_flags A ResourceLookupFlags.
* @return <tt>true</tt> if the file was found, <tt>false</tt> if there were errors.
*/
static bool get_file_exists_global_nothrow(const std::string& path, ResourceLookupFlags lookup_flags = RESOURCE_LOOKUP_FLAGS_NONE);
};
} // namespace Gio
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gio::Resource
*/
Glib::RefPtr<Gio::Resource> wrap(GResource* object, bool take_copy = false);
} // namespace Glib
#endif /* _GIOMM_RESOURCE_H */
|