uiAPI.h

Go to the documentation of this file.

/*
 *  File:       uiAPI.h
 *  Package:    akAPI
 *
 *  Created on: February 06, 2020
 *  Author: Alexander Kuester
 *  Copyright (c) 2022 Alexander Kuester
 *  This file is part of the uiCore component.
 *  This file is subject to the terms and conditions defined in
 *  file 'LICENSE', which is part of this source code package.
 */
 
#pragma once
 
// AK header
#include <akCore/aException.h>
#include <akCore/akCore.h>
#include <akCore/globalDataTypes.h>
 
#include <akGui/aObjectManager.h>
 
// Qt header
#include <qstring.h>                    // QString
#include <qicon.h>                      // QIcon
#include <qstringlist.h>                // QStringList
#include <qstringlist.h>
#include <qsize.h>
#include <qpixmap.h>
#include <qbytearray.h>
 
// std header
#include <vector>                       // vector<>
#include <map>                          // map<>
 
// Forward declaration
class QSurfaceFormat;
class QWidget;
class QMovie;
class QTabBar;
class QSettings;
class QDockWidget;
class QScreen;
class QApplication;
 
namespace ak {
 
    // Forward declaration
    class aMessenger;
    class aNotifier;
    class aUidManager;
    class aObjectManager;
    class aWindowEventHandler;
    
    namespace uiAPI {
 
        class apiManager {
        public:
            apiManager();
            
            virtual ~apiManager();
            
            void ini(
                QApplication* _applicationInstance,
                const QString &         _organizationName,
                const QString &         _applicationName
            );
 
            bool isInitialized(void) const;
 
            QSurfaceFormat * getDefaultSurfaceFormat(void);
 
            QApplication* app() { return m_app; }
 
            QScreen* screen() { return m_screen; }
 
            QSettings * settings(void) const { return m_settings; }
 
        protected:
            QApplication*               m_app;                          
            bool                        m_appIsRunning;             
            QSurfaceFormat *            m_defaultSurfaceFormat;
            QScreen*                    m_screen;
 
            QString                     m_companyName;
            QString                     m_applicationName;
            QSettings *                 m_settings;
 
            bool                        m_isInitialized;                
 
            aUidManager *               m_fileUidManager;               
            
        private:
            apiManager(const apiManager &) = delete;
            apiManager & operator = (const apiManager &) = delete;
        };
 
        // ###############################################################################################################################################
 
        UICORE_API_EXPORT void ini(
            QApplication* _applicationInstance,
            const QString &     _organizationName,
            const QString &     _applicationName
        );
 
        UICORE_API_EXPORT void destroy(void);
 
        UICORE_API_EXPORT void enableEventTypes(
            eventType                           _types
        );
 
        UICORE_API_EXPORT void disableEventTypes(
            eventType                           _types
        );
 
        UICORE_API_EXPORT void setMessengerEnabled(
            bool                                _enabled
        );
 
        UICORE_API_EXPORT bool messengerIsEnabled(void);
 
        UICORE_API_EXPORT std::vector<eventType> enabledEventTypes(void);
 
        UICORE_API_EXPORT std::vector<eventType> disabledEventTypes(void);
 
        UICORE_API_EXPORT QWidget * getWidget(
            UID                                 _objectUid
        );
 
        UICORE_API_EXPORT UID getObjectCreator(
            UID                                 _objectUID
        );
 
        UICORE_API_EXPORT aObjectManager * getObjectManager(void);
 
        // ###############################################################################################################################################
        
        // message functions
 
        UICORE_API_EXPORT void registerUidNotifier(
            UID                                 _senderUid,
            ak::aNotifier *                     _notifier
        );
 
        UICORE_API_EXPORT void registerEventTypeNotifier(
            eventType                           _event,
            ak::aNotifier *                     _notifier
        );
 
        UICORE_API_EXPORT void registerAllMessagesNotifier(
            ak::aNotifier *                     _notifier
        );
 
        UICORE_API_EXPORT void sendMessage(
            UID                                 _senderUid,
            eventType                           _event,
            int                                 _info1 = 0,
            int                                 _info2 = 0
        );
 
        UICORE_API_EXPORT void setSurfaceFormatDefaultSamplesCount(
            int                                 _count
        );
 
        // ###############################################################################################################################################
 
        // object creation
 
        UICORE_API_EXPORT UID createAction(
            UID                                 _creatorUid,
            const QString &                     _text,
            const QString &                     _iconName,
            const QString &                     _iconSubFolder = QString("32")
        );
 
        UICORE_API_EXPORT UID createAction(
            UID                                 _craetorUid,
            const QString &                     _text,
            const QIcon &                       _icon
        );
 
        UICORE_API_EXPORT UID createCheckbox(
            UID                                 _creatorUid,
            const QString &                     _text,
            bool                                _checked = false
        );
 
        UICORE_API_EXPORT UID createLineEdit(
            UID                                 _creatorUid,
            const QString &                     _initialText = QString("")
        );
 
        UICORE_API_EXPORT UID createNiceLineEdit(
            UID                                 _creatorUid,
            const QString &                     _initialText,
            const QString &                     _infoLabelText
        );
 
        UICORE_API_EXPORT UID createTabToolBarSubContainer(
            UID                                 _creatorUid,
            UID                                 _parentUid,
            const QString &                     _text = QString("")
        );
 
        UICORE_API_EXPORT UID createTimer(
            UID                                 _creatorUid
        );
 
        UICORE_API_EXPORT UID createToolButton(
            UID                                 _creatorUid
        );
 
        UICORE_API_EXPORT UID createToolButton(
            UID                                 _creatorUid,
            const QString &                     _text
        );
 
        UICORE_API_EXPORT UID createToolButton(
            UID                                 _creatorUid,
            const QString &                     _text,
            const QIcon &                       _icon
        );
 
        UICORE_API_EXPORT UID createToolButton(
            UID                                 _creatorUid,
            const QString &                     _text,
            const QString &                     _iconName,
            const QString &                     _iconFolder
        );
 
        UICORE_API_EXPORT UID createWindow(
            UID                                 _creatorUid
        );
 
        // Object creation
 
        // ###############################################################################################################################################
 
        // Action
 
        namespace action {
 
            UICORE_API_EXPORT void setEnabled(
                UID                             _actionUID,
                bool                            _enabled
            );
 
            UICORE_API_EXPORT void setText(
                UID                             _actionUID,
                const QString &                 _text
            );
 
            UICORE_API_EXPORT void setIcon(
                UID                             _actionUID,
                const QIcon &                   _icon
            );
 
            UICORE_API_EXPORT void setIcon(
                UID                             _actionUID,
                const QString &                 _iconName,
                const QString &                 _iconFolder
            );
 
            UICORE_API_EXPORT QString getText(
                UID                             _actionUID
            );
 
        } // namespace action
 
        // ###############################################################################################################################################
 
        // CheckBox
 
        namespace checkBox {
 
            UICORE_API_EXPORT void setChecked(
                UID                             _checkBoxUID,
                bool                            _checked
            );
 
            UICORE_API_EXPORT void setText(
                UID                             _checkBoxUID,
                const QString &                 _text
            );
 
            UICORE_API_EXPORT void setEnabled(
                UID                             _checkBoxUID,
                bool                            _enabled
            );
 
            UICORE_API_EXPORT QString text(
                UID                             _checkBoxUID
            );
 
            UICORE_API_EXPORT bool isChecked(
                UID                             _checkBoxUID
            );
 
            UICORE_API_EXPORT bool isEnabled(
                UID                             _checkBoxUID
            );
 
        }
 
        // ###############################################################################################################################################
 
        // Container
 
        namespace container {
 
            UICORE_API_EXPORT void addObject(
                UID                             _containerUID,
                UID                             _objectUID
            );
 
            UICORE_API_EXPORT void setEnabled(
                UID                             _containerUID,
                bool                            _isEnabled = true
            );
 
            UICORE_API_EXPORT bool isEnabled(
                UID                             _containerUID
            );
        }
 
        // ###############################################################################################################################################
 
        // Dialog
 
        namespace dialog {
 
            UICORE_API_EXPORT QString openDirectory(const QString & _title, const QString & _initialDir);
 
        }
 
        // ###############################################################################################################################################
 
        // Line edit
 
        namespace lineEdit {
            
            UICORE_API_EXPORT void setText(
                UID                                                 _lineEditUid,
                const QString &                                     _text
            );
 
            UICORE_API_EXPORT void setErrorState(
                UID                                                 _lineEditUid,
                bool                                                _error
            );
 
            UICORE_API_EXPORT void setErrorStateIsForeground(
                UID                                                 _lineEditUid,
                bool                                                _isForeground
            );
 
            UICORE_API_EXPORT void setEnabled(
                UID                                                 _lineEditUid,
                bool                                                _enabled
            );
 
            UICORE_API_EXPORT QString text(
                UID                                                 _lineEditUid
            );
 
            UICORE_API_EXPORT bool isEnabled(
                UID                                                 _lineEditUid
            );
        }
 
        // ###############################################################################################################################################
 
        // Nice line edit
 
        namespace niceLineEdit {
 
            UICORE_API_EXPORT void setText(
                UID                                             _lineEditUid,
                const QString &                                     _text
            );
 
            UICORE_API_EXPORT void setErrorState(
                UID                                             _lineEditUid,
                bool                                                _error
            );
 
            UICORE_API_EXPORT void setErrorStateIsForeground(
                UID                                                 _lineEditUid,
                bool                                                _isForeground
            );
 
            UICORE_API_EXPORT void setInfoLabelText(
                UID                                             _lineEditUid,
                const QString &                                     _text
            );
 
            UICORE_API_EXPORT void setEnabled(
                UID                                             _lineEditUid,
                bool                                                _enabled
            );
 
            UICORE_API_EXPORT QString text(
                UID                                             _lineEditUid
            );
 
            UICORE_API_EXPORT QString infoLabelText(
                UID                                             _lineEditUid
            );
 
            UICORE_API_EXPORT bool isEnabled(
                UID                                             _lineEditUid
            );
        }
 
        // ###############################################################################################################################################
 
        // Object
 
        namespace object {
 
            UICORE_API_EXPORT void destroy(
                UID                                             _objectUID,
                bool                                                _ignoreIfObjectHasChildObjects = false
            );
            
            UICORE_API_EXPORT void setObjectUniqueName(
                UID                                             _objectUID,
                const QString &                                     _name
            );
 
            UICORE_API_EXPORT QString getObjectUniqueName(
                UID                                             _objectUID
            );
 
            UICORE_API_EXPORT UID getUidFromObjectUniqueName(
                const QString &                                     _name
            );
 
            UICORE_API_EXPORT void setToolTip(
                UID                                                 _objectUID,
                const QString &                                     _toolTip
            );
 
            UICORE_API_EXPORT void setEnabled(
                UID                                                 _objectUID,
                bool                                                _enabled = true
            );
 
            UICORE_API_EXPORT bool getIsEnabled(
                UID                                                 _objectUID
            );
 
            UICORE_API_EXPORT bool exists(
                UID                                                 _objectUID
            );
 
            UICORE_API_EXPORT objectType type(
                UID                                                 _objectUID
            );
 
            template<class T> T * get(
                UID                                                 _objectUID
            ) {
                T * obj = nullptr;
                obj = dynamic_cast<T *>(getObjectManager()->object(_objectUID));
                if (obj == nullptr) { 
                    assert(0);
                    throw ak::InvalidObjectTypeException(); 
                }
                return obj;
            }
 
        }
 
        // ###############################################################################################################################################
 
        // Timer
 
        namespace timer {
 
            UICORE_API_EXPORT int getInterval(
                UID                         _timerUID
            );
 
            UICORE_API_EXPORT void setInterval(
                UID                         _timerUID,
                int                             _interval
            );
 
            UICORE_API_EXPORT void shoot(
                UID                         _timerUID
            );
 
            UICORE_API_EXPORT void shoot(
                UID                         _timerUID,
                int                             _interval
            );
 
            UICORE_API_EXPORT void start(
                UID                         _timerUID
            );
 
            UICORE_API_EXPORT void start(
                UID                         _timerUID,
                int                             _interval
            );
 
            UICORE_API_EXPORT void stop(
                UID                         _timerUID
            );
 
        } // namespace timer
 
        // ###############################################################################################################################################
 
        // ToolButton
 
        namespace toolButton {
 
            UICORE_API_EXPORT bool getIsEnabled(
                UID                         _toolButtonUID
            );
 
            UICORE_API_EXPORT QString getText(
                UID                         _toolButtonUID
            );
 
            UICORE_API_EXPORT QString getToolTip(
                UID                         _toolButtonUID
            );
 
            UICORE_API_EXPORT void setEnabled(
                UID                         _toolButtonUID,
                bool                            _enabled = true
            );
 
            UICORE_API_EXPORT void setText(
                UID                         _toolButtonUID,
                const QString &                 _text
            );
 
            UICORE_API_EXPORT void setToolTip(
                UID                         _toolButtonUID,
                const QString &                 _text
            );
 
            UICORE_API_EXPORT void setIcon(
                UID                         _toolButtonUID,
                const QIcon &                   _icon
            );
 
            UICORE_API_EXPORT void setIcon(
                UID                         _toolButtonUID,
                const QString &                 _iconName,
                const QString &                 _iconFolder
            );
 
        } // namespace toolButton
 
        // ###############################################################################################################################################
 
        // Window
 
        namespace window {
 
            UICORE_API_EXPORT void addEventHandler(
                UID                                             _windowUID,
                aWindowEventHandler *                               _eventHandler
            );
 
            UICORE_API_EXPORT void close(
                UID                                             _windowUID
            );
 
            UICORE_API_EXPORT void removeEventHandler(
                UID                                             _windowUID,
                aWindowEventHandler *                               _eventHandler
            );
 
            UICORE_API_EXPORT void setStatusLabelVisible(
                UID                                             _windowUID,
                bool                                                _visible = true,
                bool                                                _delayed = true
            );
 
            UICORE_API_EXPORT void setStatusProgressVisible(
                UID                                             _windowUID,
                bool                                                _visible = true,
                bool                                                _delayed = true
            );
 
            UICORE_API_EXPORT void setStatusLabelText(
                UID                                             _windowUID,
                const QString &                                     _text
            );
 
            UICORE_API_EXPORT void setStatusProgressValue(
                UID                                             _windowUID,
                int                                                 _value
            );
 
            UICORE_API_EXPORT void setStatusProgressContinuous(
                UID                                             _windowUID,
                bool                                                _continuous = true
            );
 
            UICORE_API_EXPORT void setTabToolBarVisible(
                UID                                             _windowUID,
                bool                                                _visible = true
            );
 
            UICORE_API_EXPORT void setTabToolbarDoubleClickEnabled(
                UID                                             _windowUID,
                bool                                            _isEnabled
            );
 
            UICORE_API_EXPORT ID getCurrentTabToolBarTab(
                UID                                             _windowUID
            );
 
            UICORE_API_EXPORT int getTabToolBarTabCount(
                UID                                             _windowUID
            );
 
 
            UICORE_API_EXPORT void enableTabToolBar(
                UID                                             _windowUID,
                bool                                            _enable
            );
 
            UICORE_API_EXPORT void setCurrentTabToolBarTab(
                UID                                             _windowUID,
                ID                                              _tabID
            );
 
            UICORE_API_EXPORT void setCurrentTabToolBarTab(
                UID                                             _windowUID,
                const QString&                                  _tabName
            );
 
            UICORE_API_EXPORT void setTitle(
                UID                                             _windowUID,
                const QString &                                     _title
            );
 
            UICORE_API_EXPORT void setWindowIcon(
                UID                                             _windowUID,
                const QIcon &                                   _icon
            );
 
            UICORE_API_EXPORT bool getStatusLabelVisible(
                UID                                             _windowUID
            );
 
            UICORE_API_EXPORT bool getStatusProgressVisible(
                UID                                             _windowUID
            );
 
            UICORE_API_EXPORT QString getStatusLabelText(
                UID                                             _windowUID
            );
 
            UICORE_API_EXPORT int getStatusProgressValue(
                UID                                             _windowUID
            );
 
            UICORE_API_EXPORT bool getStatusProgressContinuous(
                UID                                             _windowUID
            );
 
            UICORE_API_EXPORT void setCentralWidget(
                UID                                             _windowUID,
                UID                                             _widgetUID
            );
 
            UICORE_API_EXPORT void setCentralWidget(
                UID                                             _windowUID,
                QWidget *                                           _widget
            );
 
            UICORE_API_EXPORT void showMaximized(
                UID                                             _windowUID
            );
 
            UICORE_API_EXPORT void showNormal(
                UID                                             _windowUID
            );
 
            UICORE_API_EXPORT void showMinimized(
                UID                                             _windowUID
            );
 
            UICORE_API_EXPORT QSize size(
                UID                                             _windowUID
            );
 
            UICORE_API_EXPORT QPoint position(
                UID                                             _windowUID
            );
 
            UICORE_API_EXPORT void setWaitingAnimationVisible(
                UID                                             _windowUID,
                bool                                                _visible = true
            );
 
            UICORE_API_EXPORT void setWaitingAnimation(
                UID                                             _windowUID,
                QMovie *                                            _movie
            );
 
            UICORE_API_EXPORT void setWaitingAnimation(
                UID                                             _windowUID,
                const QString &                                     _animationName
            );
 
            UICORE_API_EXPORT void setCentralWidgetMinimumSize(
                UID                                             _windowUID,
                int                                                 _width,
                int                                                 _height
            );
 
            UICORE_API_EXPORT double devicePixelRatio(void);
 
            UICORE_API_EXPORT void resize(
                UID                                             _windowUID,
                int                                                 _width,
                int                                                 _height
            );
 
            UICORE_API_EXPORT std::string saveState(
                UID                                             _windowUID,
                std::string                                     _currentState = ""
            );
 
            UICORE_API_EXPORT bool restoreState(
                UID                                             _windowUID,
                const std::string &                             _state,
                bool                                            _setPositionAndSize = true
            );
 
            UICORE_API_EXPORT void setTabToolBarTabOrder(
                UID                                             _windowUID,
                const QStringList&                              _list
            );
 
            UICORE_API_EXPORT void activateToolBarTab(
                UID                                             _windowUID,
                const QString&                                  _tabName
            );
 
        } // namespace window
 
        // ###############################################################################################################################################
 
        // Crypto
 
        namespace crypto {
 
            UICORE_API_EXPORT QString hash(
                const QString &         _orig,
                HashAlgorithm           _algorithm
            );
 
        }
 
        // ###############################################################################################################################################
 
        UICORE_API_EXPORT void creatorDestroyed(
            UID                                 _creatorUid
        );
 
        // ###############################################################################################################################################
 
        // parameters
 
        UICORE_API_EXPORT UID createUid(void);
 
        UICORE_API_EXPORT aMessenger * getMessenger(void);
 
        UICORE_API_EXPORT const QIcon & getIcon(
            const QString &                                         _iconName,
            const QString &                                         _iconSubPath
        );
 
        UICORE_API_EXPORT const QIcon & getApplicationIcon(
            const QString &                                         _iconName
        );
 
        UICORE_API_EXPORT const QPixmap & getPixmap(
            const QString &                                         _name
        );
 
        UICORE_API_EXPORT QMovie * getMovie(
            const QString&                                          _name
        );
 
        // ###############################################################################################################################################
 
        // Settings
 
        namespace settings {
 
            UICORE_API_EXPORT QString getString(
                const QString &         _settingsName,
                const QString &         _defaultValue = QString("")
            );
 
            UICORE_API_EXPORT int getInt(
                const QString &         _settingsName,
                int                     _defaultValue = 0
            );
 
            UICORE_API_EXPORT double getDouble(
                const QString &         _settingsName,
                double                  _defaultValue = 0.0
            );
 
            UICORE_API_EXPORT float getFloat(
                const QString &         _settingsName,
                float                   _defaultValue = 0.0
            );
 
            UICORE_API_EXPORT bool getBool(
                const QString &         _settingsName,
                bool                    _defaultValue = 0.0
            );
 
            UICORE_API_EXPORT QByteArray getByteArray(
                const QString &         _settingsName,
                const QByteArray &      _defaultValue = QByteArray()
            );
 
            UICORE_API_EXPORT void setString(
                const QString &         _settingsName,
                const QString &         _value
            );
 
            UICORE_API_EXPORT void setInt(
                const QString &         _settingsName,
                int                     _value
            );
 
            UICORE_API_EXPORT void setDouble(
                const QString &         _settingsName,
                double                  _value
            );
 
            UICORE_API_EXPORT void setFloat(
                const QString &         _settingsName,
                float                   _value
            );
 
            UICORE_API_EXPORT void setBool(
                const QString &         _settingsName,
                bool                    _value
            );
 
            UICORE_API_EXPORT void setByteArray(
                const QString &         _settingsName,
                const QByteArray &      _value
            );
        }
 
        // ###############################################################################################################################################
 
        // special
 
        namespace special {
 
            UICORE_API_EXPORT QString toString(
                eventType                               _type
            );
 
            UICORE_API_EXPORT QString toString(
                valueType                               _type
            );
 
            UICORE_API_EXPORT QString toString(
                textAlignment                           _type
            );
 
            UICORE_API_EXPORT QString toString(
                dockLocation                            _dockLocation
            );
 
            UICORE_API_EXPORT QString toString(
                tabLocation                             _tabLocation
            );
 
            UICORE_API_EXPORT QString toString(
                keyType                                 _type
            );
 
            UICORE_API_EXPORT QString toString(
                objectType                              _type
            );
            
            UICORE_API_EXPORT QString toString(
                const QDate &                           _date,
                dateFormat                              _format,
                const QString &                         _delimiter
            );
 
            UICORE_API_EXPORT QString toString(
                const QTime &                           _time,
                timeFormat                              _format,
                const QString &                         _delimiter,
                const QString &                         _millisecondDelimiter = "."
            );
 
            UICORE_API_EXPORT QString toEventText(
                UID                                     _senderUID,
                eventType                               _eventType,
                int                                     _info1,
                int                                     _info2
            );
 
        }
 
    } // namespace uiAPI
 
} // namespace ak