FileAttributeMatcher allows for searching through a FileInfo for attributes. More...
#include <giomm/fileinfo.h>
Public Member Functions | |
void | reference () const |
Increment the reference count for this object. | |
void | unreference () const |
Decrement the reference count for this object. | |
GFileAttributeMatcher* | gobj () |
Provides access to the underlying C instance. | |
const GFileAttributeMatcher* | gobj () const |
Provides access to the underlying C instance. | |
GFileAttributeMatcher* | gobj_copy () const |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. | |
bool | matches (const std::string& full_name) const |
Checks if an attribute will be matched by an attribute matcher. | |
bool | matches_only (const std::string& full_name) const |
Checks if a attribute matcher only matches a given attribute. | |
bool | enumerate_namespace (const std::string& ns) |
Checks if the matcher will match all of the keys in a given namespace. | |
std::string | enumerate_next () |
Gets the next matched attribute from a FileAttributeMatcher. | |
Static Public Member Functions | |
static Glib::RefPtr < FileAttributeMatcher > | create (const std::string& attributes="*") |
Creates a new file attribute matcher, which matches attributes against a given string. | |
Protected Member Functions | |
FileAttributeMatcher () | |
void | operator delete (void*, size_t) |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr < Gio::FileAttributeMatcher > | wrap (GFileAttributeMatcher* object, bool take_copy=false) |
A Glib::wrap() method for this object. |
FileAttributeMatcher allows for searching through a FileInfo for attributes.
Gio::FileAttributeMatcher::FileAttributeMatcher | ( | ) | [protected] |
static Glib::RefPtr<FileAttributeMatcher> Gio::FileAttributeMatcher::create | ( | const std::string & | attributes = "*" |
) | [static] |
Creates a new file attribute matcher, which matches attributes against a given string.
The attribute string should be formatted with specific keys separated from namespaces with a double colon. Several "namespace::key" strings may be concatenated with a single comma (e.g. "standard::type,standard::is-hidden"). The wildcard "*" may be used to match all keys and namespaces, or "namespace::*" will match all keys in a given namespace.
attributes | The attributes string. |
bool Gio::FileAttributeMatcher::enumerate_namespace | ( | const std::string & | ns | ) |
Checks if the matcher will match all of the keys in a given namespace.
This will always return true
if a wildcard character is in use (e.g. if matcher was created with "standard::*" and ns is "standard", or if matcher was created using "*" and namespace is anything.)
TODO: this is awkwardly worded.
ns | A string containing a file attribute namespace. |
true
if the matcher matches all of the entries in the given ns, false
otherwise. std::string Gio::FileAttributeMatcher::enumerate_next | ( | ) |
Gets the next matched attribute from a FileAttributeMatcher.
0
if no more attribute exist. const GFileAttributeMatcher* Gio::FileAttributeMatcher::gobj | ( | ) | const |
Provides access to the underlying C instance.
GFileAttributeMatcher* Gio::FileAttributeMatcher::gobj | ( | ) |
Provides access to the underlying C instance.
GFileAttributeMatcher* Gio::FileAttributeMatcher::gobj_copy | ( | ) | const |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
bool Gio::FileAttributeMatcher::matches | ( | const std::string & | full_name | ) | const |
Checks if an attribute will be matched by an attribute matcher.
If the matcher was created with the "*" matching string, this function will always return true
.
attribute | A file attribute key. |
true
if attribute matches matcher. false
otherwise. bool Gio::FileAttributeMatcher::matches_only | ( | const std::string & | full_name | ) | const |
Checks if a attribute matcher only matches a given attribute.
Always returns false
if "*" was used when creating the matcher.
attribute | A file attribute key. |
true
if the matcher only matches attribute. false
otherwise. void Gio::FileAttributeMatcher::operator delete | ( | void * | , | |
size_t | ||||
) | [protected] |
void Gio::FileAttributeMatcher::reference | ( | ) | const |
Increment the reference count for this object.
You should never need to do this manually - use the object via a RefPtr instead.
void Gio::FileAttributeMatcher::unreference | ( | ) | const |
Decrement the reference count for this object.
You should never need to do this manually - use the object via a RefPtr instead.
Glib::RefPtr< Gio::FileAttributeMatcher > wrap | ( | GFileAttributeMatcher * | object, | |
bool | take_copy = false | |||
) | [related] |
A Glib::wrap() method for this object.
object | The C instance. | |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |