KDbObject Class Reference

#include <KDbObject.shared.h>

Inheritance diagram for KDbObject:

Public Member Functions
	KDbObject (int type)
QString	captionOrName () const

Public Attributes
QString	caption
QString	description
int	id
QString	name
int	type

Protected Member Functions
virtual void	clear ()

Detailed Description

Provides common attributes for KDb objects: id, name, caption, help text. A KDb object is typically storable in database, for example: table schema or query schema. Default type of object is KDb::UnknownObjectType.

Definition at line 31 of file KDbObject.shared.h.

Constructor & Destructor Documentation

KDbObject()

KDbObject::KDbObject ( int type )

explicit

Creates new object of type type. *‍/.

Definition at line 24 of file KDbObject.cpp.

Member Function Documentation

captionOrName()

QString KDbObject::captionOrName ( ) const

inline

Returns

caption of this object if it is not empty, else returns object's name.

Definition at line 78 of file KDbObject.shared.h.

clear()

void KDbObject::clear ( )

protectedvirtual

Clears all properties except 'type'.

Reimplemented in KDbQuerySchema, and KDbTableSchema.

Definition at line 34 of file KDbObject.cpp.

Member Data Documentation

caption

QString KDbObject::caption

@getter

Returns

the caption of this object, which is user-visible extended name which can be used in user interfaces and translated. @setter Sets the caption for this object.

Definition at line 64 of file KDbObject.shared.h.

description

QString KDbObject::description

@getter

Returns

the description of this object, which is explanation of the object's purpose, etc. It can be any text and can be used in user interfaces and translated. @setter Sets the description for this object.

Definition at line 74 of file KDbObject.shared.h.

id

int KDbObject::id

@getter

Returns

the identifier of this object, default is -1. @setter Sets the identifier for this object.

Definition at line 46 of file KDbObject.shared.h.

name

QString KDbObject::name

@getter

Returns

the name of this object. @setter Sets the name for this object. It should be valid identifier, i.e. start with underscore or latin letter, contain underscores, latin letters and digits.

Definition at line 55 of file KDbObject.shared.h.

type

int KDbObject::type

@getter

Returns

the type of this object.

Definition at line 38 of file KDbObject.shared.h.

---

The documentation for this class was generated from the following files:

• KDbObject.shared.h
• KDbObject.cpp