ak Namespace Reference

Namespaces
namespace	uiAPI

Classes
class	aAction
	This class combines the functionallity of a QAction and a ak::ui::core::aPaintable. More...
class	aAnimationOverlayWidget
class	aCheckBoxWidget
	This class combines the functionallity of a QCheckBox and a ak::object. More...
class	aException
	The ak::Exception class can be used as an universal exception which may used to provide nicely readable exception messages. The provided exception message 'ex_what' is representing the exception message The provided where message 'ex_where' is representing the location where this exception is thrown from. If the exception will be catched by a try block, this exception can be thrown to the next higher level by providing just the new location. At the beginning of each provided location a '@ ' will be added A ak::Exception.what() message can look like this: Exception Message @ Inner function @ Outter function @ Initial calling function. More...
class	aLabelWidget
class	aLineEditWidget
	This class combines the functionallity of a QTextEdit and a ak::ui::core::aWidget. More...
class	aMessenger
	Class used to forward messages to receivers This class is used to forward a message to receivers. A message will only be forwared to registered receivers. Receivers will only get messages from the senders and message types they want to be notified. More...
class	aNiceLineEditWidget
class	aNotifier
	This abstract class is used to provide the receiver functionallity used in the messaging class. More...
class	aNotifierObjectManager
	This notifier is used to notify the core application about incoming events and errors. More...
class	aObject
	This class is used to store the main information of any object used Information contained is the UID and the reference counter. More...
class	aObjectManager
	The objectManager is used for creating and manipulating objects and widgets All objects created here a derived from ak::core::aObject or child. More...
class	aSignalLinker
	Used to link [Widget] signals to the messaging system Every added widget will get all its possible/most important signals connected to slots. In case of an inbound signal a message will be generated and sent to the messaging system. Every object requires a uid which should be generated with the global uid manager. More...
class	aSingletonAllowedMessages
class	aTimer
class	aToolButtonWidget
class	aTreeWidget
class	aTreeWidgetBase
	This class represents a tree. More...
class	aTreeWidgetItem
class	aTtbContainer
	This class provides a interface that represents a tab toolbar container. More...
class	aTtbGroup
class	aTtbPage
class	aTtbSubGroup
class	aUidManager
	This class is used to manage UIDs. This UID manager is incrementing the UID on each getId call. More...
class	aWidget
	This class provides a interface that represents a widget. Every class derived from this class must be able to provide a QWidget that is representing it. More...
class	aWindow
class	aWindowEventHandler
class	aWindowManager
	This class is used to manage a QMainWindow It provides several functions to create and manipulate the UI Also it will connect all created objects to the messaging system and will manage the UIDs of those objects. More...
class	aWindowManagerTimerSignalLinker
	This class is used to link the timer signals of the ui manager to the corresponding callback functions. More...
class	InvalidObjectTypeException
class	ItemNotFoundException
class	ObjectNotFoundException

Typedefs
typedef unsigned long long	UID
	The UID datatype used for objects.
typedef int	ID
	The ID datatype used for items.

Enumerations
enum	colorAreaFlag {   cafBackgroundColorWindow = 1 << 0 , cafForegroundColorWindow = 1 << 1 , cafBorderColorWindow = 1 << 2 , cafBackgroundColorHeader = 1 << 3 ,   cafForegroundColorHeader = 1 << 4 , cafBorderColorHeader = 1 << 5 , cafBackgroundColorControls = 1 << 6 , cafForegroundColorControls = 1 << 7 ,   cafBorderColorControls = 1 << 8 , cafDefaultBorderControls = 1 << 9 , cafDefaultBorderWindow = 1 << 10 , cafBackgroundColorAlternate = 1 << 11 ,   cafForegroundColorError = 1 << 12 , cafBackgroundColorFocus = 1 << 13 , cafBackgroundColorSelected = 1 << 14 , cafForegroundColorFocus = 1 << 15 ,   cafForegroundColorSelected = 1 << 16 , cafBackgroundColorTransparent = 1 << 17 , cafImagesTree = 1 << 18 , cafImagesDock = 1 << 19 ,   cafDefaultBorderHeader = 1 << 20 , cafBackgroundColorDialogWindow = 1 << 21 , cafForegroundColorDialogWindow = 1 << 22 , cafBackgroundColorButton = 1 << 23 ,   cafForegroundColorButton = 1 << 24 , cafTabToolBarGroupSeperatorLine = 1 << 25 , cafBackgroundColorView = 1 << 26 }
enum	commandType { ctClearCreatedObjects }
	Describes the type of an command. More...
enum	dateFormat { dfDDMMYYYY , dfMMDDYYYY , dfYYYYMMDD , dfYYYYDDMM }
	Describes the date format. More...
enum	dockLocation { dockLeft , dockRight , dockBottom }
	Describes the dock location of a dock widget. More...
enum	eventType : unsigned long long {   etUnknownEvent = 1 << 0 , etActivated = 1 << 1 , etChanged = 1 << 2 , etCleared = 1 << 3 ,   etClicked = 1 << 4 , etClosing = 1 << 5 , etCollpased = 1 << 6 , etCursorPosotionChanged = 1 << 7 ,   etDestroyed = 1 << 8 , etDoubleClicked = 1 << 9 , etExpanded = 1 << 10 , etFocused = 1 << 11 ,   etFocusLeft = 1 << 12 , etInvalidEntry = 1 << 13 , etIndexChanged = 1 << 14 , etItemChanged = 1 << 15 ,   etItemTextChanged = 1 << 16 , etKeyPressed = 1 << 17 , etKeyReleased = 1 << 18 , etLocationChanged = 1 << 19 ,   etSelectionChanged = 1 << 20 , etStateChanged = 1 << 21 , etTabToolbarChanged = 1 << 22 , etTabToolbarClicked = 1 << 23 ,   etTimeout = 1 << 24 , etToggeledChecked = 1 << 25 , etToggeledUnchecked = 1 << 26 , etVisibilityChanged = 1 << 27 ,   etReturnPressed = 1 << 28 , etEditingFinished = 1 << 29 , etDeleted = (unsigned long long ) (1) << 32 }
	Describes the type of an event. More...
enum	HashAlgorithm {   hashKeccak_224 , hashKeccak_256 , hashKeccak_384 , hashKeccak_512 ,   hashMd4 , hashMd5 , hashRealSha3_224 , hashRealSha3_256 ,   hashRealSha3_384 , hashRealSha3_512 , hashSha1 , hashSha_224 ,   hashSha_256 , hashSha_384 , hashSha3_224 , hashSha3_256 ,   hashSha3_384 , hashSha3_512 , hashSha512 }
enum	keyType {   keyUnknown , keyAlt , keyAltGr , keyControl ,   keyDelete , keyEscape , keyF1 , keyF10 ,   keyF11 , keyF12 , keyF2 , keyF3 ,   keyF4 , keyF5 , keyF6 , keyF7 ,   keyF8 , keyF9 , keyReturn , keySpace }
enum	objectType {   otNone , otAction , otCheckBox , otLabel ,   otLineEdit , otMainWindow , otMenu , otNiceLineEdit ,   otTabToolbar , otTabToolbarGroup , otTabToolbarPage , otTabToolbarSubgroup ,   otTimer , otToolButton , otTree , otTreeItem }
	Describes the type of an object. More...
enum	promptType {   promptOk , promptYesNo , promptYesNoCancel , promptOkCancel ,   promptRetryCancel , promptIgnoreRetryCancel , promptIconLeft , promptOkCancelIconLeft ,   promptOkIconLeft , promptYesNoIconLeft , promptYesNoCancelIconLeft }
	Describes the promt type. More...
enum	tabLocation { tabLocationUp , tabLocationDown , tabLocationLeft , tabLocationRight }
	Descirbes the tab location. More...
enum	textAlignment { alignLeft , alignRight , alignCenter }
	Describes the text alignment. More...
enum	timeFormat { tfHHMM , tfHHMMSS , tfHHMMSSMMMM }
	Describes the time format. More...
enum	valueType {   vtArray , vtBool , vtColor , vtDate ,   vtDouble , vtFloat , vtInt , vtInt64 ,   vtLosslessDouble , vtLosslessFloat , vtNull , vtNumber ,   vtObject , vtSelection , vtString , vtTime ,   vtUint , vtUint64 }

Functions
eventType	operator| (eventType a, eventType b)
colorAreaFlag	operator| (colorAreaFlag a, colorAreaFlag b)
bool	flagIsSet (colorAreaFlag _flags, colorAreaFlag _testFlag)
UICORE_API_EXPORT QString	toQString (eventType _eventType)
	Create a string representation of the provided ak::core::eventType.
UICORE_API_EXPORT QString	toQString (valueType _valueType)
	Create a string representation of the provided ak::core::valueType.
UICORE_API_EXPORT std::vector< int >	toCharIndex (const char *str)
UICORE_API_EXPORT QCryptographicHash::Algorithm	toQCryptographicHashAlgorithm (HashAlgorithm _algorhitm)
	Will return the QCryptographicHash::Algorithm corresponding to the provided HashAlgorithm.
UICORE_API_EXPORT QString	hashString (const QString &_str, HashAlgorithm _algorhitm)
	Will return a hashed string that was hashed by the specified algorhitm.
template<class T >
std::vector< T >	toVector (const std::list< T > &_list)
	Will return a vector containing all the information from the list.
UICORE_API_EXPORT QString	toQString (objectType _objectType)
	Create a string representation of the provided elementType.
UICORE_API_EXPORT QString	toQString (textAlignment _textAlignment)
	Create a string representation of the provided textAlignment.
UICORE_API_EXPORT QString	toQString (tabLocation _tabLocation)
	Create a string representation of the provided tabLocation.
UICORE_API_EXPORT QString	toQString (dockLocation _dockLocation)
	Create a string representation of the provided dockLocation.
UICORE_API_EXPORT QString	toQString (promptType _promptType)
	Create a string representation of the provided prompt type.
UICORE_API_EXPORT QString	toQString (keyType _keyType)
	Create a string representation of the provided keyType.
UICORE_API_EXPORT QString	toQString (dateFormat _dateFormat)
	Create a string representation of the provided date format.
UICORE_API_EXPORT QString	toQString (timeFormat _timeFormat)
	Create a string representation of the provided time format.
UICORE_API_EXPORT keyType	toKeyType (QKeyEvent *_event)
	Will return the key type of the provided QKeyEvent If the key is not included in the keyType type a keyType::key_Unknown will be returned.
UICORE_API_EXPORT Qt::AlignmentFlag	toQtAlignmentFlag (textAlignment _textAlignment)
	Will return the corresponding Qt text alignment.
UICORE_API_EXPORT dateFormat	toDateFormat (const QString &_str)
	Will return the date format that the provided string is representing.
UICORE_API_EXPORT timeFormat	toTimeFormat (const QString &_str)
	Will return the time format that the provided string is representing.
template<class T >
T	toNumber (const std::string &_string, bool &_failed)
	Will convert and return the number specified in the string.
template<class T >
T	toNumber (const QString &_string, bool &_failed)
	Will convert and return the number specified in the string.
template<class T >
T	toNumber (const char *_string, bool &_failed)
	Will convert and return the number specified in the string.
UICORE_API_EXPORT bool	isDecimal (const char *str)
	Returns true if the provided C-String is in a format ready to be converted to a double or float.
UICORE_API_EXPORT bool	isDecimal (const std::string &str)
	Returns true if the provided C++ String is in a format ready to be converted to a double or float.
UICORE_API_EXPORT bool	isDecimal (const QString &str)
	Returns true if the provided Qt String is in a format ready to be converted to a double or float.
UICORE_API_EXPORT bool	isInteger (const char *str)
	Returns true if the provided C-String is in a format ready to be converted to an integer.
UICORE_API_EXPORT bool	isInteger (const std::string &str)
	Returns true if the provided C++ String is in a format ready to be converted to an integer.
UICORE_API_EXPORT bool	isInteger (const QString &str)
	Returns true if the provided Qt String is in a format ready to be converted to an integer.
UICORE_API_EXPORT bool	isNumericOnly (const char *str)
	Returns true if the provided C-String consists only of numerical characters.
UICORE_API_EXPORT bool	isNumericOnly (const std::string &str)
	Returns true if the provided C++ String consists only of numerical characters.
UICORE_API_EXPORT bool	isNumericOnly (const QString &str)
	Returns true if the provided Qt String consists only of numerical characters.

Variables
const UID	invalidUID = 0
	Represents the invalid UID for an object.
const ID	invalidID = -1
	Represents the invalid ID for an item.

Typedef Documentation

ID

typedef int ak::ID

The ID datatype used for items.

UID

typedef unsigned long long ak::UID

The UID datatype used for objects.

Enumeration Type Documentation

colorAreaFlag

enum ak::colorAreaFlag

Enumerator
cafBackgroundColorWindow
cafForegroundColorWindow
cafBorderColorWindow
cafBackgroundColorHeader
cafForegroundColorHeader
cafBorderColorHeader
cafBackgroundColorControls
cafForegroundColorControls
cafBorderColorControls
cafDefaultBorderControls
cafDefaultBorderWindow
cafBackgroundColorAlternate
cafForegroundColorError
cafBackgroundColorFocus
cafBackgroundColorSelected
cafForegroundColorFocus
cafForegroundColorSelected
cafBackgroundColorTransparent
cafImagesTree
cafImagesDock
cafDefaultBorderHeader
cafBackgroundColorDialogWindow
cafForegroundColorDialogWindow
cafBackgroundColorButton
cafForegroundColorButton
cafTabToolBarGroupSeperatorLine
cafBackgroundColorView

commandType

enum ak::commandType

Describes the type of an command.

Enumerator
ctClearCreatedObjects

dateFormat

enum ak::dateFormat

Describes the date format.

Enumerator
dfDDMMYYYY
dfMMDDYYYY
dfYYYYMMDD
dfYYYYDDMM

dockLocation

enum ak::dockLocation

Describes the dock location of a dock widget.

Enumerator
dockLeft
dockRight
dockBottom

eventType

enum ak::eventType : unsigned long long

Describes the type of an event.

Enumerator
etUnknownEvent
etActivated
etChanged
etCleared
etClicked
etClosing
etCollpased
etCursorPosotionChanged
etDestroyed
etDoubleClicked
etExpanded
etFocused
etFocusLeft
etInvalidEntry
etIndexChanged
etItemChanged
etItemTextChanged
etKeyPressed
etKeyReleased
etLocationChanged
etSelectionChanged
etStateChanged
etTabToolbarChanged
etTabToolbarClicked
etTimeout
etToggeledChecked
etToggeledUnchecked
etVisibilityChanged
etReturnPressed
etEditingFinished
etDeleted

HashAlgorithm

enum ak::HashAlgorithm

Enumerator
hashKeccak_224
hashKeccak_256
hashKeccak_384
hashKeccak_512
hashMd4
hashMd5
hashRealSha3_224
hashRealSha3_256
hashRealSha3_384
hashRealSha3_512
hashSha1
hashSha_224
hashSha_256
hashSha_384
hashSha3_224
hashSha3_256
hashSha3_384
hashSha3_512
hashSha512

keyType

enum ak::keyType

Enumerator
keyUnknown
keyAlt
keyAltGr
keyControl
keyDelete
keyEscape
keyF1
keyF10
keyF11
keyF12
keyF2
keyF3
keyF4
keyF5
keyF6
keyF7
keyF8
keyF9
keyReturn
keySpace

objectType

enum ak::objectType

Describes the type of an object.

Enumerator
otNone
otAction
otCheckBox
otLabel
otLineEdit
otMainWindow
otMenu
otNiceLineEdit
otTabToolbar
otTabToolbarGroup
otTabToolbarPage
otTabToolbarSubgroup
otTimer
otToolButton
otTree
otTreeItem

promptType

enum ak::promptType

Describes the promt type.

Enumerator
promptOk
promptYesNo
promptYesNoCancel
promptOkCancel
promptRetryCancel
promptIgnoreRetryCancel
promptIconLeft
promptOkCancelIconLeft
promptOkIconLeft
promptYesNoIconLeft
promptYesNoCancelIconLeft

tabLocation

enum ak::tabLocation

Descirbes the tab location.

Enumerator
tabLocationUp
tabLocationDown
tabLocationLeft
tabLocationRight

textAlignment

enum ak::textAlignment

Describes the text alignment.

Enumerator
alignLeft
alignRight
alignCenter

timeFormat

enum ak::timeFormat

Describes the time format.

Enumerator
tfHHMM
tfHHMMSS
tfHHMMSSMMMM

valueType

enum ak::valueType

Enumerator
vtArray
vtBool
vtColor
vtDate
vtDouble
vtFloat
vtInt
vtInt64
vtLosslessDouble
vtLosslessFloat
vtNull
vtNumber
vtObject
vtSelection
vtString
vtTime
vtUint
vtUint64

Function Documentation

flagIsSet()

bool ak::flagIsSet ( colorAreaFlag _flags, colorAreaFlag _testFlag )

inline

hashString()

QString ak::hashString	(	const QString &	_str,
		HashAlgorithm	_algorhitm )

Will return a hashed string that was hashed by the specified algorhitm.

isDecimal() [1/3]

bool ak::isDecimal

(

const char *

str

)

Returns true if the provided C-String is in a format ready to be converted to a double or float.

Parameters

str	The C-String to be checked

isDecimal() [2/3]

bool ak::isDecimal

(

const QString &

str

)

Returns true if the provided Qt String is in a format ready to be converted to a double or float.

Parameters

str	The Qt String to be checked

isDecimal() [3/3]

bool ak::isDecimal

(

const std::string &

str

)

Returns true if the provided C++ String is in a format ready to be converted to a double or float.

Parameters

str	The C++ String to be checked

isInteger() [1/3]

bool ak::isInteger

(

const char *

str

)

Returns true if the provided C-String is in a format ready to be converted to an integer.

Parameters

str	The C-String to be checked

isInteger() [2/3]

bool ak::isInteger

(

const QString &

str

)

Returns true if the provided Qt String is in a format ready to be converted to an integer.

Parameters

str	The Qt String to be checked

isInteger() [3/3]

bool ak::isInteger

(

const std::string &

str

)

Returns true if the provided C++ String is in a format ready to be converted to an integer.

Parameters

str	The C++ String to be checked

isNumericOnly() [1/3]

bool ak::isNumericOnly

(

const char *

str

)

Returns true if the provided C-String consists only of numerical characters.

Parameters

str	The C-String to be checked

isNumericOnly() [2/3]

bool ak::isNumericOnly

(

const QString &

str

)

Returns true if the provided Qt String consists only of numerical characters.

Parameters

str	The Qt String to be checked

isNumericOnly() [3/3]

bool ak::isNumericOnly

(

const std::string &

str

)

Returns true if the provided C++ String consists only of numerical characters.

Parameters

str	The C++ String to be checked

operator|() [1/2]

colorAreaFlag ak::operator| ( colorAreaFlag a, colorAreaFlag b )

inline

operator|() [2/2]

eventType ak::operator| ( eventType a, eventType b )

inline

toCharIndex()

std::vector< int > ak::toCharIndex

(

const char *

str

)

toDateFormat()

ak::dateFormat ak::toDateFormat

(

const QString &

_str

)

Will return the date format that the provided string is representing.

toKeyType()

ak::keyType ak::toKeyType

(

QKeyEvent *

_event

)

Will return the key type of the provided QKeyEvent If the key is not included in the keyType type a keyType::key_Unknown will be returned.

Parameters

_event

The event to extract the keyType from

toNumber() [1/3]

template<class T >

T ak::toNumber	(	const char *	_string,
		bool &	_failed )

Will convert and return the number specified in the string.

Parameters

_string	The string containing the number
_failed	Reference to a flag where the failed state will be written to

toNumber() [2/3]

template<class T >

T ak::toNumber	(	const QString &	_string,
		bool &	_failed )

Will convert and return the number specified in the string.

Parameters

_string	The string containing the number
_failed	Reference to a flag where the failed state will be written to

toNumber() [3/3]

template<class T >

T ak::toNumber	(	const std::string &	_string,
		bool &	_failed )

Will convert and return the number specified in the string.

Parameters

_string	The string containing the number
_failed	Reference to a flag where the failed state will be written to

toQCryptographicHashAlgorithm()

QCryptographicHash::Algorithm ak::toQCryptographicHashAlgorithm

(

HashAlgorithm

_algorhitm

)

Will return the QCryptographicHash::Algorithm corresponding to the provided HashAlgorithm.

toQString() [1/10]

QString ak::toQString

(

dateFormat

_dateFormat

)

Create a string representation of the provided date format.

toQString() [2/10]

QString ak::toQString

(

dockLocation

_dockLocation

)

Create a string representation of the provided dockLocation.

Parameters

_dockLocation

The dock location to be converted

toQString() [3/10]

QString ak::toQString

(

eventType

_eventType

)

Create a string representation of the provided ak::core::eventType.

Parameters

_eventType

The event type to be converted

toQString() [4/10]

QString ak::toQString

(

keyType

_keyType

)

Create a string representation of the provided keyType.

toQString() [5/10]

QString ak::toQString

(

objectType

_objectType

)

Create a string representation of the provided elementType.

Parameters

_elementType

The elementtype to be converted

toQString() [6/10]

QString ak::toQString

(

promptType

_promptType

)

Create a string representation of the provided prompt type.

Parameters

_promptType

The prompt type to be converted

toQString() [7/10]

QString ak::toQString

(

tabLocation

_tabLocation

)

Create a string representation of the provided tabLocation.

Parameters

_tabLocation

The tab location to be converted

toQString() [8/10]

QString ak::toQString

(

textAlignment

_textAlignment

)

Create a string representation of the provided textAlignment.

Parameters

_textAlignment

The text alignment to be converted

toQString() [9/10]

QString ak::toQString

(

timeFormat

_timeFormat

)

Create a string representation of the provided time format.

toQString() [10/10]

QString ak::toQString

(

valueType

_valueType

)

Create a string representation of the provided ak::core::valueType.

Parameters

_valueType

The value type to be converted

toQtAlignmentFlag()

Qt::AlignmentFlag ak::toQtAlignmentFlag

(

textAlignment

_textAlignment

)

Will return the corresponding Qt text alignment.

Parameters

_textAlignment

The text alignment to convert

toTimeFormat()

ak::timeFormat ak::toTimeFormat

(

const QString &

_str

)

Will return the time format that the provided string is representing.

toVector()

template<class T >

std::vector< T > ak::toVector

(

const std::list< T > &

_list

)

Will return a vector containing all the information from the list.

Variable Documentation

invalidID

const ID ak::invalidID = -1

Represents the invalid ID for an item.

invalidUID

const UID ak::invalidUID = 0

Represents the invalid UID for an object.