Search for usage in LXR

#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)

Creates new object of type type. *‍/.

Definition at line 24 of file KDbObject.cpp.

Member Function Documentation

◆ captionOrName()

QString KDbObject::captionOrName ( ) const
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 ( )

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


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


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


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


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


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:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Wed Aug 17 2022 04:05:00 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.