Класс aCatalogue

Класс aCatalogue определяет программный интерфейс иерархических справочников. Наследует aObject. Подробнее...

#include <acatalogue.h>

Граф наследования:aCatalogue:

Полный список членов класса

Открытые слоты
virtual int	New (bool child)
	Задает идентификатор группы.
virtual int	New ()
	Создает новый элемент справочника в текущей группе.
virtual int	Delete ()
	Выполняет удаление текущего элемента каталога.
virtual int	newGroup (Q_ULLONG parentId)
virtual int	newElement (Q_ULLONG parentId)
virtual int	Update ()
	Обновляет значение элемента справочника в базе данных.
virtual int	Copy ()
	Клонирует элемент справочника, создавая новый элемент с теми же значениями свойств что и у текущего элемента.
virtual int	Select (bool grouponly=false)
	Делает один (первый) элемент справочника текущим.
void	UnSelect (bool grouponly=false)
	Выставляет признаки выбранности элемента/группы в false.
virtual int	selectByLevel (int level)
virtual int	selectByGroup (Q_ULLONG idg)
virtual Q_ULLONG	idGroupByElement (Q_ULLONG ide)
virtual int	groupSelect (Q_ULLONG idg)
virtual QVariant	GetElementValue (QVariant ide, const QString &fname)
virtual bool	FindById (QString el_id)
virtual Q_ULLONG	delElement ()
virtual Q_ULLONG	delGroup (Q_ULLONG idg, QValueList< Q_ULLONG > &listDelId)
Q_ULLONG	setMarkDeletedElement (Q_ULLONG el_id, bool del)
Q_ULLONG	setMarkDeletedGroup (Q_ULLONG gr_id, bool del)
void	getMarkDeletedList (Q_ULLONG idg, QValueList< Q_ULLONG > &listDelId)
virtual bool	isGroupMarkDeleted ()
virtual bool	isElementMarkDeleted ()
virtual bool	Next ()
virtual bool	Prev ()
virtual bool	First ()
virtual bool	Last ()
virtual bool	NextInGroupTable ()
virtual bool	PrevInGroupTable ()
virtual bool	FirstInGroupTable ()
virtual bool	LastInGroupTable ()
virtual int	GroupNew (bool reparent=false)
virtual int	GroupDelete ()
virtual int	GroupMarkDeleted ()
virtual int	GroupUpdate ()
virtual int	GroupSelect ()
virtual int	GroupSetGroup (aCatalogue *cat)
virtual QVariant	GroupValue (const QString &name)
virtual int	GroupSetValue (const QString &name, const QVariant &value)
virtual QVariant	GroupSysValue (const QString &name)
virtual int	GroupSetSysValue (const QString &name, const QVariant &value)
virtual QStringList	getUserFields ()
virtual QStringList	getGroupUserFields ()
Открытые члены
	aCatalogue (aCfgItem context, aDatabase *adb=0)
	Конструктор.
	aCatalogue (QString name, aDatabase *adb=0)
	Конструктор.
virtual ERR_Code	initObject ()
	Выполняет реальную инициализацию объекта. Вызывается всеми конструкторами.
Защищенные члены
virtual aCfgItem	displayStringContext ()
	Возвращает контекст (узел дерева) метаданных для вычисления строкового представления сложного типа.

---

Подробное описание

Класс aCatalogue определяет программный интерфейс иерархических справочников. Наследует aObject.

Не визуальный объект используемый для работы с иерархическими каталогами (справочниками). Используется как интерфейс между базой данных и скриптами или wObjects*

---

Методы

ERR_Code aCatalogue::New

(

bool

child

)

[virtual, slot]

Задает идентификатор группы.

Возвращает:

константу err_notable или err_notselected в случае ошибки. err_noerror в случае успеха.

Задает значение идентификатора текущей группы равным значению идентификатора текущей группы указанного Справочника.

Аргументы:

cat

- Каталог значение идентификатора текущей группы которого используется.

Возвращает:

константу err_notable или err_notselected в случае ошибки. err_noerror в случае успеха.

Возвращает идентификатор владельца.

Задает идентификатор владельца.

Возвращает:

константу err_notable или err_notselected в случае ошибки. err_noerror в случае успеха.

Создает новый элемент справочника. Новый элемент будет создан либо как элемент текущей группы, либо как дочерний элемент выбранного элемента справочника.

Аргументы:

child

- задает вариант создания элемента. true - будет создан дочерний элемент текущего элемента справочника. false - будет создан элемент в текущей группк

Возвращает:

err_noerror в случае успешного выполнения или ошибки, возвращаемые методом aObject::New()

Перекрестные ссылки aObject::getUid(), aObject::New(), aObject::setSelected() и aObject::table().

ERR_Code aCatalogue::New

(

)

[virtual, slot]

Создает новый элемент справочника в текущей группе.

Возвращает:

то же, что и aCatalogue::New( bool child )

Переопределяет метод предка aObject.

ERR_Code aCatalogue::Delete

(

)

[virtual, slot]

Выполняет удаление текущего элемента каталога.

Если элемент каталога содержит вложенные элементы, происходит их рекурсивное удаление.

Возвращает:

err_notable, err_notselected в случае возникновения ошибки. Или то, что вернет aObject::Delete()

Переопределяет метод предка aObject.

Перекрестные ссылки aObject::Delete(), Delete(), aLog::print(), selectByOwner(), aObject::selected() и aObject::table().

Используется в Delete().

ERR_Code aCatalogue::newGroup

(

Q_ULLONG

parentId

)

[virtual, slot]

Вставляет новую группу в таблицу групп

Аргументы:

parentId

(in) - идентификационный номер группы предка или 0 если нет предка.

Перекрестные ссылки aLog::print(), aObject::setSelected() и aObject::table().

ERR_Code aCatalogue::newElement

(

Q_ULLONG

parentId

)

[virtual, slot]

Вставляет новый элемент в таблицу элементов

Аргументы:

parentId

(in) - идентификационный номер группы предка.

Перекрестные ссылки aObject::setSelected() и aObject::table().

ERR_Code aCatalogue::Copy

(

)

[virtual, slot]

Клонирует элемент справочника, создавая новый элемент с теми же значениями свойств что и у текущего элемента.

Возвращает:

err_noerror в случае успеха.

Переопределяет метод предка aObject.

Перекрестные ссылки aObject::Copy().

ERR_Code aCatalogue::Select

(

bool

grouponly = false

)

[virtual, slot]

Делает один (первый) элемент справочника текущим.

Меняя значение параметра можно уточнить должен ли быть выбираемый элемент элементом текущей группы.

Аргументы:

grouponly

- значение true требует, чтобы текущим стал один из элементов текущей группы. Значение false означает, что текущим элементом станет первый элемент справочника, а не первый элемент текущей группы.

Перекрестные ссылки aLog::print(), aObject::setSelected() и aObject::table().

Q_ULLONG aCatalogue::idGroupByElement

(

Q_ULLONG

ide

)

[virtual, slot]

Получает идентификационный номер группы по номеру элемента

Аргументы:

ide

(in) - идентификационный номер элемента.

Возвращает:

идентификационный номер группы.

Перекрестные ссылки aObject::setSelected(), aObject::sysValue() и aObject::table().

bool aCatalogue::FindById

(

QString

el_id

)

[virtual, slot]

Находит и позиционирует курсор на элемент справочника с ID=el_id

Перекрестные ссылки aObject::table().

Q_ULLONG aCatalogue::delElement

(

)

[virtual, slot]

Только удаляет элемент. Не поддерживает связь один ко многим.

Возвращает:

идентификационный номер удаляемого элемента.

Перекрестные ссылки aLog::print(), aObject::setSelected() и aObject::table().

Используется в delGroup().

Q_ULLONG aCatalogue::delGroup	(	Q_ULLONG	idg,
		QValueList< Q_ULLONG > &	listDelId
	)			[virtual, slot]

Физически удаляет группу со всеми ее дочерними элементами и группами.

Аргументы:

	idg	(in) - идентификационный номер выделенной для удаления группы.
	listDelId	(in,out) - список идентификационных номеров выделенных для удаления элементов и групп.

Перекрестные ссылки delElement(), aLog::print(), aObject::setSelected() и aObject::table().

Q_ULLONG aCatalogue::setMarkDeletedElement	(	Q_ULLONG	id_el,
		bool	del
	)			[slot]

Только выделяет удаляемый элемент. Не поддерживает связь один ко многим.

Возвращает:

идентификационный номер удаляемого элемента.

Перекрестные ссылки aObject::select(), aObject::SetMarkDeleted(), aDataTable::sysValue(), aObject::table() и Update().

void aCatalogue::getMarkDeletedList	(	Q_ULLONG	idg,
		QValueList< Q_ULLONG > &	listDelId
	)			[slot]

Выделяет удаляемую группу с дочерними элементами и группами. При первом вызове параметр listDelId должен быть пустой, он не обнуляется автоматически при вызове этой функции. Функция рекурсивно вызывает сама себя для всех дочерних подгрупп и добавляет их id в список. Также туда добавляются и id элементов, содержащихся в этих группах. Для изменения атрибута удаления используте функции setElementMarkDeleted(id)(для элементов) и setGroupMarkDeleted(id) (для групп)

Аргументы:

	idg	(in) - идентификационный номер выделенной для удаления группы.
	listDelId	(in,out) - список идентификационных номеров выделенных для удаления элементов и групп.

Перекрестные ссылки aObject::sysValue() и aObject::table().

int aCatalogue::GroupSelect

(

)

[virtual, slot]

Возвращает:

Перекрестные ссылки aObject::selected() и aObject::table().

---

Объявления и описания членов классов находятся в файлах:

• acatalogue.h
• acatalogue.cpp