Paul Davis
a73d15e989
git-svn-id: svn://localhost/ardour2/branches/3.0@5306 d708f5d6-7413-0410-9779-e7cbd77b26cf
146 lines
5.0 KiB
C++
146 lines
5.0 KiB
C++
// -*- c++ -*-
|
|
// Generated by gtkmmproc -- DO NOT MODIFY!
|
|
#ifndef _GIOMM_FILEATTRIBUTEINFOLIST_H
|
|
#define _GIOMM_FILEATTRIBUTEINFOLIST_H
|
|
|
|
|
|
#include <glibmm.h>
|
|
|
|
// -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
|
|
/* Copyright (C) 2007 The gtkmm Development Team
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Library General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 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
|
|
* Library General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Library General Public
|
|
* License along with this library; if not, write to the Free
|
|
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
|
*/
|
|
|
|
#include <giomm/fileattributeinfo.h>
|
|
|
|
|
|
namespace Gio
|
|
{
|
|
|
|
/** Key-Value paired file attributes.
|
|
* File attributes in GIO consist of a list of key-value pairs.
|
|
*
|
|
* Keys are strings that contain a key namespace and a key name, separated by a colon, e.g. "namespace:keyname".
|
|
* Namespaces are included to sort key-value pairs by namespaces for relevance. Keys can be retreived using wildcards,
|
|
* e.g. "standard::*" will return all of the keys in the "standard" namespace.
|
|
*
|
|
* Values are stored within the list in Gio::FileAttributeValue structures. Values can store different types, listed in the enum
|
|
* Gio::FileAttributeType. Upon creation of a Gio::FileAttributeValue, the type will be set to Gio::FILE_ATTRIBUTE_TYPE_INVALID.
|
|
*
|
|
* The list of possible attributes for a filesystem (pointed to by a Gio::File) is availible as a Gio::FileAttributeInfoList.
|
|
* This list is queryable by key names as indicated earlier.
|
|
*
|
|
* Classes that implement Gio::FileIface will create a Gio::FileAttributeInfoList and install default keys and values for their given file
|
|
* system, architecture, and other possible implementation details (e.g., on a UNIX system, a file attribute key will be registered for
|
|
* the user id for a given file).
|
|
*
|
|
* See http://library.gnome.org/devel/gio/unstable/gio-GFileAttribute.html for the list of default namespaces and the list of default keys.
|
|
*
|
|
* @newin2p16
|
|
*/
|
|
class FileAttributeInfoList
|
|
{
|
|
public:
|
|
#ifndef DOXYGEN_SHOULD_SKIP_THIS
|
|
typedef FileAttributeInfoList CppObjectType;
|
|
typedef GFileAttributeInfoList BaseObjectType;
|
|
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
|
|
|
|
static Glib::RefPtr<FileAttributeInfoList> create();
|
|
|
|
// For use with Glib::RefPtr<> only.
|
|
void reference() const;
|
|
void unreference() const;
|
|
|
|
///Provides access to the underlying C instance.
|
|
GFileAttributeInfoList* gobj();
|
|
|
|
///Provides access to the underlying C instance.
|
|
const GFileAttributeInfoList* gobj() const;
|
|
|
|
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
|
|
GFileAttributeInfoList* gobj_copy() const;
|
|
|
|
protected:
|
|
// Do not derive this. Gio::FileAttributeInfoList can neither be constructed nor deleted.
|
|
FileAttributeInfoList();
|
|
void operator delete(void*, size_t);
|
|
|
|
private:
|
|
// noncopyable
|
|
FileAttributeInfoList(const FileAttributeInfoList&);
|
|
FileAttributeInfoList& operator=(const FileAttributeInfoList&);
|
|
|
|
|
|
public:
|
|
|
|
/** Whether the FileAttributeInfoList is valid and non empty.
|
|
* @result true if this FileAttributeInfoList is not empty.
|
|
*/
|
|
operator bool() const;
|
|
|
|
/** Whether the FileAttributeInfoList is empty or invalid.
|
|
* @result true if this FileAttributeInfoList is empty.
|
|
*/
|
|
bool empty() const;
|
|
|
|
/** Gets the file attribute with the name name from list.
|
|
* @param name The name of the attribute to lookup.
|
|
* @result A FileAttributeInfo for the name.
|
|
*/
|
|
FileAttributeInfo lookup(const std::string& name) const;
|
|
|
|
|
|
/** Makes a duplicate of a file attribute info list.
|
|
* @return A copy of the given @a list.
|
|
*/
|
|
Glib::RefPtr<FileAttributeInfoList> dup() const;
|
|
|
|
|
|
/** Adds a new attribute with @a name to the @a list, setting
|
|
* its @a type and @a flags.
|
|
* @param name The name of the attribute to add.
|
|
* @param type The FileAttributeType for the attribute.
|
|
* @param flags FileAttributeInfoFlags for the attribute.
|
|
*/
|
|
void add(const std::string& name, FileAttributeType type, FileAttributeInfoFlags flags = FILE_ATTRIBUTE_INFO_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::FileAttributeInfoList
|
|
*/
|
|
Glib::RefPtr<Gio::FileAttributeInfoList> wrap(GFileAttributeInfoList* object, bool take_copy = false);
|
|
|
|
} // namespace Glib
|
|
|
|
|
|
#endif /* _GIOMM_FILEATTRIBUTEINFOLIST_H */
|
|
|