• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • tdeio/tdeio
 

tdeio/tdeio

Classes | Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Friends | List of all members
KFileMimeTypeInfo Class Reference

#include <tdefilemetainfo.h>

Classes

class  GroupInfo
 
class  ItemInfo
 

Public Types

enum  Attributes {
  Addable = 1 , Removable = 2 , Modifiable = 4 , Cumulative = 8 ,
  Cummulative = Cumulative , Averaged = 16 , MultiLine = 32 , SqueezeText = 64
}
 
enum  Hint {
  NoHint = 0 , Name = 1 , Author = 2 , Description = 3 ,
  Width = 4 , Height = 5 , Size = 6 , Bitrate = 7 ,
  Length = 8 , Hidden = 9 , Thumbnail = 10
}
 
enum  Unit {
  NoUnit = 0 , Seconds = 1 , MilliSeconds = 2 , BitsPerSecond = 3 ,
  Pixels = 4 , Inches = 5 , Centimeters = 6 , Bytes = 7 ,
  FramesPerSecond = 8 , DotsPerInch = 9 , BitsPerPixel = 10 , Hertz = 11 ,
  KiloBytes = 12 , Millimeters = 13
}
 

Public Member Functions

TQValidator * createValidator (const TQString &group, const TQString &key, TQObject *parent=0, const char *name=0) const
 
TQStringList supportedGroups () const
 
TQStringList translatedGroups () const
 
TQStringList preferredGroups () const
 
TQString mimeType () const
 
const GroupInfo * groupInfo (const TQString &group) const
 
TQStringList supportedKeys () const
 
TQStringList preferredKeys () const
 
GroupInfo * addGroupInfo (const TQString &name, const TQString &translatedName)
 

Public Attributes

TQString m_translatedName
 
TQStringList m_supportedKeys
 
uint m_attr
 
TQDict< ItemInfo > m_itemDict
 

Protected Member Functions

 KFileMimeTypeInfo (const TQString &mimeType)
 

Protected Attributes

TQDict< GroupInfo > m_groups
 
TQString m_mimeType
 
TQStringList m_preferredKeys
 
TQStringList m_preferredGroups
 

Friends

class KFilePlugin
 
class KFileMetaInfoProvider
 

Detailed Description

Represents the capabilities of a KFilePlugin for a given mimetype.

This class provides information about the capabilities that a KFilePlugin for a given mimetype has. It includes a list of metainfo groups and items together with their type, a prefix, suffix and some other information about how to use, display or edit the items.

Author
Rolf Magnus
Carsten Pfeiffer

Definition at line 50 of file tdefilemetainfo.h.

Member Enumeration Documentation

◆ Attributes

enum KFileMimeTypeInfo::Attributes

This enum is used to specify some attributes that an item can have, which fit neither in the Hint nor in the Unit enum.

Enumerator
Addable 

The item or group can be added by a user.

Removable 

It can be removed.

Modifiable 

The value can be edited (no meaning for a group)

Cumulative 

If an application wants to display information for more than one file, it may add up the values for this item (e.g.

play time of an mp3 file)

Cummulative 
Deprecated:
Use Cumulative instead
Averaged 

Similar to Cumulative, but the average should be calculated instead of the sum.

MultiLine 

This attribute says that a string item is likely to be more than one line long, so for editing, a widget capable for multline text should be used.

Since
3.1
SqueezeText 

If the text for this item is very long, it should be squeezed to the size of the widget where it's displayed.

Since
3.1

Definition at line 64 of file tdefilemetainfo.h.

◆ Hint

enum KFileMimeTypeInfo::Hint

This enum is mainly for items that have a special meaning for some applications.

Enumerator
NoHint 

No hint.

Name 

The name or title of the document.

Author 

The one who created the contents of it.

Description 

Description Some information about the document.

Width 

The width in pixels.

Height 

The height in pixels.

Size 

The size in pixels (width and height)

Bitrate 

For media files.

Length 

The length of the file, also for media files.

Hidden 

The item is usually not shown to the user.

Thumbnail 

The item is a thumbnail picture of the file.

Definition at line 89 of file tdefilemetainfo.h.

◆ Unit

enum KFileMimeTypeInfo::Unit

This enum exists so that you can specify units for items, which you can usually use for integer items, so an application knows how to display it (e.g.

a time in seconds in a hh:mm:ss form). You can either use one of those units, or if you don't find one that fits, you can add it yourself using a prefix and/or suffix.

Enumerator
NoUnit 

None of the listed units.

Seconds 

The item represents a time in seconds.

MilliSeconds 

The item represents a time in milliseconds.

BitsPerSecond 

A bit rate.

Pixels 

For image dimensions and similar.

Inches 

Sizes.

Centimeters 

Sizes.

Bytes 

Some data/file size in bytes.

FramesPerSecond 

A frame rate.

Since
3.1
DotsPerInch 

Resolution in DPI.

Since
3.1
BitsPerPixel 

A bit depth.

Since
3.1
Hertz 

Sample rates and similar.

Since
3.1
KiloBytes 

Some data/file size in kilobytes.

Since
3.1
Millimeters 

Sizes.

Since
3.3

Definition at line 111 of file tdefilemetainfo.h.

Member Function Documentation

◆ createValidator()

TQValidator * KFileMimeTypeInfo::createValidator ( const TQString &  group,
const TQString &  key,
TQObject *  parent = 0,
const char *  name = 0 
) const

Creates a validator for this item.

Make sure to supply a proper parent argument or delete the validator yourself.

Parameters
groupthe group of the item
keythe key of the item
parentthe parent of the TQObject, or 0 for a parent-less object
namethe name of the TQObject, can be 0
Returns
the validator. You are responsible for deleting it. 0 if creation failed

Definition at line 1534 of file tdefilemetainfo.cpp.

◆ groupInfo()

const KFileMimeTypeInfo::GroupInfo * KFileMimeTypeInfo::groupInfo ( const TQString &  group) const

Get the group info for a specific group.

Parameters
groupthe group whose group info should be retrieved
Returns
a pointer to the info. 0 if it does not exist. Don't delete this object!

Definition at line 1483 of file tdefilemetainfo.cpp.

◆ mimeType()

TQString KFileMimeTypeInfo::mimeType ( ) const
inline

Returns the mimetype to which this info belongs.

Returns
the mimetype of this info

Definition at line 435 of file tdefilemetainfo.h.

◆ preferredGroups()

TQStringList KFileMimeTypeInfo::preferredGroups ( ) const
inline

This returns the list of groups in the preferred order that's specified in the .desktop file.

Returns
the list of groups

Definition at line 425 of file tdefilemetainfo.h.

◆ preferredKeys()

TQStringList KFileMimeTypeInfo::preferredKeys ( ) const
inline

Return a list of all supported keys in preference order.

Returns
the list of keys

Definition at line 463 of file tdefilemetainfo.h.

◆ supportedGroups()

TQStringList KFileMimeTypeInfo::supportedGroups ( ) const

Returns the list of all groups that the plugin for this mimetype supports.

Returns
the list of groups

Definition at line 1496 of file tdefilemetainfo.cpp.

◆ supportedKeys()

TQStringList KFileMimeTypeInfo::supportedKeys ( ) const

Return a list of all supported keys without looking for a specific group.

Returns
the list of keys

Definition at line 1516 of file tdefilemetainfo.cpp.

◆ translatedGroups()

TQStringList KFileMimeTypeInfo::translatedGroups ( ) const

Same as the above function, but returns the strings to display to the user.

Returns
the list of groups

Definition at line 1506 of file tdefilemetainfo.cpp.


The documentation for this class was generated from the following files:
  • tdefilemetainfo.h
  • tdefilemetainfo.cpp

tdeio/tdeio

Skip menu "tdeio/tdeio"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

tdeio/tdeio

Skip menu "tdeio/tdeio"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdeioslave
  •   http
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for tdeio/tdeio by doxygen 1.9.1
This website is maintained by Timothy Pearson.