BpsLabelerGui Class Reference

GUI labeler interface. More...

#include <bpslabelergui.h>

List of all members.

Public Member Functions
	BpsLabelerGui (BpsLabeler *aLabeler, QObject *aParent=0)
bool	clear (const QVariant &aCollection, QWidget *aParent)
	Delete all articles of a collection from the labelers internal database.
bool	close (QWidget *aParent)
	Close the device and release it for manual operation.
BpsLabeler *	labeler () const
bool	load (const QVariant &aArticle, const QVariant &aCollection, const QVariantMap &aParams, QWidget *aParent)
	Load an article into the working memory so it is ready to start labeling.
bool	open (int aLineNo, const QString &aLineName, const QMap< QString, QString > &aConfig, QWidget *aParent)
	Open the device and do general initializations (setting the current date for example).
bool	save (const QVariant &aArticle, const QVariant &aCollection, const QVariantMap &aParams, QWidget *aParent)
	Save an article to the labelers internal database for emergency or offline operation.
bool	saveLoad (const QVariant &aArticle, const QVariant &aCollection, const QVariantMap &aParams, QWidget *aParent)
	Save an article to the labelers internal database, and load it into the working memory so it is ready to start labeling.
bool	start (QWidget *aParent)
	Start labeling, if supported by the device.
bool	stop (QWidget *aParent)
	Stop labeling, if supported by the device.

---

Detailed Description

GUI labeler interface.

This class provides convenience functions performing labeler operations. Progress dialogs will be shown with the given widget as parent when necessary.

---

Constructor & Destructor Documentation

BpsLabelerGui::BpsLabelerGui	(	BpsLabeler *	aLabeler,
		QObject *	aParent = 0
	)

Parameters:

[in]	aLabeler	The labeler object to be used.
[in]	aParent	The parent object.

---

Member Function Documentation

bool BpsLabelerGui::clear	(	const QVariant &	aCollection,
		QWidget *	aParent
	)

Delete all articles of a collection from the labelers internal database.

Parameters:

[in]	aCollection	Key of the collection. The collection is used as folder/group/customer in the labelers internal database.
[in]	aParent	Parent widget for progress dialog and message boxes.

Returns:

True if all ok, false on partial success, cancel or errors.

bool BpsLabelerGui::close

(

QWidget *

aParent

)

Close the device and release it for manual operation.

Parameters:

[in]

aParent

Parent widget for progress dialog and message boxes.

Returns:

True if all ok, false on partial success, cancel or errors.

BpsLabeler* BpsLabelerGui::labeler

(

)

const

Returns:

The labeler object.

bool BpsLabelerGui::load	(	const QVariant &	aArticle,
		const QVariant &	aCollection,
		const QVariantMap &	aParams,
		QWidget *	aParent
	)

Load an article into the working memory so it is ready to start labeling.

If the device does not support start/stop labeling, this will also start the labeling process.

Parameters:

[in]	aArticle	Key of the article to load.
[in]	aCollection	Key of the collection. The collection is used as folder/group/customer in the labelers internal database.
[in]	aParams	Override values for the placeholders as key/value pairs. All placeholders except a_barcode may be overridden.
[in]	aParent	Parent widget for progress dialog and message boxes.

Returns:

True if all ok, false on partial success, cancel or errors.

bool BpsLabelerGui::open	(	int	aLineNo,
		const QString &	aLineName,
		const QMap< QString, QString > &	aConfig,
		QWidget *	aParent
	)

Open the device and do general initializations (setting the current date for example).

Parameters:

[in]	aLineNo	The packing line number, usually the folder Central System Settings/Terminals/TERMINAL/Packlines/LINENO.
[in]	aLineName	The packing line name, usually the value Central System Settings/Terminals/TERMINAL/Packlines/LINENO/Name.
[in]	aConfig	The labeler configuration, usually the values in Central System Settings/Terminals/TERMINAL/Packlines/LINENO/Labeler.
[in]	aParent	Parent widget for progress dialog and message boxes.

Returns:

True if all ok, false on partial success, cancel or errors.

bool BpsLabelerGui::save	(	const QVariant &	aArticle,
		const QVariant &	aCollection,
		const QVariantMap &	aParams,
		QWidget *	aParent
	)

Save an article to the labelers internal database for emergency or offline operation.

Parameters:

[in]	aArticle	Key of the article to load.
[in]	aCollection	Key of the collection. The collection is used as folder/group/customer in the labelers internal database.
[in]	aParams	Override values for the placeholders as key/value pairs. All placeholders except a_barcode may be overridden.
[in]	aParent	Parent widget for progress dialog and message boxes.

Returns:

True if all ok, false on partial success, cancel or errors.

bool BpsLabelerGui::saveLoad	(	const QVariant &	aArticle,
		const QVariant &	aCollection,
		const QVariantMap &	aParams,
		QWidget *	aParent
	)

Save an article to the labelers internal database, and load it into the working memory so it is ready to start labeling.

If the device does not support start/stop labeling, this will also start the labeling process.

Parameters:

[in]	aArticle	Key of the article to load.
[in]	aCollection	Key of the collection. The collection is used as folder/group/customer in the labelers internal database.
[in]	aParams	Override values for the placeholders as key/value pairs. All placeholders except a_barcode may be overridden.
[in]	aParent	Parent widget for progress dialog and message boxes.

Returns:

True if all ok, false on partial success, cancel or errors.

bool BpsLabelerGui::start

(

QWidget *

aParent

)

Start labeling, if supported by the device.

Parameters:

[in]

aParent

Parent widget for progress dialog and message boxes.

Returns:

True if all ok, false on partial success, cancel or errors.

bool BpsLabelerGui::stop

(

QWidget *

aParent

)

Stop labeling, if supported by the device.

Parameters:

[in]

aParent

Parent widget for progress dialog and message boxes.

Returns:

True if all ok, false on partial success, cancel or errors.

---

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

• bpslabelergui.h