#include <tdefilemetainfo.h>
Public Member Functions | |
KFileMetaInfoGroup (const TQString &name, const KFileMimeTypeInfo *info) | |
KFileMetaInfoGroup (const KFileMetaInfoGroup &original) | |
const KFileMetaInfoGroup & | operator= (const KFileMetaInfoGroup &info) |
KFileMetaInfoGroup () | |
bool | isValid () const |
bool | isEmpty () const |
bool | isModified () const |
KFileMetaInfoItem | operator[] (const TQString &key) const |
KFileMetaInfoItem | item (const TQString &key) const |
KFileMetaInfoItem | item (uint hint) const |
const TQVariant | value (const TQString &key) const |
TQStringList | supportedKeys () const |
bool | supportsVariableKeys () const |
bool | contains (const TQString &key) const |
TQStringList | keys () const |
TQStringList | preferredKeys () const |
KFileMetaInfoItem | addItem (const TQString &key) |
bool | removeItem (const TQString &key) |
TQStringList | removedItems () |
TQString | name () const |
TQString | translatedName () const |
uint | attributes () const |
Protected Member Functions | |
void | setAdded () |
KFileMetaInfoItem | appendItem (const TQString &key, const TQVariant &value) |
void | ref () |
void | deref () |
Protected Attributes | |
Data * | d |
Friends | |
class | KFilePlugin |
class | KFileMetaInfo |
TDEIO_EXPORT friend TQDataStream & | operator>> (TQDataStream &s, KFileMetaInfoGroup &) |
TDEIO_EXPORT friend TQDataStream & | operator<< (TQDataStream &s, const KFileMetaInfoGroup &) |
Detailed Description
A group of meta information items about a file.
This is one group of meta information items about a file (see KFileMetaInfo).
Definition at line 684 of file tdefilemetainfo.h.
Constructor & Destructor Documentation
◆ KFileMetaInfoGroup() [1/2]
KFileMetaInfoGroup::KFileMetaInfoGroup | ( | const KFileMetaInfoGroup & | original | ) |
Copy constructor.
Definition at line 1184 of file tdefilemetainfo.cpp.
◆ KFileMetaInfoGroup() [2/2]
KFileMetaInfoGroup::KFileMetaInfoGroup | ( | ) |
Default constructor.
This creates an "invalid" item
- Since
- 3.1
Definition at line 1191 of file tdefilemetainfo.cpp.
Member Function Documentation
◆ addItem()
KFileMetaInfoItem KFileMetaInfoGroup::addItem | ( | const TQString & | key | ) |
Add an item to the info.
- Returns
- the list of possible types that the value for the specified key can be. You can use this to determine the possible types for new keys before you add them. This is only possible if the specified
key
is in the supportedKeys list and not yet defined or if the group supports variable keys.
- Parameters
-
key the key of the item
- Returns
- the KFileMetaInfoItem for the given
key
Definition at line 1356 of file tdefilemetainfo.cpp.
◆ attributes()
uint KFileMetaInfoGroup::attributes | ( | ) | const |
Returns the attributes of this item.
- Returns
- the attributes
Definition at line 1319 of file tdefilemetainfo.cpp.
◆ contains()
bool KFileMetaInfoGroup::contains | ( | const TQString & | key | ) | const |
Checks whether an item with the given key
exists.
- Returns
- true if an item for this
key
exists.
Definition at line 1289 of file tdefilemetainfo.cpp.
◆ isEmpty()
bool KFileMetaInfoGroup::isEmpty | ( | ) | const |
Returns false if the object contains data, true if it's empty.
An empty group is a group with no items (amazing, isn't it?).
- Returns
- true if empty, false otherwise
Definition at line 1220 of file tdefilemetainfo.cpp.
◆ isModified()
bool KFileMetaInfoGroup::isModified | ( | ) | const |
Returns true if an item as added or removed from the group.
- Returns
- true if an item was added or removed from the group, otherwise false.
- Since
- 3.1
Definition at line 1330 of file tdefilemetainfo.cpp.
◆ isValid()
bool KFileMetaInfoGroup::isValid | ( | ) | const |
Returns true if the item is valid, i.e.
if it contains data, false if it's invalid (created with the default constructor and not been assigned anything), or if KFileMetaInfoGroup::item() didn't find your requested item).
- Returns
- true if valid, false if invalid
Definition at line 1214 of file tdefilemetainfo.cpp.
◆ item() [1/2]
KFileMetaInfoItem KFileMetaInfoGroup::item | ( | const TQString & | key | ) | const |
This method searches for the specified item.
- Parameters
-
key the key of the item to search
- Returns
- the specified item if found, an invalid item, if not
Definition at line 1294 of file tdefilemetainfo.cpp.
◆ item() [2/2]
KFileMetaInfoItem KFileMetaInfoGroup::item | ( | uint | hint | ) | const |
Returns the item with the given hint
.
- Parameters
-
hint the hint of the item
- Returns
- the item with the specified
hint
Definition at line 1303 of file tdefilemetainfo.cpp.
◆ keys()
TQStringList KFileMetaInfoGroup::keys | ( | ) | const |
Returns a list of all keys.
- Returns
- a list of all keys in the order they were inserted.
Definition at line 1253 of file tdefilemetainfo.cpp.
◆ name()
TQString KFileMetaInfoGroup::name | ( | ) | const |
The name of this group.
- Returns
- the name of this group
Definition at line 1314 of file tdefilemetainfo.cpp.
◆ operator=()
const KFileMetaInfoGroup & KFileMetaInfoGroup::operator= | ( | const KFileMetaInfoGroup & | info | ) |
The assignment operator, so you can do:
This will create a shared copy of the object. The actual data is automatically deleted if all copies go out of scope
Definition at line 1201 of file tdefilemetainfo.cpp.
◆ operator[]()
|
inline |
Operator for convenience.
It does the same as item(), but you cannot specify a group to search in
Definition at line 758 of file tdefilemetainfo.h.
◆ preferredKeys()
TQStringList KFileMetaInfoGroup::preferredKeys | ( | ) | const |
Returns a list of all keys in preference order.
- Returns
- a list of all keys in preference order.
Definition at line 1225 of file tdefilemetainfo.cpp.
◆ removedItems()
TQStringList KFileMetaInfoGroup::removedItems | ( | ) |
Returns a list of all removed items.
- Returns
- a list of all removed items
Definition at line 1418 of file tdefilemetainfo.cpp.
◆ removeItem()
bool KFileMetaInfoGroup::removeItem | ( | const TQString & | key | ) |
Remove this item from the meta info of the file.
You cannot query KFileMetaInfo for a removed object, but you can query for a list of removed items with removedItems() if you need to. If you re-add it, its value will be cleared.
- Parameters
-
key the key of the removed item
- Returns
- true if successful, false otherwise
Definition at line 1390 of file tdefilemetainfo.cpp.
◆ supportedKeys()
TQStringList KFileMetaInfoGroup::supportedKeys | ( | ) | const |
Use this method to get a list of keys in the specified group that the plugin knows about.
No variable keys. For a group that doesn't support variable keys, all keys that this group may have are returned. For a group that does support them, the non-variable ones are returned. See KFileMetaInfo about variable keys
- Returns
- the list of keys supported for this mimetype
Definition at line 1277 of file tdefilemetainfo.cpp.
◆ supportsVariableKeys()
bool KFileMetaInfoGroup::supportsVariableKeys | ( | ) | const |
Returns true if this group supports adding or removing arbitrary keys, false if not.
- Returns
- true is variable keys are supported, false otherwise
Definition at line 1283 of file tdefilemetainfo.cpp.
◆ translatedName()
TQString KFileMetaInfoGroup::translatedName | ( | ) | const |
The translated name of this group.
- Returns
- the translated name of this group
- Since
- 3.2
Definition at line 1271 of file tdefilemetainfo.cpp.
◆ value()
|
inline |
Convenience function.
Returns the value of the specified key. It does the same as item(key).value().
- Parameters
-
key the key of the item to search
- Returns
- the value with the given key
Definition at line 784 of file tdefilemetainfo.h.
The documentation for this class was generated from the following files: