KTnef::KTNEFProperty

Search for usage in LXR

#include <ktnefproperty.h>

Public Types

enum  MAPIType {
  UInt16 = 0x0002 , ULong = 0x0003 , Float = 0x0004 , Double = 0x0005 ,
  Boolean = 0x000B , Object = 0x000D , Time = 0x0040 , String8 = 0x001E ,
  UString = 0x001F , Binary = 0x0102
}
 

Public Member Functions

 KTNEFProperty ()
 
 KTNEFProperty (const KTNEFProperty &p)
 
 KTNEFProperty (int key_, int type_, const QVariant &value_, const QVariant &name_=QVariant())
 
 ~KTNEFProperty ()
 
bool isVector () const
 
int key () const
 
QString keyString () const
 
QVariant name () const
 
KTNEFPropertyoperator= (const KTNEFProperty &other)
 
int type () const
 
QVariant value () const
 
QString valueString () const
 

Static Public Member Functions

static QString formatValue (const QVariant &v, bool beautify=true)
 

Detailed Description

Interface for setting MAPI properties.

Definition at line 31 of file ktnefproperty.h.

Member Enumeration Documentation

◆ MAPIType

The different MAPI types.

Enumerator
UInt16 

16-bit unsigned integer

ULong 

unsigned long integer

Float 

single precision floating point

Double 

double precision floating point

Boolean 

a boolean value

Object 

an object

Time 

a time value

String8 

a string of 8 characters

UString 

a string of characters

Binary 

a binary value

Definition at line 37 of file ktnefproperty.h.

Constructor & Destructor Documentation

◆ KTNEFProperty() [1/3]

KTNEFProperty::KTNEFProperty ( )

Constructs a TNEF property.

Definition at line 36 of file ktnefproperty.cpp.

◆ KTNEFProperty() [2/3]

KTNEFProperty::KTNEFProperty ( int key_,
int type_,
const QVariant & value_,
const QVariant & name_ = QVariant() )

Constructs a TNEF property initialized with specified settings.

Parameters
key_is the property key.
type_is the property type.
value_is the property value.
name_is the property name.

Definition at line 41 of file ktnefproperty.cpp.

◆ KTNEFProperty() [3/3]

KTNEFProperty::KTNEFProperty ( const KTNEFProperty & p)

Constructs a TNEF property with settings from another property.

Parameters
pis a KTNEFProperty.

Definition at line 50 of file ktnefproperty.cpp.

◆ ~KTNEFProperty()

KTNEFProperty::~KTNEFProperty ( )
default

Destroys the property.

Member Function Documentation

◆ formatValue()

QString KTNEFProperty::formatValue ( const QVariant & v,
bool beautify = true )
staticnodiscard

Creates a formatted string from the value of the property.

Parameters
vis the property value.
beautifyif true uses a prettier format
Returns
the formatted value string.

Definition at line 80 of file ktnefproperty.cpp.

◆ isVector()

bool KTNEFProperty::isVector ( ) const
nodiscard

Determines if the property is a vector type.

Returns
true if the property is a vector type; otherwise false.

Definition at line 136 of file ktnefproperty.cpp.

◆ key()

int KTNEFProperty::key ( ) const
nodiscard

Returns the integer key of the property.

Returns
the property key.

Definition at line 116 of file ktnefproperty.cpp.

◆ keyString()

QString KTNEFProperty::keyString ( ) const
nodiscard

Returns the key string of the property.

Returns
the key string.

Definition at line 67 of file ktnefproperty.cpp.

◆ name()

QVariant KTNEFProperty::name ( ) const
nodiscard

Returns the name of the property.

Returns
the property name.

Definition at line 131 of file ktnefproperty.cpp.

◆ operator=()

KTNEFProperty & KTNEFProperty::operator= ( const KTNEFProperty & other)

Definition at line 58 of file ktnefproperty.cpp.

◆ type()

int KTNEFProperty::type ( ) const
nodiscard

Returns the integer type of the property.

Returns
the property type.

Definition at line 121 of file ktnefproperty.cpp.

◆ value()

QVariant KTNEFProperty::value ( ) const
nodiscard

Returns the value of the property.

Returns
the property value.

Definition at line 126 of file ktnefproperty.cpp.

◆ valueString()

QString KTNEFProperty::valueString ( ) const
nodiscard

Returns the value string of the property.

Returns
the value string.

Definition at line 111 of file ktnefproperty.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:06:33 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.