OpenTwin 0.1
OpenTwin
 
Loading...
Searching...
No Matches
Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Friends | List of all members
AppBase Class Reference

The API manager is used to manage the global objects required for this API to work. More...

#include "AppBase.h"

+ Inheritance diagram for AppBase:

Public Types

enum  StartOption { LogExport , NoAutoStart }
 
- Public Types inherited from ot::ActionHandler
typedef std::function< std::string(JsonDocument &) ActionHandlerMethodType)
 
- Public Types inherited from otoolkit::APIInterface
enum  InterfaceLogType { Information , Warning , Error }
 

Public Slots

void slotCopyRequested (const ot::CopyInformation &_info)
 
void slotPasteRequested (const ot::CopyInformation &_info)
 
void slotColorStyleChanged ()
 
void slotLockUI (bool _flag)
 
void slotLockSelectionAndModification (bool _flag)
 
void slotSetProgressBarVisibility (QString _progressMessage, bool _progressBaseVisible, bool _continuous)
 
void slotSetProgressBarValue (int _progressPercentage)
 
void slotRunCustomTimer (const QString &_timerId, int _intervalMs)
 
void queueCustomCallback (const QString &_callbackId)
 
void replaceInfoMessage (const QString &_message)
 Replace the current output window text with the provided one.
 
void appendInfoMessage (const QString &_message)
 Append a plain text message to the output.
 
void appendHtmlInfoMessage (const QString &_html)
 Append an HTML formatted message to the output.
 
void slotShowOutputContextMenu (QPoint _pos)
 
QVariantMap slotSendExecuteMessageToService (const QString &_serviceName, const QString &_message)
 Sends an execute message to the specified service and wait for the response.
 
QVariantMap slotSendExecuteMessageToUrl (const QString &_serviceUrl, const QString &_message)
 Sends an execute message to the specified service URL and wait for the response.
 
bool slotSendQueueMessageToService (const QString &_serviceName, const QString &_message)
 Sends a queue message to the specified service.
 
bool slotSendQueueMessageToUrl (const QString &_serviceUrl, const QString &_message)
 Sends a queue message to the specified service URL.
 
void slotShowInfoPrompt (const std::string &_title, const std::string &_message, const std::string &_detailedMessage)
 
void slotShowWarningPrompt (const std::string &_title, const std::string &_message, const std::string &_detailedMessage)
 
void slotShowErrorPrompt (const std::string &_title, const std::string &_message, const std::string &_detailedMessage)
 
void setTabToolBarTabOrder (const QStringList &_lst)
 
void activateToolBarTab (const QString &_tab)
 
void slotGraphicsItemRequested (const QString &_name, const QPointF &_pos)
 
void slotGraphicsElementsChanged (const ot::GraphicsChangeEvent &_event)
 
void slotGraphicsItemDoubleClicked (const ot::GraphicsItemCfg *_itemConfig)
 
void slotGraphicsConnectionRequested (const ot::UID &_fromUid, const std::string &_fromConnector, const ot::UID &_toUid, const std::string &_toConnector)
 
void slotGraphicsConnectionToConnectionRequested (const ot::UID &_fromItemUid, const std::string &_fromItemConnector, const ot::UID &_toConnectionUid, const ot::Point2DD &_newControlPoint)
 
void slotGraphicsSelectionChanged ()
 
void slotTextEditorSaveRequested ()
 
void slotTextLoadNextRequested (size_t _nextChunkStartIndex)
 
void slotTextLoadAllRequested (size_t _nextChunkStartIndex)
 
void slotTableSaveRequested ()
 
void slotVersionSelected (const std::string &_versionName)
 
void slotVersionDeselected ()
 
void slotRequestVersion (const std::string &_versionName)
 
QString determineAvailableViewTabText (const QString &_initialTabText)
 
void slotViewAdded (ot::WidgetView *_newView)
 
void slotViewFocusChanged (ot::WidgetView *_focusedView, ot::WidgetView *_previousView)
 
void slotViewCloseRequested (ot::WidgetView *_view)
 
void slotViewTabClicked (ot::WidgetView *_view)
 
void slotViewDataModifiedChanged (ot::WidgetView *_view)
 
void slotCreateProject ()
 Create a new project. Will show the project creation dialog.
 
void slotOpenProject ()
 Open the currently selected project in the welcome screen.
 
void slotOpenProjectFromIndex (int _index)
 
void slotRefreshProjectOverivew ()
 
void slotOpenSpecificProject (const QString &_projectName, const QString &_projectVersion)
 
void slotCopyProject ()
 
void slotRenameProject ()
 
void slotDeleteProject ()
 
void slotExportProject ()
 
void slotManageProjectAccess ()
 
void slotManageProjectOwner ()
 
void refreshWelcomeScreen ()
 Refreshes the welcome screen content. This function can be used to update the project list after projects were created, deleted, or modified.
 
QStringList getAvailableProjectNames () const
 
void downloadInstaller (QString gssUrl)
 Downloads the installer from the provided GSS URL and runs it.
 
void slotPropertyGridValueChanged (const ot::Property *_property)
 
void slotPropertyGridValueDeleteRequested (const ot::Property *_property)
 
void setNavigationTreeSortingEnabled (bool _enabled)
 
void setNavigationTreeMultiselectionEnabled (bool _enabled)
 
void clearNavigationTree ()
 
ot::UID findNavigationTreeItemByName (const QString &_itemName)
 
ot::UID addNavigationTreeItem (const ot::EntityTreeItem &_itemInfo)
 
void setNavigationTreeItemIcon (ot::UID _itemID, const QString &_iconName, const QString &_iconDefaultPath)
 
void setNavigationTreeItemText (ot::UID _itemID, const QString &_itemName)
 
void setNavigationTreeItemsSelected (const ot::UIDList &_itemIDs, bool _selected, bool _clearOtherSelection)
 
void setNavigationTreeItemSelected (ot::UID _itemID, bool _isSelected)
 
void setSingleNavigationTreeItemSelected (ot::UID _itemID, bool _isSelected)
 
void expandSingleNavigationTreeItem (ot::UID _itemID, bool _isExpanded)
 
bool isTreeItemExpanded (ot::UID _itemID)
 
bool isTreeItemSelected (ot::UID _itemID)
 
void toggleNavigationTreeItemSelection (ot::UID _itemID, bool _considerChilds)
 
void removeNavigationTreeItems (const std::vector< ot::UID > &itemIds)
 
void clearNavigationTreeSelection ()
 
QString getNavigationTreeItemText (ot::UID _itemID)
 
const ot::SelectionInformation & getSelectedNavigationTreeItems ()
 
void slotTreeItemSelectionChanged ()
 Navigation tree item selection has changed.
 
void slotTreeItemTextChanged (QTreeWidgetItem *_item, int _column)
 
void slotTreeItemFocused (QTreeWidgetItem *_item)
 
void slotHandleSelectionHasChanged (ot::SelectionHandlingResult *_result, ot::SelectionOrigin _eventOrigin)
 
void slotPlotResetItemSelectionRequest ()
 
void slotPlotCurveDoubleClicked (ot::UID _entityID, bool _hasControlModifier)
 
void servicesUiSetupCompleted ()
 Is called when the log-in dialog is available.
 
void projectOpenCompleted ()
 Is called when the project open operation is completed.
 
void projectCloseCompleted ()
 Is called when the project close operation is completed.
 
void slotProcessMessage (const QString &_json)
 

Signals

void logInDialogAvailable (QObject *_dialog)
 Is emitted when the log-in dialog is available.
 
void toolBarAvailable (QObject *_toolBar)
 Is emitted when the tool bar is available.
 
void loginSuccessful ()
 Is emitted when the log-in was successful and the default ui was created.
 
void projectOpened ()
 Is emitted when a project was opened.
 
void projectClosed ()
 Is emitted when a project was closed.
 
void servicesUiSetupComplete ()
 Is emitted when the services UI setup of all services in the session is complete.
 
void customTimerTimeout (const QString &_timerID)
 
void customQueueCallback (const QString &_callbackID)
 

Public Member Functions

virtual void log (const ot::LogMessage &_message) override
 Called when the a log message was created.
 
void handleLog (ot::JsonDocument &_jsonDocument)
 
std::string handleRegister (ot::JsonDocument &_jsonDocument)
 
void handleDeregister (ot::JsonDocument &_jsonDocument)
 
void handleClear ()
 
std::string handleGetDebugInfo ()
 
void handleSetGlobalLogFlags (ot::JsonDocument &_jsonDocument)
 
void handleSetCacheSize (ot::JsonDocument &_jsonDocument)
 
ot::ReturnMessage handleGetAllLogs ()
 
ot::ReturnMessage handleGetUserLogs (ot::JsonDocument &_jsonDocument)
 
void updateBufferSizeFromLogFlags (const ot::LogFlags &_flags)
 
virtual ~AppBase ()
 Deconstructor.
 
bool initialize ()
 Will initialize the API Returns: 0: OK -1: Was already initialized 1: Exception catched 2: Non exception catched 3: Log-in failed.
 
bool logIn ()
 
bool isInitialized () const
 Returns true if the API was initialized.
 
std::shared_ptr< QSettings > createSettingsInstance () const
 
void setUiServiceUID (ot::UID _uid)
 
ot::UID getUiServiceUID () const
 
void setViewerUID (ot::UID _uid)
 
ot::UID getViewerUID () const
 
void setModelUID (ot::UID _uid)
 
ot::UID getModelUID () const
 
ViewerComponent * getViewerComponent () const
 
ExternalServicesComponent * getExternalServicesComponent () const
 
void setCurrentProjectIsModified (bool _isModified=true)
 Will set the current project as modified and apply UI changes.
 
bool getCurrentProjectIsModified () const
 Will get the current project as modified state.
 
const LoginData & getCurrentLoginData () const
 Will return the current username.
 
std::string getCurrentUserCollection () const
 Will return the current username.
 
ak::aWindow * mainWindow () const
 
ControlsManager * controlsManager ()
 
LockManager * lockManager ()
 
ot::NavigationTreeView * getProjectNavigation () const
 
bool runJSScriptFromFile (const QString &_filePath)
 
bool runJSScript (const QString &_scriptName, const QString &_scriptData)
 
virtual void log (const ot::LogMessage &_message) override
 Called when the a log message was created.
 
virtual void notify (ot::UID _senderId, ak::eventType _eventType, int _info1, int _info2) override
 Will call the callback function with the provided parameters.
 
virtual bool closeEvent () override
 
bool createNewProjectInDatabase (const QString &_projectName, const QString &_projectType)
 
void initializeDefaultUserSettings ()
 
void frontendSettingsChanged (const ot::Property *_property)
 
void viewerSettingsChanged (const ot::Property *_property)
 
void settingsChanged (const std::string &_owner, const ot::Property *_property)
 
void setWaitingAnimationVisible (bool flag) const
 
void createUi ()
 
void setDebug (bool)
 
bool debug () const
 
std::string getDebugInformation () const
 
ModelUIDtype createModel ()
 
ViewerUIDtype createView (ModelUIDtype _modelUID, const std::string &_projectName)
 
void setCurrentVisualizationTabFromEntityName (const std::string &_entityName, ot::WidgetViewBase::ViewType _viewType)
 Sets the current visualization tab.
 
void setCurrentVisualizationTabFromTitle (const std::string &_tabTitle)
 Sets the current visualization tab from the provided title.
 
std::string getCurrentVisualizationTabTitle ()
 
void importProject ()
 
void manageGroups ()
 
void exportLogs ()
 
void setSiteID (int _id)
 Will set the current site ID.
 
void setServiceURL (const std::string &_url)
 Will set the current Service URL of this service.
 
void setSessionServiceURL (const std::string &_url)
 Will set the session service URL.
 
void startSessionRefreshTimer ()
 
void setViewHandlingFlag (ot::ViewHandlingFlag _flag, bool _active=true)
 
void setViewHandlingFlags (const ot::ViewHandlingFlags &_flags)
 
const ot::ViewHandlingFlags & getViewHandlingFlags () const
 
void renameEntity (const std::string &_fromPath, const std::string &_toPath)
 
int getSiteID () const
 Will return the current site ID.
 
ot::UID uiUID () const
 
void setRelayURLs (const std::string &)
 Will set the Relay URLs.
 
std::string getRelayURLs () const
 Will return the current Relay URLs.
 
const std::string & getServiceURL () const
 Will return the current Service URL.
 
const std::string & getSessionServiceURL () const
 Will return the session service URL.
 
void setCurrentProjectInfo (const ot::ProjectInformation &_info)
 
const ot::ProjectInformation & getCurrentProjectInfo () const
 
void switchToViewMenuTabIfNeeded () const
 
void switchToMenuTab (const std::string &_menu)
 
std::string getCurrentMenuTab ()
 
void closeAllViewerTabs ()
 
void clearSessionInformation ()
 Will clear the session information such as the project name, collection name and user name.
 
void restoreSessionState ()
 
void storeSessionState ()
 
bool storeSettingToDataBase (const ot::PropertyGridCfg &_config, const std::string &_subKey)
 
ot::PropertyGridCfg getSettingsFromDataBase (const std::string &_subKey)
 
void updateLogIntensityInfo ()
 
ot::ProjectOverviewWidget::ViewMode getWelcomeScreenViewMode () const
 
ToolBar * getToolBar () const
 
void setupPropertyGrid (const ot::PropertyGridCfg &_configuration)
 
void clearModalPropertyGrid ()
 
void focusPropertyGridItem (const std::string &_group, const std::string &_name)
 
void setVisible3D (bool visible3D)
 
void setVisibleBlockPicker (bool visibleBlockPicker)
 
bool getVisible3D () const
 
bool getVisibleBlockPicker () const
 
void appendLogMessage (const ot::LogMessage &_message)
 Append a log message to the output. The following information will be used from the log message:
 
ot::VersionGraphManagerView * getVersionGraph ()
 
void autoCloseUnpinnedViews (bool _ignoreCurrent)
 
ot::PropertyGridItem * findProperty (const std::string &_groupName, const std::string &_itemName)
 
ot::PropertyGridItem * findProperty (const std::list< std::string > &_groupPath, const std::string &_itemName)
 
std::string getPropertyType (const std::string &_groupName, const std::string &_itemName)
 
bool getPropertyIsDeletable (const std::string &_groupName, const std::string &_itemName)
 
ShortcutManager * shortcutManager ()
 
void clearPropertyGrid ()
 
void lockPropertyGrid (bool flag)
 
void addGraphicsPickerPackage (const ot::GraphicsPickerCollectionPackage &_pckg)
 
void clearGraphicsPickerData ()
 Clears the graphics picker and stored service picker data.
 
ot::GraphicsViewView * createNewGraphicsEditor (const std::string &_entityName, const QString &_title, const std::string &_pickerKey, const ot::WidgetView::InsertFlags &_viewInsertFlags, const ot::VisualisationCfg &_visualizationConfig)
 
ot::GraphicsViewView * findGraphicsEditor (const std::string &_entityName, const ot::UIDList &_visualizingEntities)
 
ot::GraphicsViewView * findOrCreateGraphicsEditor (const std::string &_entityName, const QString &_title, const std::string &_pickerKey, const ot::WidgetView::InsertFlags &_viewInsertFlags, const ot::VisualisationCfg &_visualizationConfig)
 
std::list< ot::GraphicsViewView * > getAllGraphicsEditors ()
 
void closeGraphicsEditor (const std::string &_entityName)
 
ot::TextEditorView * createNewTextEditor (const ot::TextEditorCfg &_config, const ot::WidgetView::InsertFlags &_viewInsertFlags, const ot::UIDList &_visualizingEntities)
 
ot::TextEditorView * findTextEditor (const std::string &_entityName, const ot::UIDList &_visualizingEntities)
 
ot::TextEditorView * findOrCreateTextEditor (const ot::TextEditorCfg &_config, const ot::WidgetView::InsertFlags &_viewInsertFlags, const ot::UIDList &_visualizingEntities)
 
void closeTextEditor (const std::string &_entityName)
 
void closeAllTextEditors (const ot::BasicServiceInformation &_serviceInfo)
 
ot::TableView * createNewTable (const ot::TableCfg &_config, const ot::WidgetView::InsertFlags &_viewInsertFlags, const ot::UIDList &_visualizingEntities)
 
ot::TableView * findTable (const std::string &_entityName, const ot::UIDList &_visualizingEntities)
 
ot::TableView * findOrCreateTable (const ot::TableCfg &_config, const ot::WidgetView::InsertFlags &_viewInsertFlags, const ot::UIDList &_visualizingEntities)
 
void closeTable (const std::string &_name)
 
ot::PlotView * createNewPlot (const ot::Plot1DCfg &_config, const ot::WidgetView::InsertFlags &_viewInsertFlags, const ot::UIDList &_visualizingEntities)
 
ot::PlotView * findPlot (const std::string &_entityName, const ot::UIDList &_visualizingEntities)
 
ot::PlotView * findOrCreatePlot (const ot::Plot1DCfg &_config, const ot::WidgetView::InsertFlags &_viewInsertFlags, const ot::UIDList &_visualizingEntities)
 
void closePlot (const std::string &_name)
 
virtual ot::MessageDialogCfg::BasicButton showPrompt (const ot::MessageDialogCfg &_config, QWidget *_parent) override
 
ot::MessageDialogCfg::BasicButton showPrompt (const std::string &_title, const std::string &_message, const std::string &_detailedMessage, ot::MessageDialogCfg::BasicIcon _icon, const ot::MessageDialogCfg::BasicButtons &_buttons)
 
void destroyObjects (const std::vector< ot::UID > &_objects)
 
void makeWidgetViewCurrentWithoutInputFocus (ot::WidgetView *_view, bool _ignoreEntitySelect)
 
bool openNewInstance (const ot::ProjectInformation &_projectInfo, const std::string &_customVersion)
 
void editProjectInformation (const std::string &_senderUrl, const std::string &_callbackAction)
 
virtual void log (const ot::LogMessage &_message) override
 Called when the a log message was created.
 
virtual void log (const QString &_sender, InterfaceLogType _type, const QString &_message) override
 
virtual bool addTool (otoolkit::Tool *_tool) override
 
virtual void updateStatusString (const QString &_statusText) override
 
virtual void updateStatusStringAsError (const QString &_statusText) override
 
virtual void registerToolActivityNotifier (otoolkit::ToolActivityNotifier *_notifier) override
 
virtual void removeToolActivityNotifier (otoolkit::ToolActivityNotifier *_notifier) override
 
virtual otoolkit::SettingsRef createSettingsInstance () override
 
virtual const QWidget * rootWidget () const override
 
virtual void closeEvent (QCloseEvent *_event) override
 
void setUrl (const QString &_url)
 
const QString & url () const
 
void parseStartArgs (const std::string &_args)
 
void setApplicationInstance (QApplication *_app)
 
QApplication * applicationInstance ()
 
void setUpdateTransparentColorStyleValueEnabled (bool _enabled)
 
bool getUpdateTransparentColorStyleValueEnabled () const
 
void updateTransparentColorStyleValue ()
 
bool getIgnoreToolAutoStart () const
 
- Public Member Functions inherited from ot::ServiceBase
 ServiceBase ()
 Constructor.
 
 ServiceBase (const std::string &_name, const std::string &_type)
 Constructor.
 
 ServiceBase (const std::string &_name, const std::string &_type, const std::string &_url, serviceID_t _id, const std::string &_siteId=std::string())
 Constructor.
 
bool operator== (const ServiceBase &_other) const
 
bool operator!= (const ServiceBase &_other) const
 
virtual ~ServiceBase ()
 Deconstructor.
 
virtual void addToJsonObject (JsonValue &_object, JsonAllocator &_allocator) const override
 Serialize the object data into the provided JSON object by using the provided allocator.
 
virtual void setFromJsonObject (const ConstJsonObject &_object) override
 Set the data by deserializing the object. Set the object contents from the provided JSON object.
 
void setServiceID (serviceID_t _id)
 Set the service ID.
 
void setServiceURL (const std::string &_url)
 Set the service URL.
 
void setServiceName (const std::string &_name)
 Set the service name.
 
void setServiceType (const std::string &_type)
 Set the service type.
 
void setSiteID (const std::string &_id)
 Set the site ID.
 
void setSessionCount (int _count)
 Set the session count.
 
serviceID_t getServiceID () const
 Return the service ID.
 
int getSessionCount () const
 Return the session count.
 
const std::string & getServiceURL () const
 Return the service URL.
 
const std::string & getServiceName () const
 Return the service name.
 
const std::string & getServiceType () const
 Return the service type.
 
const std::string & getSiteID () const
 Return the site ID.
 
BasicServiceInformation getBasicServiceInformation () const
 
- Public Member Functions inherited from ot::Serializable
 Serializable ()=default
 
virtual ~Serializable ()=default
 
virtual std::string toJson () const
 Create a JSON string from the object data.
 
- Public Member Functions inherited from ot::AbstractLogNotifier
 AbstractLogNotifier ()
 
virtual ~AbstractLogNotifier ()
 
void setCustomDeleteLogNotifier (bool _customDelete=true)
 Will set the delete later flag. If delete later is set, the creator keeps ownership of this object even after it is added to the LogDispatcher.
 
bool getCustomDeleteLogNotifier () const
 Returns true if the delete later mode is set.
 
- Public Member Functions inherited from ot::ActionHandler
 ActionHandler (ActionDispatcherBase *_dispatcher=&ot::ActionDispatcher::instance())
 Creates a new ActionHandler that will register all created [handlers] at the provided [action dispatcher].
 
 ActionHandler (ActionHandler &&_other) noexcept
 Move constructor.
 
 ~ActionHandler ()
 
ActionHandler & operator= (ActionHandler &&_other) noexcept
 Move assignment operator.
 
template<typename Function >
bool connectAction (const std::string &_actionName, Function &&_func, const ot::MessageTypeFlags &_messageFlags=ot::DEFAULT_MESSAGE_TYPE, const ActionDispatcherBase::InsertFlags &_insertFlags=ActionDispatcherBase::NoFlags)
 Creates a new [handler] and registers it at the currently set [action dispatcher]. The ActionHandler will take ownership of the created handler and will remove it from the dispatcher when destroyed.
 
template<typename Function >
bool connectAction (const std::initializer_list< std::string > &_actionNames, Function &&_func, const ot::MessageTypeFlags &_messageFlags=ot::DEFAULT_MESSAGE_TYPE, const ActionDispatcherBase::InsertFlags &_insertFlags=ActionDispatcherBase::NoFlags)
 Creates a new [handler] and registers it at the currently set [action dispatcher]. The ActionHandler will take ownership of the created handler and will remove it from the dispatcher when destroyed.
 
template<typename Function >
bool connectAction (const std::list< std::string > &_actionNames, Function &&_func, const ot::MessageTypeFlags &_messageFlags=ot::DEFAULT_MESSAGE_TYPE, const ActionDispatcherBase::InsertFlags &_insertFlags=ActionDispatcherBase::NoFlags)
 Creates a new [handler] and registers it at the currently set [action dispatcher]. The ActionHandler will take ownership of the created handler and will remove it from the dispatcher when destroyed.
 
template<typename T , typename Method >
bool connectAction (const std::string &_actionName, T *_instance, Method &&_method, const ot::MessageTypeFlags &_messageFlags=ot::DEFAULT_MESSAGE_TYPE, const ActionDispatcherBase::InsertFlags &_insertFlags=ActionDispatcherBase::NoFlags)
 Creates a new [handler] and registers it at the currently set [action dispatcher]. The ActionHandler will take ownership of the created handler and will remove it from the dispatcher when destroyed.
 
template<typename T , typename Method >
bool connectAction (const std::initializer_list< std::string > &_actionNames, T *_instance, Method &&_method, const ot::MessageTypeFlags &_messageFlags=ot::DEFAULT_MESSAGE_TYPE, const ActionDispatcherBase::InsertFlags &_insertFlags=ActionDispatcherBase::NoFlags)
 Creates a new [handler] and registers it at the currently set [action dispatcher]. The ActionHandler will take ownership of the created handler and will remove it from the dispatcher when destroyed.
 
template<typename T , typename Method >
bool connectAction (const std::list< std::string > &_actionNames, T *_instance, Method &&_method, const ot::MessageTypeFlags &_messageFlags=ot::DEFAULT_MESSAGE_TYPE, const ActionDispatcherBase::InsertFlags &_insertFlags=ActionDispatcherBase::NoFlags)
 Creates a new [handler] and registers it at the currently set [action dispatcher]. The ActionHandler will take ownership of the created handler and will remove it from the dispatcher when destroyed.
 
- Public Member Functions inherited from ot::MessageBoxHandler
 MessageBoxHandler ()
 
virtual ~MessageBoxHandler ()
 

Static Public Member Functions

static AppBase & instance (void)
 
static AppBase * instance ()
 
static AppBase * instance (QApplication *_app=(QApplication *) nullptr)
 
- Static Public Member Functions inherited from ot::WindowAPI
static QWidget * getRootWidget ()
 
static void lockUI (bool _flag=true)
 
static void unlockUI ()
 
static void lockSelectionAndModification (bool _flag)
 
static void setProgressBarVisibility (QString _progressMessage, bool _progressBaseVisible, bool _continuous)
 Will turn on or off the progress bar visibility and set the progress message.
 
static void setProgressBarValue (int _progressPercentage)
 Will set the percentage of the progress bar.
 
static void showInfoPrompt (const std::string &_title, const std::string &_message, const std::string &_detailedMessage=std::string())
 
static void showWarningPrompt (const std::string &_title, const std::string &_message, const std::string &_detailedMessage=std::string())
 
static void showErrorPrompt (const std::string &_title, const std::string &_message, const std::string &_detailedMessage=std::string())
 
static void appendOutputMessage (const std::string &_message)
 
static void appendOutputMessage (const StyledTextBuilder &_message)
 
- Static Public Member Functions inherited from ot::CommunicationAPI
static void setDefaultConnectorServiceUrl (const std::string &_url)
 
static bool sendExecute (const std::string &_message, std::string &_response)
 
static bool sendQueue (const std::string &_message)
 
static bool sendExecute (const std::string &_receiverUrl, const std::string &_message, std::string &_response)
 
static bool sendQueue (const std::string &_receiverUrl, const std::string &_message)
 
static bool sendExecuteToService (const BasicServiceInformation &_serviceInfo, const std::string &_message, std::string &_response)
 
static bool sendQueueToService (const BasicServiceInformation &_serviceInfo, const std::string &_message)
 
- Static Public Member Functions inherited from ot::CurrentProjectAPI
static void activateModelVersion (const std::string &_versionName)
 

Protected Member Functions

virtual QWidget * getRootWidgetAPI () override
 
virtual void lockUIAPI (bool _flag) override
 
virtual void lockSelectionAndModificationAPI (bool _flag) override
 
virtual void setProgressBarVisibilityAPI (QString _progressMessage, bool _progressBaseVisible, bool _continuous) override
 
virtual void setProgressBarValueAPI (int _progressPercentage) override
 
virtual void showInfoPromptAPI (const std::string &_title, const std::string &_message, const std::string &_detailedMessage) override
 
virtual void showWarningPromptAPI (const std::string &_title, const std::string &_message, const std::string &_detailedMessage) override
 
virtual void showErrorPromptAPI (const std::string &_title, const std::string &_message, const std::string &_detailedMessage) override
 
virtual void appendOutputMessageAPI (const std::string &_message) override
 
virtual void appendOutputMessageAPI (const ot::StyledTextBuilder &_message) override
 
virtual bool sendExecuteAPI (const std::string &_receiverUrl, const std::string &_message, std::string &_response) override
 
virtual bool sendQueueAPI (const std::string &_receiverUrl, const std::string &_message) override
 
virtual bool sendExecuteToServiceAPI (const ot::BasicServiceInformation &_serviceInfo, const std::string &_message, std::string &_response) override
 
virtual bool sendQueueToServiceAPI (const ot::BasicServiceInformation &_serviceInfo, const std::string &_message) override
 
virtual void activateModelVersionAPI (const std::string &_versionName) override
 
- Protected Member Functions inherited from ot::WindowAPI
 WindowAPI ()
 
virtual ~WindowAPI ()
 
- Protected Member Functions inherited from ot::CommunicationAPI
 CommunicationAPI ()
 
virtual ~CommunicationAPI ()
 
- Protected Member Functions inherited from ot::CurrentProjectAPI
 CurrentProjectAPI ()
 
virtual ~CurrentProjectAPI ()
 
- Protected Member Functions inherited from otoolkit::APIInterface
 APIInterface ()
 
virtual ~APIInterface ()
 

Private Member Functions

virtual ~AppBase ()
 

Friends

class ToolBar
 
class KeyboardCommandHandler
 

Detailed Description

The API manager is used to manage the global objects required for this API to work.

Member Enumeration Documentation

◆ StartOption

enum AppBase::StartOption
Enumerator
LogExport 
NoAutoStart 

Constructor & Destructor Documentation

◆ ~AppBase()

virtual AppBase::~AppBase ( )
virtual

Deconstructor.

Member Function Documentation

◆ activateModelVersionAPI()

void AppBase::activateModelVersionAPI ( const std::string & _versionName)
overrideprotectedvirtual

Implements ot::CurrentProjectAPI.

References slotRequestVersion().

◆ activateToolBarTab

void AppBase::activateToolBarTab ( const QString & _tab)
slot

◆ addGraphicsPickerPackage()

void AppBase::addGraphicsPickerPackage ( const ot::GraphicsPickerCollectionPackage & _pckg)

References ot::GraphicsPickerManager::addCollections(), ot::GraphicsPickerCollectionPackage::getCollections(), and ot::GraphicsPickerCollectionPackage::getPickerKey().

◆ addNavigationTreeItem

ot::UID AppBase::addNavigationTreeItem ( const ot::EntityTreeItem & _itemInfo)
slot

References ot::NavigationTreeView::getTree().

◆ addTool()

bool AppBase::addTool ( otoolkit::Tool * _tool)
overridevirtual

Implements otoolkit::APIInterface.

References ToolManager::addTool().

◆ appendHtmlInfoMessage

void AppBase::appendHtmlInfoMessage ( const QString & _html)
slot

Append an HTML formatted message to the output.

Parameters
_htmlThe HTML formatted message to append.

References ot::PlainTextEditView::getPlainTextEdit().

◆ appendInfoMessage

void AppBase::appendInfoMessage ( const QString & _message)
slot

Append a plain text message to the output.

Parameters
_messageThe message to append.

References ot::PlainTextEditView::getPlainTextEdit().

◆ appendLogMessage()

void AppBase::appendLogMessage ( const ot::LogMessage & _message)

Append a log message to the output. The following information will be used from the log message:

  • Message Type
  • Service Name
  • Text
    Parameters
    _messageThe log message to append.

References ot::WindowAPI::appendOutputMessage(), ot::LogMessage::getFlags(), ot::LogMessage::getServiceName(), ot::LogMessage::getText(), ot::TEST_LOG, and ot::WARNING_LOG.

◆ appendOutputMessageAPI() [1/2]

void AppBase::appendOutputMessageAPI ( const ot::StyledTextBuilder & _message)
overrideprotectedvirtual

Implements ot::WindowAPI.

References appendHtmlInfoMessage(), and ot::StyledTextConverter::toHtml().

◆ appendOutputMessageAPI() [2/2]

void AppBase::appendOutputMessageAPI ( const std::string & _message)
overrideprotectedvirtual

Implements ot::WindowAPI.

References appendInfoMessage().

◆ applicationInstance()

QApplication * AppBase::applicationInstance ( )
inline

◆ autoCloseUnpinnedViews()

void AppBase::autoCloseUnpinnedViews ( bool _ignoreCurrent)

References getSelectedNavigationTreeItems(), ot::GlobalWidgetViewManager::instance(), OT_SLECTION_TEST_LOG, ot::WidgetViewManager::requestCloseUnpinnedViews(), ot::WidgetViewBase::ViewIsCloseable, and ot::WidgetViewBase::ViewIsPinnable.

◆ clearGraphicsPickerData()

void AppBase::clearGraphicsPickerData ( )

Clears the graphics picker and stored service picker data.

References ot::GraphicsPickerManager::clear().

◆ clearModalPropertyGrid()

void AppBase::clearModalPropertyGrid ( )

References ot::PropertyGrid::clear(), ot::PropertyGrid::getIsModal(), ot::PropertyGridView::getPropertyGrid(), and OT_LOG_W.

◆ clearNavigationTree

void AppBase::clearNavigationTree ( )
slot

References ot::NavigationTreeView::getTree().

◆ clearNavigationTreeSelection

void AppBase::clearNavigationTreeSelection ( )
slot

References ot::NavigationTreeView::getTree().

◆ clearPropertyGrid()

void AppBase::clearPropertyGrid ( )

References ot::PropertyGrid::clear(), and ot::PropertyGridView::getPropertyGrid().

◆ clearSessionInformation()

void AppBase::clearSessionInformation ( )

Will clear the session information such as the project name, collection name and user name.

◆ closeAllTextEditors()

void AppBase::closeAllTextEditors ( const ot::BasicServiceInformation & _serviceInfo)

References closeTextEditor(), ot::WidgetViewManager::getViewNamesFromOwner(), ot::GlobalWidgetViewManager::instance(), and ot::WidgetViewBase::ViewText.

◆ closeAllViewerTabs()

void AppBase::closeAllViewerTabs ( )

References ot::WidgetViewManager::closeViews(), ot::VersionGraphManager::getGraph(), ot::VersionGraphManagerView::getVersionGraphManager(), ot::WidgetView::getViewDockWidget(), ot::GlobalWidgetViewManager::instance(), lockManager(), ot::WidgetViewManager::slotViewFocused(), LockManager::uiElementDestroyed(), and LockManager::uiViewDestroyed().

◆ closeEvent() [1/2]

bool AppBase::closeEvent ( )
overridevirtual

References ot::MessageDialogCfg::Cancel, closeAllViewerTabs(), ExternalServicesComponent::closeProject(), ot::WidgetViewManager::closeViews(), getCurrentProjectIsModified(), ot::ProjectInformation::getProjectName(), ot::GlobalWidgetViewManager::instance(), ak::invalidUID, ot::MessageDialogCfg::No, result, ExternalServicesComponent::saveProject(), ViewStateCfg::setViewConfig(), showPrompt(), STATE_NAME_VIEW, STATE_NAME_WINDOW, UserManagement::storeSetting(), WelcomeWidget::storeViewModeSetting(), ViewStateCfg::toJson(), ot::MessageDialogCfg::Warning, and ot::MessageDialogCfg::Yes.

◆ closeEvent() [2/2]

void AppBase::closeEvent ( QCloseEvent * _event)
overridevirtual

References ToolManager::clear(), createSettingsInstance(), ot::GlobalWidgetViewManager::instance(), and ToolManager::stopAll().

◆ closeGraphicsEditor()

void AppBase::closeGraphicsEditor ( const std::string & _entityName)

References ot::WidgetViewManager::closeView(), findGraphicsEditor(), and ot::GlobalWidgetViewManager::instance().

◆ closePlot()

void AppBase::closePlot ( const std::string & _name)

References ot::WidgetViewManager::closeView(), findPlot(), and ot::GlobalWidgetViewManager::instance().

◆ closeTable()

void AppBase::closeTable ( const std::string & _name)

References ot::WidgetViewManager::closeView(), findTable(), and ot::GlobalWidgetViewManager::instance().

◆ closeTextEditor()

void AppBase::closeTextEditor ( const std::string & _entityName)

References ot::WidgetViewManager::closeView(), findTextEditor(), and ot::GlobalWidgetViewManager::instance().

◆ controlsManager()

ControlsManager * AppBase::controlsManager ( )

References ExternalServicesComponent::controlsManager(), and OTAssertNullptr.

◆ createModel()

ModelUIDtype AppBase::createModel ( )

References ViewerComponent::createModel(), and ViewerComponent::setDataModel().

◆ createNewGraphicsEditor()

ot::GraphicsViewView * AppBase::createNewGraphicsEditor ( const std::string & _entityName,
const QString & _title,
const std::string & _pickerKey,
const ot::WidgetView::InsertFlags & _viewInsertFlags,
const ot::VisualisationCfg & _visualizationConfig )

References ot::WidgetViewManager::addView(), ot::All, ot::Grid::AutoScaleGrid, ot::GraphicsView::connectionRequested(), ot::GraphicsView::connectionToConnectionRequested(), ot::GraphicsView::copyRequested(), ot::DotLine, ot::GraphicsView::elementsChanged(), findGraphicsEditor(), ot::VisualisationCfg::getCustomViewFlags(), ot::GraphicsView::getGraphicsScene(), ot::GraphicsViewView::getGraphicsView(), ot::VisualisationCfg::getVisualisingEntities(), ot::GlobalWidgetViewManager::instance(), ot::GraphicsView::itemDoubleClicked(), ot::GraphicsView::itemRequested(), lockManager(), ot::ModelWrite, OT_INFO_SERVICE_TYPE_MODEL, OT_LOG_D, OT_LOG_EAS, ot::GraphicsView::pasteRequested(), ot::RoundCap, ot::GraphicsScene::selectionChangeFinished(), ot::PenFCfg::setCap(), ot::GraphicsView::setDropsEnabled(), ot::GraphicsView::setGraphicsViewFlag(), ot::GraphicsView::setGraphicsViewName(), ot::GraphicsScene::setGridFlags(), ot::GraphicsScene::setGridLineStyle(), ot::GraphicsScene::setGridSnapMode(), ot::GraphicsView::setPickerKey(), ot::GraphicsView::setSceneMargins(), ot::PenFCfg::setStyle(), ot::WidgetView::setViewData(), ot::WidgetViewBase::setViewFlags(), ot::PenFCfg::setWidth(), ot::Grid::ShowNormalLines, slotCopyRequested(), slotGraphicsConnectionRequested(), slotGraphicsConnectionToConnectionRequested(), slotGraphicsElementsChanged(), slotGraphicsItemDoubleClicked(), slotGraphicsItemRequested(), slotGraphicsSelectionChanged(), slotPasteRequested(), ot::Grid::SnapTopLeft, LockManager::uiElementCreated(), ot::WidgetViewBase::ViewGraphics, ot::WidgetViewBase::ViewIsCentral, ot::WidgetViewBase::ViewIsCloseable, ot::WidgetViewBase::ViewIsPinnable, ot::GraphicsView::ViewManagesSceneRect, and ot::WidgetViewBase::ViewNameAsTitle.

◆ createNewPlot()

ot::PlotView * AppBase::createNewPlot ( const ot::Plot1DCfg & _config,
const ot::WidgetView::InsertFlags & _viewInsertFlags,
const ot::UIDList & _visualizingEntities )

References ot::WidgetViewManager::addView(), ot::All, ot::PlotBase::curveDoubleClicked(), findPlot(), ot::BasicEntityInformation::getEntityName(), ot::PlotView::getPlot(), ot::GlobalWidgetViewManager::instance(), lockManager(), ot::ModelWrite, OT_INFO_SERVICE_TYPE_MODEL, OT_LOG_D, OT_LOG_EAS, ot::PlotBase::resetItemSelectionRequest(), ot::WidgetView::setViewData(), slotPlotCurveDoubleClicked(), slotPlotResetItemSelectionRequest(), LockManager::uiViewCreated(), and ot::WidgetViewBase::View1D.

◆ createNewProjectInDatabase()

bool AppBase::createNewProjectInDatabase ( const QString & _projectName,
const QString & _projectType )

References ProjectManagement::createProject(), LoginData::getUserName(), and ProjectManagement::InitializeConnection().

◆ createNewTable()

ot::TableView * AppBase::createNewTable ( const ot::TableCfg & _config,
const ot::WidgetView::InsertFlags & _viewInsertFlags,
const ot::UIDList & _visualizingEntities )

References ot::WidgetViewManager::addView(), ot::All, findTable(), ot::BasicEntityInformation::getEntityName(), ot::TableView::getTable(), ot::GlobalWidgetViewManager::instance(), lockManager(), ot::ModelWrite, OT_INFO_SERVICE_TYPE_MODEL, OT_LOG_D, OT_LOG_EAS, ot::Table::saveRequested(), ot::Table::setMultilineCells(), ot::Table::setupFromConfig(), ot::WidgetView::setViewData(), slotTableSaveRequested(), LockManager::uiViewCreated(), and ot::WidgetViewBase::ViewTable.

◆ createNewTextEditor()

ot::TextEditorView * AppBase::createNewTextEditor ( const ot::TextEditorCfg & _config,
const ot::WidgetView::InsertFlags & _viewInsertFlags,
const ot::UIDList & _visualizingEntities )

References ot::WidgetViewManager::addView(), ot::All, findTextEditor(), ot::BasicEntityInformation::getEntityName(), ot::TextEditorView::getTextEditor(), ot::GlobalWidgetViewManager::instance(), ot::TextEditor::loadAllRequested(), ot::TextEditor::loadMoreRequested(), lockManager(), ot::ModelWrite, OT_INFO_SERVICE_TYPE_MODEL, OT_LOG_D, OT_LOG_EAS, ot::TextEditorView::saveRequested(), ot::TextEditor::setupFromConfig(), ot::WidgetView::setViewData(), slotTextEditorSaveRequested(), slotTextLoadAllRequested(), slotTextLoadNextRequested(), LockManager::uiElementCreated(), and ot::WidgetViewBase::ViewText.

◆ createSettingsInstance() [1/2]

otoolkit::SettingsRef AppBase::createSettingsInstance ( void ) const

◆ createSettingsInstance() [2/2]

virtual otoolkit::SettingsRef AppBase::createSettingsInstance ( )
overridevirtual

Implements otoolkit::APIInterface.

◆ createUi()

void AppBase::createUi ( )

References ot::WidgetViewManager::addView(), ot::All, ot::WidgetViewBase::Bottom, BUILD_INFO, WelcomeWidget::copyProjectRequest(), ot::NavigationTreeView::copyRequested(), WelcomeWidget::createProjectRequest(), ot::WidgetViewBase::CustomView, ot::WidgetViewBase::Default, WelcomeWidget::deleteProjectRequest(), e, WelcomeWidget::exportProjectRequest(), ot::ServiceBase::getBasicServiceInformation(), LoginData::getDatabaseUrl(), ot::WidgetViewManager::getDockManager(), ot::GraphicsPickerView::getGraphicsPicker(), ot::PlainTextEditView::getPlainTextEdit(), ot::PropertyGridView::getPropertyGrid(), WelcomeWidget::getQWidget(), LoginData::getSessionPassword(), LoginData::getSessionUser(), ToolBar::getStartPage(), ot::NavigationTreeView::getTree(), ot::WidgetView::getViewDockWidget(), ot::WidgetViewManager::IgnoreInputFocusOnViewInsert, ot::WidgetViewManager::InputFocusCentralViewOnFocusChange, ot::GlobalWidgetViewManager::instance(), ot::WidgetViewBase::Left, lockManager(), ExternalServicesComponent::lockManager(), ot::ModelWrite, ot::NavigationAll, ot::NavigationWrite, OBJ_ALIAS_MainWindow, WelcomeWidget::openProjectRequest(), OT_LOG_D, OT_LOG_E, OTAssertNullptr, ot::NavigationTreeView::pasteRequested(), WelcomeWidget::projectAccessRequest(), WelcomeWidget::projectOwnerRequest(), ot::Properties, ot::PropertyGrid::propertyChanged(), ot::PropertyGrid::propertyDeleteRequested(), LockManager::registerLockable(), ot::Flags< T, Storage >::remove(), WelcomeWidget::renameProjectRequest(), ot::WidgetViewBase::Right, ot::NavigationSelectionManager::selectionHasChanged(), ot::Flags< T, Storage >::set(), ot::WidgetView::setAsCurrentViewTab(), ot::PlainTextEdit::setAutoScrollToBottomEnabled(), ot::WidgetViewManager::setConfigFlags(), ViewerComponent::setDataBaseConnectionInformation(), ViewerComponent::setFontPath(), ot::StyledSvgWidget::setMaintainAspectRatio(), ot::GraphicsPickerManager::setPicker(), ot::WidgetView::setViewData(), ot::WidgetView::setViewIsPermanent(), slotCopyProject(), slotCopyRequested(), slotCreateProject(), slotDeleteProject(), slotExportProject(), slotHandleSelectionHasChanged(), slotManageProjectAccess(), slotManageProjectOwner(), slotOpenProject(), slotPasteRequested(), slotPropertyGridValueChanged(), slotPropertyGridValueDeleteRequested(), WelcomeWidget::slotRefreshProjectList(), slotRenameProject(), slotShowErrorPrompt(), slotShowOutputContextMenu(), slotTreeItemFocused(), slotTreeItemSelectionChanged(), slotTreeItemTextChanged(), slotViewAdded(), slotViewCloseRequested(), slotViewDataModifiedChanged(), slotViewFocusChanged(), slotViewTabClicked(), TITLE_DOCK_OUTPUT, TITLE_DOCK_PROJECTNAVIGATION, TITLE_DOCK_PROPERTIES, ToolBar, toolBarAvailable(), LockManager::uiElementCreated(), LockManager::uiViewCreated(), updateLogIntensityInfo(), ot::WidgetViewManager::UseBestAreaFinderOnViewInsert, ot::WidgetViewManager::viewAdded(), ot::WidgetViewManager::viewCloseRequested(), ot::WidgetViewManager::viewDataModifiedChanged(), ot::WidgetViewBase::ViewDefaultCloseHandling, ot::WidgetViewManager::viewFocusChanged(), ot::WidgetViewBase::ViewGraphicsPicker, ot::WidgetViewBase::ViewIsCentral, ot::WidgetViewBase::ViewIsCloseable, ot::WidgetViewBase::ViewIsSide, ot::WidgetViewBase::ViewNavigation, ot::WidgetViewBase::ViewProperties, ot::WidgetViewManager::viewTabClicked(), ot::WidgetViewBase::ViewText, and WAITING_ANIMATION_NAME.

◆ createView()

ViewerUIDtype AppBase::createView ( ModelUIDtype _modelUID,
const std::string & _projectName )

References ot::WidgetViewManager::addView(), ot::All, ot::Color::b(), ot::WidgetViewBase::Bottom, ViewerComponent::createViewer(), determineAvailableViewTabText(), ot::Color::g(), ot::ServiceBase::getBasicServiceInformation(), ot::ProjectInformation::getCollectionName(), getCurrentProjectInfo(), LoginData::getDatabaseUrl(), ot::WidgetViewManager::getDockManager(), ot::VersionGraphManager::getGraph(), ot::GraphicsPickerView::getGraphicsPicker(), ot::GraphicsPicker::getQWidget(), LoginData::getSessionPassword(), LoginData::getSessionUser(), ot::VersionGraphManagerView::getVersionGraphManager(), getViewerComponent(), ViewerComponent::getViewerWidget(), ot::WidgetView::getViewWidget(), getVisible3D(), getVisibleBlockPicker(), ot::VersionGraph::IgnoreActivateRequestOnReadOnly, DataBase::initializeConnection(), DataBase::instance(), ot::GlobalWidgetViewManager::instance(), instance(), ot::WidgetView::KeepCurrentFocus, lockManager(), ot::ModelWrite, OT_LOG_EA, ot::Color::r(), DataBase::setCollectionName(), DataBase::setUserCredentials(), ot::VersionGraph::setVersionGraphConfigFlags(), ot::WidgetView::setViewData(), slotRequestVersion(), slotVersionDeselected(), slotVersionSelected(), LockManager::uiElementCreated(), LockManager::uiElementDestroyed(), ot::VersionGraph::versionActivateRequest(), ot::VersionGraph::versionDeselected(), ot::VersionGraph::versionSelected(), ot::WidgetViewBase::View3D, ot::WidgetViewBase::ViewIsCentral, ot::WidgetViewBase::ViewIsSide, and ot::WidgetViewBase::ViewVersion.

◆ customQueueCallback

void AppBase::customQueueCallback ( const QString & _callbackID)
signal

◆ customTimerTimeout

void AppBase::customTimerTimeout ( const QString & _timerID)
signal

◆ debug()

bool AppBase::debug ( ) const

◆ destroyObjects()

void AppBase::destroyObjects ( const std::vector< ot::UID > & _objects)

◆ determineAvailableViewTabText

QString AppBase::determineAvailableViewTabText ( const QString & _initialTabText)
slot

References ot::GlobalWidgetViewManager::instance().

◆ downloadInstaller

void AppBase::downloadInstaller ( QString gssUrl)
slot

Downloads the installer from the provided GSS URL and runs it.

References downloadFrontendInstaller(), ot::IconManager::getApplicationIcon(), ot::SystemProcess::runApplication(), and ot::AppExitCode::Success.

◆ editProjectInformation()

void AppBase::editProjectInformation ( const std::string & _senderUrl,
const std::string & _callbackAction )

References _senderUrl, ot::ProjectInformation::getProjectName(), mainWindow(), and ot::Dialog::showDialog().

◆ expandSingleNavigationTreeItem

void AppBase::expandSingleNavigationTreeItem ( ot::UID _itemID,
bool _isExpanded )
slot

References ot::NavigationTreeView::getTree().

◆ exportLogs()

void AppBase::exportLogs ( )

References ot::JsonDocument::constRef(), createSettingsInstance(), ot::msg::DefaultFlagsNoExit, ot::msg::defaultTimeout, ot::EXECUTE_ONE_WAY_TLS, ot::exportLogMessagesToString(), ot::JsonDocument::fromJson(), ot::ReturnMessage::fromJson(), ot::json::getObject(), LoginData::getUserName(), ot::ReturnMessage::getWhat(), ot::ServiceLogNotifier::instance(), mainWindow(), ot::ReturnMessage::Ok, OT_ACTION_CMD_GetUserLogs, OT_ACTION_MEMBER, OT_ACTION_PARAM_USER_NAME, OT_LOG_E, ot::msg::send(), ot::LogMessage::setFromJsonObject(), slotShowErrorPrompt(), slotShowInfoPrompt(), and ot::JsonDocument::toJson().

◆ findGraphicsEditor()

ot::GraphicsViewView * AppBase::findGraphicsEditor ( const std::string & _entityName,
const ot::UIDList & _visualizingEntities )

◆ findNavigationTreeItemByName

ot::UID AppBase::findNavigationTreeItemByName ( const QString & _itemName)
slot

References ot::NavigationTreeView::getTree().

◆ findOrCreateGraphicsEditor()

ot::GraphicsViewView * AppBase::findOrCreateGraphicsEditor ( const std::string & _entityName,
const QString & _title,
const std::string & _pickerKey,
const ot::WidgetView::InsertFlags & _viewInsertFlags,
const ot::VisualisationCfg & _visualizationConfig )

References createNewGraphicsEditor(), findGraphicsEditor(), ot::VisualisationCfg::getVisualisingEntities(), and OT_LOG_D.

◆ findOrCreatePlot()

ot::PlotView * AppBase::findOrCreatePlot ( const ot::Plot1DCfg & _config,
const ot::WidgetView::InsertFlags & _viewInsertFlags,
const ot::UIDList & _visualizingEntities )

References createNewPlot(), findPlot(), ot::BasicEntityInformation::getEntityName(), and OT_LOG_D.

◆ findOrCreateTable()

ot::TableView * AppBase::findOrCreateTable ( const ot::TableCfg & _config,
const ot::WidgetView::InsertFlags & _viewInsertFlags,
const ot::UIDList & _visualizingEntities )

References createNewTable(), findTable(), ot::BasicEntityInformation::getEntityName(), ot::TableView::getTable(), OT_LOG_D, and ot::Table::setupFromConfig().

◆ findOrCreateTextEditor()

ot::TextEditorView * AppBase::findOrCreateTextEditor ( const ot::TextEditorCfg & _config,
const ot::WidgetView::InsertFlags & _viewInsertFlags,
const ot::UIDList & _visualizingEntities )

References createNewTextEditor(), findTextEditor(), ot::BasicEntityInformation::getEntityName(), and OT_LOG_D.

◆ findPlot()

ot::PlotView * AppBase::findPlot ( const std::string & _entityName,
const ot::UIDList & _visualizingEntities )

◆ findProperty() [1/2]

ot::PropertyGridItem * AppBase::findProperty ( const std::list< std::string > & _groupPath,
const std::string & _itemName )

References ot::PropertyGrid::findItem(), and ot::PropertyGridView::getPropertyGrid().

◆ findProperty() [2/2]

ot::PropertyGridItem * AppBase::findProperty ( const std::string & _groupName,
const std::string & _itemName )

References ot::PropertyGrid::findItem(), and ot::PropertyGridView::getPropertyGrid().

◆ findTable()

ot::TableView * AppBase::findTable ( const std::string & _entityName,
const ot::UIDList & _visualizingEntities )

◆ findTextEditor()

ot::TextEditorView * AppBase::findTextEditor ( const std::string & _entityName,
const ot::UIDList & _visualizingEntities )

◆ focusPropertyGridItem()

void AppBase::focusPropertyGridItem ( const std::string & _group,
const std::string & _name )

References ot::PropertyGrid::focusProperty(), ot::PropertyGridView::getPropertyGrid(), and OTAssertNullptr.

◆ frontendSettingsChanged()

void AppBase::frontendSettingsChanged ( const ot::Property * _property)

References ot::PropertyStringList::getCurrent(), ot::Property::getPropertyPath(), ot::GlobalColorStyle::instance(), OT_LOG_EA, and ot::GlobalColorStyle::setCurrentStyle().

◆ getAllGraphicsEditors()

std::list< ot::GraphicsViewView * > AppBase::getAllGraphicsEditors ( )

References ot::ContainerHelper::getValues().

◆ getAvailableProjectNames

QStringList AppBase::getAvailableProjectNames ( ) const
slot

References WelcomeWidget::getAllProjects(), OT_LOG_EA, and result.

◆ getCurrentLoginData()

const LoginData & AppBase::getCurrentLoginData ( ) const
inline

Will return the current username.

◆ getCurrentMenuTab()

std::string AppBase::getCurrentMenuTab ( )

◆ getCurrentProjectInfo()

const ot::ProjectInformation & AppBase::getCurrentProjectInfo ( ) const
inline

◆ getCurrentProjectIsModified()

bool AppBase::getCurrentProjectIsModified ( ) const

Will get the current project as modified state.

References ot::WidgetViewManager::getAnyViewContentModified(), and ot::GlobalWidgetViewManager::instance().

◆ getCurrentUserCollection()

std::string AppBase::getCurrentUserCollection ( ) const
inline

Will return the current username.

◆ getCurrentVisualizationTabTitle()

std::string AppBase::getCurrentVisualizationTabTitle ( )

References ot::WidgetViewManager::getLastFocusedCentralView(), ot::WidgetViewBase::getTitle(), ot::WidgetView::getViewData(), and ot::GlobalWidgetViewManager::instance().

◆ getDebugInformation()

std::string AppBase::getDebugInformation ( ) const

References LoginData::getAuthorizationUrl(), ot::ProjectInformation::getCollectionName(), LogInGSSEntry::getConnectionUrl(), LoginData::getDatabaseUrl(), ot::WidgetViewManager::getDebugInformation(), ViewerComponent::getDebugInformation(), LockManager::getDebugInformation(), LoginData::getEncryptedUserPassword(), LoginData::getGss(), ot::ProjectInformation::getProjectName(), ot::ProjectInformation::getProjectType(), LoginData::getSessionPassword(), LoginData::getSessionUser(), LoginData::getUserName(), LoginData::getUserPassword(), ot::GlobalWidgetViewManager::instance(), ExternalServicesComponent::lockManager(), and ot::JsonDocument::toJson().

◆ getExternalServicesComponent()

ExternalServicesComponent * AppBase::getExternalServicesComponent ( ) const
inline

◆ getIgnoreToolAutoStart()

bool AppBase::getIgnoreToolAutoStart ( ) const
inline

◆ getModelUID()

ot::UID AppBase::getModelUID ( ) const
inline

◆ getNavigationTreeItemText

QString AppBase::getNavigationTreeItemText ( ot::UID _itemID)
slot

References ot::NavigationTreeView::getTree().

◆ getProjectNavigation()

ot::NavigationTreeView * AppBase::getProjectNavigation ( ) const
inline

◆ getPropertyIsDeletable()

bool AppBase::getPropertyIsDeletable ( const std::string & _groupName,
const std::string & _itemName )

References ot::PropertyGrid::findItem(), ot::PropertyGridItem::getPropertyData(), ot::PropertyBase::getPropertyFlags(), ot::PropertyGridView::getPropertyGrid(), ot::PropertyBase::IsDeletable, and OT_LOG_E.

◆ getPropertyType()

std::string AppBase::getPropertyType ( const std::string & _groupName,
const std::string & _itemName )

References ot::PropertyGrid::findItem(), ot::PropertyGridView::getPropertyGrid(), ot::PropertyGridItem::getPropertyType(), and OT_LOG_E.

◆ getRelayURLs()

std::string AppBase::getRelayURLs ( ) const

Will return the current Relay URLs.

◆ getRootWidgetAPI()

QWidget * AppBase::getRootWidgetAPI ( )
overrideprotectedvirtual

Implements ot::WindowAPI.

References mainWindow().

◆ getSelectedNavigationTreeItems

const ot::SelectionInformation & AppBase::getSelectedNavigationTreeItems ( )
slot

References ot::NavigationSelectionManager::getSelectionInformation().

◆ getServiceURL()

const std::string & AppBase::getServiceURL ( ) const
inline

Will return the current Service URL.

◆ getSessionServiceURL()

const std::string & AppBase::getSessionServiceURL ( ) const
inline

Will return the session service URL.

◆ getSettingsFromDataBase()

ot::PropertyGridCfg AppBase::getSettingsFromDataBase ( const std::string & _subKey)

References ot::JsonDocument::fromJson(), ot::JsonDocument::getConstObject(), UserManagement::restoreSetting(), and ot::PropertyGridCfg::setFromJsonObject().

◆ getSiteID()

int AppBase::getSiteID ( ) const
inline

Will return the current site ID.

◆ getToolBar()

ToolBar * AppBase::getToolBar ( ) const
inline

◆ getUiServiceUID()

ot::UID AppBase::getUiServiceUID ( ) const
inline

◆ getUpdateTransparentColorStyleValueEnabled()

bool AppBase::getUpdateTransparentColorStyleValueEnabled ( ) const
inline

◆ getVersionGraph()

ot::VersionGraphManagerView * AppBase::getVersionGraph ( )
inline

◆ getViewerComponent()

ViewerComponent * AppBase::getViewerComponent ( ) const
inline

◆ getViewerUID()

ot::UID AppBase::getViewerUID ( ) const
inline

◆ getViewHandlingFlags()

const ot::ViewHandlingFlags & AppBase::getViewHandlingFlags ( ) const
inline

◆ getVisible3D()

bool AppBase::getVisible3D ( ) const
inline

◆ getVisibleBlockPicker()

bool AppBase::getVisibleBlockPicker ( ) const
inline

◆ getWelcomeScreenViewMode()

ot::ProjectOverviewWidget::ViewMode AppBase::getWelcomeScreenViewMode ( ) const

References WelcomeWidget::getViewMode(), and ot::ProjectOverviewWidget::Tree.

◆ handleClear()

void AppBase::handleClear ( )

◆ handleDeregister()

void AppBase::handleDeregister ( ot::JsonDocument & _jsonDocument)

References ot::json::getString(), and OT_ACTION_PARAM_SERVICE_URL.

◆ handleGetAllLogs()

ot::ReturnMessage AppBase::handleGetAllLogs ( )

References ot::ReturnMessage::Ok, and ot::JsonDocument::toJson().

◆ handleGetDebugInfo()

std::string AppBase::handleGetDebugInfo ( )

References ot::JsonDocument::toJson().

◆ handleGetUserLogs()

ot::ReturnMessage AppBase::handleGetUserLogs ( ot::JsonDocument & _jsonDocument)

References ot::ReturnMessage::Failed, ot::json::getString(), ot::ReturnMessage::Ok, OT_ACTION_PARAM_USER_NAME, and ot::JsonDocument::toJson().

◆ handleLog()

void AppBase::handleLog ( ot::JsonDocument & _jsonDocument)

References ot::json::getObject(), ot::LogMessage::getText(), OT_ACTION_PARAM_LOG, OT_ACTION_PASSWORD_SUBTEXT, intern::replacePasswords(), ot::LogMessage::setCurrentTimeAsGlobalSystemTime(), ot::LogMessage::setFromJsonObject(), and ot::LogMessage::setText().

◆ handleRegister()

std::string AppBase::handleRegister ( ot::JsonDocument & _jsonDocument)

References ot::json::getString(), OT_ACTION_PARAM_SERVICE_URL, and ot::JsonDocument::toJson().

◆ handleSetCacheSize()

void AppBase::handleSetCacheSize ( ot::JsonDocument & _jsonDocument)

References ot::json::getUInt64(), and OT_ACTION_PARAM_Size.

◆ handleSetGlobalLogFlags()

void AppBase::handleSetGlobalLogFlags ( ot::JsonDocument & _jsonDocument)

References flags, ot::json::getArray(), ot::logFlagsFromJsonArray(), OT_ACTION_PARAM_Flags, and updateBufferSizeFromLogFlags().

◆ importProject()

void AppBase::importProject ( )

References LoginData::getUserName(), ProjectManagement::InitializeConnection(), ProjectManagement::projectExists(), and slotLockUI().

◆ initialize()

bool AppBase::initialize ( )

Will initialize the API Returns: 0: OK -1: Was already initialized 1: Exception catched 2: Non exception catched 3: Log-in failed.

References ot::GlobalColorStyle::currentStyleChanged(), e, ot::IconManager::fileExists(), ot::IconManager::getIcon(), ot::GlobalColorStyle::instance(), OT_LOG_E, OT_UISERVICE_DEV_LOGGER_INIT, OTAssert, ot::IconManager::setDefaultProjectIcon(), and slotColorStyleChanged().

◆ initializeDefaultUserSettings()

void AppBase::initializeDefaultUserSettings ( )

References ot::PropertyGroup::addProperty(), ot::PropertyGridCfg::addRootGroup(), UserSettings::addSettings(), ot::BlueStyle, ot::BrightStyle, ot::DarkStyle, ot::GlobalColorStyle::instance(), UserSettings::instance(), and ot::toString().

◆ instance() [1/3]

static AppBase * AppBase::instance ( )
static

◆ instance() [2/3]

AppBase * AppBase::instance ( QApplication * _app = (QApplication*)nullptr)
static

References g_instance.

◆ instance() [3/3]

AppBase * AppBase::instance ( void )
static

References g_instance.

◆ isInitialized()

bool AppBase::isInitialized ( ) const

Returns true if the API was initialized.

◆ isTreeItemExpanded

bool AppBase::isTreeItemExpanded ( ot::UID _itemID)
slot

References ot::NavigationTreeView::getTree().

◆ isTreeItemSelected

bool AppBase::isTreeItemSelected ( ot::UID _itemID)
slot

References ot::NavigationTreeView::getTree().

◆ lockManager()

LockManager * AppBase::lockManager ( )

References ExternalServicesComponent::lockManager(), and OTAssertNullptr.

◆ lockPropertyGrid()

void AppBase::lockPropertyGrid ( bool flag)

References ot::PropertyGridView::getPropertyGrid(), and ot::PropertyGrid::getTreeWidget().

◆ lockSelectionAndModificationAPI()

void AppBase::lockSelectionAndModificationAPI ( bool _flag)
overrideprotectedvirtual

Implements ot::WindowAPI.

References slotLockSelectionAndModification().

◆ lockUIAPI()

void AppBase::lockUIAPI ( bool _flag)
overrideprotectedvirtual

Implements ot::WindowAPI.

References slotLockUI().

◆ log() [1/4]

void AppBase::log ( const ot::LogMessage & _message)
overridevirtual

Called when the a log message was created.

Implements ot::AbstractLogNotifier.

◆ log() [2/4]

virtual void AppBase::log ( const ot::LogMessage & _message)
overridevirtual

Called when the a log message was created.

Implements ot::AbstractLogNotifier.

◆ log() [3/4]

virtual void AppBase::log ( const ot::LogMessage & _message)
overridevirtual

Called when the a log message was created.

Implements ot::AbstractLogNotifier.

◆ log() [4/4]

void AppBase::log ( const QString & _sender,
InterfaceLogType _type,
const QString & _message )
overridevirtual

Implements otoolkit::APIInterface.

References otoolkit::APIInterface::Error, otoolkit::APIInterface::Information, OTAssert, and otoolkit::APIInterface::Warning.

◆ logIn()

bool AppBase::logIn ( )

References ot::BrightStyle, createUi(), ViewStateCfg::fromJson(), ot::IconManager::getApplicationIcon(), LogInDialog::getLoginData(), StartArgumentParser::getOpenProjectSet(), StartArgumentParser::getProjectInfo(), ot::ProjectInformation::getProjectName(), StartArgumentParser::getProjectVersion(), LoginData::getUserName(), UserManagement::getUserSettingsCollection(), ViewStateCfg::getViewConfig(), LogInDialog::initialize(), initializeDefaultUserSettings(), UserManagement::initializeNewSession(), ot::GlobalWidgetViewManager::instance(), ot::LogDispatcher::instance(), ot::GlobalColorStyle::instance(), LoginData::isValid(), logInDialogAvailable(), loginSuccessful(), ot::Dialog::Ok, OT_LOG_D, OT_LOG_W, OTAssert, StartArgumentParser::parse(), UserManagement::restoreSetting(), ot::WidgetViewManager::restoreState(), ot::GlobalColorStyle::setCurrentStyle(), ot::LogDispatcher::setUserName(), ot::Dialog::showDialog(), slotOpenSpecificProject(), startSessionRefreshTimer(), STATE_NAME_COLORSTYLE, STATE_NAME_VIEW, STATE_NAME_WINDOW, and ot::toString().

◆ logInDialogAvailable

void AppBase::logInDialogAvailable ( QObject * _dialog)
signal

Is emitted when the log-in dialog is available.

Parameters
_dialogPointer to the log-in dialog.

◆ loginSuccessful

void AppBase::loginSuccessful ( )
signal

Is emitted when the log-in was successful and the default ui was created.

◆ mainWindow()

aWindow * AppBase::mainWindow ( ) const

References ak::invalidUID, and OTAssert.

◆ makeWidgetViewCurrentWithoutInputFocus()

void AppBase::makeWidgetViewCurrentWithoutInputFocus ( ot::WidgetView * _view,
bool _ignoreEntitySelect )

References ot::WidgetViewManager::getConfigFlags(), ot::WidgetViewManager::InputFocusOnFocusChangeMask, ot::GlobalWidgetViewManager::instance(), ot::WidgetView::setAsCurrentViewTab(), ot::WidgetViewManager::setConfigFlags(), and ot::SkipEntitySelection.

◆ manageGroups()

void AppBase::manageGroups ( )

References LoginData::getAuthorizationUrl(), WelcomeWidget::getQWidget(), ot::Dialog::showDialog(), and slotLockUI().

◆ notify()

void AppBase::notify ( ot::UID _senderId,
ak::eventType _eventType,
int _info1,
int _info2 )
overridevirtual

Will call the callback function with the provided parameters.

Parameters
_senderIdThe sender ID the message was send from
_messageThe message
_messageTypeThe type of the messsage
_info1Message addition 1
_info2Message addition 2
Exceptions
sim::Exceptionto forward exceptions coming from the application core class

References e, ak::etTabToolbarChanged, WelcomeWidget::getQWidget(), ot::GlobalWidgetViewManager::instance(), OT_LOG_E, and WelcomeWidget::slotRefreshProjectList().

◆ openNewInstance()

bool AppBase::openNewInstance ( const ot::ProjectInformation & _projectInfo,
const std::string & _customVersion )

References ot::SystemProcess::AboveNormalPriority, appendOutputMessageAPI(), ot::StyledText::Bold, StartArgumentParser::createCommandLineArgs(), ot::SystemProcess::DetachedProcess, ot::ProjectInformation::getProjectName(), ot::StyledText::NotBold, OT_LOG_EA, ot::SystemProcess::runApplication(), StartArgumentParser::setLogInData(), StartArgumentParser::setProjectInfo(), StartArgumentParser::setProjectVersion(), and ot::SystemProcess::UseUnicode.

◆ parseStartArgs()

void AppBase::parseStartArgs ( const std::string & _args)

References LogExport, NoAutoStart, and OT_LOG_W.

◆ projectCloseCompleted

void AppBase::projectCloseCompleted ( )
slot

Is called when the project close operation is completed.

References projectClosed().

◆ projectClosed

void AppBase::projectClosed ( )
signal

Is emitted when a project was closed.

◆ projectOpenCompleted

void AppBase::projectOpenCompleted ( )
slot

Is called when the project open operation is completed.

References projectOpened().

◆ projectOpened

void AppBase::projectOpened ( )
signal

Is emitted when a project was opened.

◆ queueCustomCallback

void AppBase::queueCustomCallback ( const QString & _callbackId)
slot

◆ refreshWelcomeScreen

void AppBase::refreshWelcomeScreen ( )
slot

Refreshes the welcome screen content. This function can be used to update the project list after projects were created, deleted, or modified.

References WelcomeWidget::slotRefreshProjectList().

◆ registerToolActivityNotifier()

void AppBase::registerToolActivityNotifier ( otoolkit::ToolActivityNotifier * _notifier)
overridevirtual

Implements otoolkit::APIInterface.

◆ removeNavigationTreeItems

void AppBase::removeNavigationTreeItems ( const std::vector< ot::UID > & itemIds)
slot

References ot::NavigationTreeView::getTree().

◆ removeToolActivityNotifier()

void AppBase::removeToolActivityNotifier ( otoolkit::ToolActivityNotifier * _notifier)
overridevirtual

Implements otoolkit::APIInterface.

◆ renameEntity()

void AppBase::renameEntity ( const std::string & _fromPath,
const std::string & _toPath )

References ot::GlobalWidgetViewManager::instance(), OT_LOG_EAS, and ot::WidgetViewManager::renameView().

◆ replaceInfoMessage

void AppBase::replaceInfoMessage ( const QString & _message)
slot

Replace the current output window text with the provided one.

Parameters
_messageThe message to set.

References ot::PlainTextEditView::getPlainTextEdit().

◆ restoreSessionState()

void AppBase::restoreSessionState ( )

References ViewStateCfg::fromJson(), ot::ProjectInformation::getProjectType(), ot::VersionGraphManagerView::getVersionGraphManager(), ViewStateCfg::getViewConfig(), ot::WidgetView::getViewDockWidget(), ot::GlobalWidgetViewManager::instance(), OT_LOG_W, OTAssertNullptr, UserManagement::restoreSetting(), ot::WidgetViewManager::restoreState(), ot::VersionGraphManager::setCurrentViewMode(), STATE_NAME_VERSIONVIEWMODE, STATE_NAME_VIEW, and ot::VersionGraphManager::stringToViewMode().

◆ rootWidget()

virtual const QWidget * AppBase::rootWidget ( void ) const
inlineoverridevirtual

Implements otoolkit::APIInterface.

◆ runJSScript()

bool AppBase::runJSScript ( const QString & _scriptName,
const QString & _scriptData )

References appendOutputMessageAPI(), OT_LOG_D, OT_LOG_E, and result.

◆ runJSScriptFromFile()

bool AppBase::runJSScriptFromFile ( const QString & _filePath)

References OT_LOG_E, and runJSScript().

◆ sendExecuteAPI()

bool AppBase::sendExecuteAPI ( const std::string & _receiverUrl,
const std::string & _message,
std::string & _response )
overrideprotectedvirtual

Implements ot::CommunicationAPI.

References ExternalServicesComponent::EXECUTE, and ExternalServicesComponent::sendRelayedRequest().

◆ sendExecuteToServiceAPI()

bool AppBase::sendExecuteToServiceAPI ( const ot::BasicServiceInformation & _serviceInfo,
const std::string & _message,
std::string & _response )
overrideprotectedvirtual

Implements ot::CommunicationAPI.

References ExternalServicesComponent::EXECUTE, and ExternalServicesComponent::sendRelayedRequest().

◆ sendQueueAPI()

bool AppBase::sendQueueAPI ( const std::string & _receiverUrl,
const std::string & _message )
overrideprotectedvirtual

Implements ot::CommunicationAPI.

References ExternalServicesComponent::QUEUE, and ExternalServicesComponent::sendRelayedRequest().

◆ sendQueueToServiceAPI()

bool AppBase::sendQueueToServiceAPI ( const ot::BasicServiceInformation & _serviceInfo,
const std::string & _message )
overrideprotectedvirtual

Implements ot::CommunicationAPI.

References ExternalServicesComponent::QUEUE, and ExternalServicesComponent::sendRelayedRequest().

◆ servicesUiSetupComplete

void AppBase::servicesUiSetupComplete ( )
signal

Is emitted when the services UI setup of all services in the session is complete.

◆ servicesUiSetupCompleted

void AppBase::servicesUiSetupCompleted ( )
slot

Is called when the log-in dialog is available.

References servicesUiSetupComplete().

◆ setApplicationInstance()

void AppBase::setApplicationInstance ( QApplication * _app)
inline

◆ setCurrentProjectInfo()

void AppBase::setCurrentProjectInfo ( const ot::ProjectInformation & _info)
inline

◆ setCurrentProjectIsModified()

void AppBase::setCurrentProjectIsModified ( bool _isModified = true)

Will set the current project as modified and apply UI changes.

References ot::ProjectInformation::getProjectName().

◆ setCurrentVisualizationTabFromEntityName()

void AppBase::setCurrentVisualizationTabFromEntityName ( const std::string & _entityName,
ot::WidgetViewBase::ViewType _viewType )

Sets the current visualization tab.

Parameters
_entityNameName of the entity to set the tab for.
_viewTypeType of the view to set the tab for.

References ot::WidgetViewManager::getConfigFlags(), ot::WidgetViewManager::InputFocusOnFocusChangeMask, ot::GlobalWidgetViewManager::instance(), OT_SLECTION_TEST_LOG, ot::WidgetViewManager::setConfigFlags(), ot::WidgetViewManager::setCurrentView(), and ot::WidgetViewBase::toString().

◆ setCurrentVisualizationTabFromTitle()

void AppBase::setCurrentVisualizationTabFromTitle ( const std::string & _tabTitle)

Sets the current visualization tab from the provided title.

Parameters
_tabTitleTitle of the tab to set as current.

References ot::WidgetViewManager::getConfigFlags(), ot::WidgetViewManager::InputFocusOnFocusChangeMask, ot::GlobalWidgetViewManager::instance(), OT_SLECTION_TEST_LOG, ot::WidgetViewManager::setConfigFlags(), and ot::WidgetViewManager::setCurrentViewFromTitle().

◆ setDebug()

void AppBase::setDebug ( bool _debug)

◆ setModelUID()

void AppBase::setModelUID ( ot::UID _uid)
inline

◆ setNavigationTreeItemIcon

void AppBase::setNavigationTreeItemIcon ( ot::UID _itemID,
const QString & _iconName,
const QString & _iconDefaultPath )
slot

References ot::IconManager::getIcon(), and ot::NavigationTreeView::getTree().

◆ setNavigationTreeItemSelected

void AppBase::setNavigationTreeItemSelected ( ot::UID _itemID,
bool _isSelected )
slot

References ot::NavigationTreeView::getTree().

◆ setNavigationTreeItemsSelected

void AppBase::setNavigationTreeItemsSelected ( const ot::UIDList & _itemIDs,
bool _selected,
bool _clearOtherSelection )
slot

References ot::NavigationTreeView::getTree(), and slotTreeItemSelectionChanged().

◆ setNavigationTreeItemText

void AppBase::setNavigationTreeItemText ( ot::UID _itemID,
const QString & _itemName )
slot

References ot::NavigationTreeView::getTree().

◆ setNavigationTreeMultiselectionEnabled

void AppBase::setNavigationTreeMultiselectionEnabled ( bool _enabled)
slot

References ot::NavigationTreeView::getTree().

◆ setNavigationTreeSortingEnabled

void AppBase::setNavigationTreeSortingEnabled ( bool _enabled)
slot

References ot::NavigationTreeView::getTree().

◆ setProgressBarValueAPI()

void AppBase::setProgressBarValueAPI ( int _progressPercentage)
overrideprotectedvirtual

Implements ot::WindowAPI.

References slotSetProgressBarValue().

◆ setProgressBarVisibilityAPI()

void AppBase::setProgressBarVisibilityAPI ( QString _progressMessage,
bool _progressBaseVisible,
bool _continuous )
overrideprotectedvirtual

Implements ot::WindowAPI.

References slotSetProgressBarVisibility().

◆ setRelayURLs()

void AppBase::setRelayURLs ( const std::string & _url)

Will set the Relay URLs.

References ExternalServicesComponent::setMessagingRelay().

◆ setServiceURL()

void AppBase::setServiceURL ( const std::string & _url)

Will set the current Service URL of this service.

References ExternalServicesComponent::setUiServiceURL().

◆ setSessionServiceURL()

void AppBase::setSessionServiceURL ( const std::string & _url)

Will set the session service URL.

References ExternalServicesComponent::setSessionServiceURL().

◆ setSingleNavigationTreeItemSelected

void AppBase::setSingleNavigationTreeItemSelected ( ot::UID _itemID,
bool _isSelected )
slot

References ot::NavigationTreeView::getTree().

◆ setSiteID()

void AppBase::setSiteID ( int _id)

Will set the current site ID.

◆ setTabToolBarTabOrder

void AppBase::setTabToolBarTabOrder ( const QStringList & _lst)
slot

◆ settingsChanged()

void AppBase::settingsChanged ( const std::string & _owner,
const ot::Property * _property )

References ot::PropertyGridCfg::addRootGroup(), ot::PropertyGridCfg::addToJsonObject(), ot::Property::createCopyWithParents(), ot::ReturnMessage::fromJson(), frontendSettingsChanged(), ot::Property::getRootGroup(), ExternalServicesComponent::getServiceFromName(), ot::ServiceBase::getServiceURL(), ot::ReturnMessage::getWhat(), initializeDefaultUserSettings(), ot::ReturnMessage::Ok, OT_ACTION_CMD_UI_SettingsItemChanged, OT_ACTION_MEMBER, OT_ACTION_PARAM_Config, OT_LOG_EAS, OTAssertNullptr, ExternalServicesComponent::QUEUE, ExternalServicesComponent::sendRelayedRequest(), VIEWER_SETTINGS_NAME, and viewerSettingsChanged().

◆ setUiServiceUID()

void AppBase::setUiServiceUID ( ot::UID _uid)
inline

◆ setUpdateTransparentColorStyleValueEnabled()

void AppBase::setUpdateTransparentColorStyleValueEnabled ( bool _enabled)

References updateTransparentColorStyleValue().

◆ setupPropertyGrid()

void AppBase::setupPropertyGrid ( const ot::PropertyGridCfg & _configuration)

References ProjectManagement::defaultMaxProjects(), ProjectManagement::findProjects(), ot::PropertyGridCfg::findPropertiesBySpecialType(), ot::PropertyGridCfg::getIsModal(), ot::PropertyGrid::getIsModal(), ot::PropertyGridView::getPropertyGrid(), OT_LOG_E, OT_LOG_W, OTAssertNullptr, ot::PropertyStringList::setList(), and ot::PropertyGrid::setupGridFromConfig().

◆ setUrl()

void AppBase::setUrl ( const QString & _url)

References OT_LOG_D.

◆ setViewerUID()

void AppBase::setViewerUID ( ot::UID _uid)
inline

◆ setViewHandlingFlag()

void AppBase::setViewHandlingFlag ( ot::ViewHandlingFlag _flag,
bool _active = true )
inline

References ot::Flags< T, Storage >::set().

◆ setViewHandlingFlags()

void AppBase::setViewHandlingFlags ( const ot::ViewHandlingFlags & _flags)
inline

◆ setVisible3D()

void AppBase::setVisible3D ( bool visible3D)
inline

◆ setVisibleBlockPicker()

void AppBase::setVisibleBlockPicker ( bool visibleBlockPicker)
inline

◆ setWaitingAnimationVisible()

void AppBase::setWaitingAnimationVisible ( bool flag) const

◆ shortcutManager()

ShortcutManager * AppBase::shortcutManager ( )
inline

◆ showErrorPromptAPI()

void AppBase::showErrorPromptAPI ( const std::string & _title,
const std::string & _message,
const std::string & _detailedMessage )
overrideprotectedvirtual

Implements ot::WindowAPI.

References slotShowErrorPrompt().

◆ showInfoPromptAPI()

void AppBase::showInfoPromptAPI ( const std::string & _title,
const std::string & _message,
const std::string & _detailedMessage )
overrideprotectedvirtual

Implements ot::WindowAPI.

References slotShowInfoPrompt().

◆ showPrompt() [1/2]

ot::MessageDialogCfg::BasicButton AppBase::showPrompt ( const ot::MessageDialogCfg & _config,
QWidget * _parent )
overridevirtual

Implements ot::MessageBoxHandler.

References ak::invalidUID, mainWindow(), and ot::MessageDialog::showDialog().

◆ showPrompt() [2/2]

ot::MessageDialogCfg::BasicButton AppBase::showPrompt ( const std::string & _title,
const std::string & _message,
const std::string & _detailedMessage,
ot::MessageDialogCfg::BasicIcon _icon,
const ot::MessageDialogCfg::BasicButtons & _buttons )

References ot::MessageDialogCfg::setButtons(), ot::MessageDialogCfg::setDetailedText(), ot::MessageDialogCfg::setIcon(), ot::MessageDialogCfg::setText(), ot::DialogCfg::setTitle(), and showPrompt().

◆ showWarningPromptAPI()

void AppBase::showWarningPromptAPI ( const std::string & _title,
const std::string & _message,
const std::string & _detailedMessage )
overrideprotectedvirtual

Implements ot::WindowAPI.

References slotShowWarningPrompt().

◆ slotColorStyleChanged

void AppBase::slotColorStyleChanged ( void )
slot

References ot::ColorStyle::colorStyleName(), ot::GlobalColorStyle::getCurrentStyle(), ot::GlobalColorStyle::instance(), STATE_NAME_COLORSTYLE, and UserManagement::storeSetting().

◆ slotCopyProject

void AppBase::slotCopyProject ( )
slot

References UserManagement::addRecentProject(), UserManagement::checkConnection(), ProjectManagement::copyProject(), ProjectManagement::deleteProject(), CopyProjectDialog::getProjectName(), WelcomeWidget::getQWidget(), WelcomeWidget::getSelectedProjects(), LoginData::getUserName(), ot::Dialog::Ok, OT_LOG_EA, ProjectManagement::projectExists(), ot::Dialog::showDialog(), and WelcomeWidget::slotRefreshProjectList().

◆ slotCopyRequested

void AppBase::slotCopyRequested ( const ot::CopyInformation & _info)
slot

References ot::CopyInformation::addToJsonObject(), ExternalServicesComponent::EXECUTE, ot::ReturnMessage::fromJson(), ot::ProjectInformation::getProjectName(), ot::ReturnMessage::getWhat(), ot::ReturnMessage::Ok, OT_ACTION_CMD_SelectedEntitiesSerialise, OT_ACTION_MEMBER, OT_ACTION_PARAM_Config, OT_INFO_SERVICE_TYPE_MODEL, OT_LOG_E, OT_LOG_EA, ExternalServicesComponent::sendRelayedRequest(), and ot::CopyInformation::setOriginProjectName().

◆ slotCreateProject

void AppBase::slotCreateProject ( )
slot

Create a new project. Will show the project creation dialog.

References UserManagement::addRecentProject(), UserManagement::checkConnection(), ot::Dialog::closeOk(), ExternalServicesComponent::closeProject(), ot::CreateProjectDialog::createProject(), ProjectManagement::createProject(), ProjectManagement::deleteProject(), WelcomeWidget::getCurrentQuickFilter(), ExternalServicesComponent::getListOfProjectTemplates(), ProjectManagement::getProjectCollection(), ot::ProjectInformation::getProjectName(), ot::CreateProjectDialog::getProjectName(), ot::CreateProjectDialog::getProjectType(), ot::CreateProjectDialog::getTemplateName(), LoginData::getUserName(), ProjectManagement::InitializeConnection(), mainWindow(), ot::MessageDialogCfg::No, ot::Dialog::Ok, ExternalServicesComponent::openProject(), OT_LOG_E, ProjectManagement::projectExists(), ExternalServicesComponent::projectIsOpened(), UserManagement::restoreSetting(), result, ot::CreateProjectDialog::selectProjectType(), ot::CreateProjectDialog::setCurrentProjectName(), ot::CreateProjectDialog::setProjectTemplates(), ot::Dialog::showDialog(), showPrompt(), WelcomeWidget::slotRefreshProjectList(), slotShowErrorPrompt(), UserManagement::storeSetting(), ot::MessageDialogCfg::Warning, and ot::MessageDialogCfg::Yes.

◆ slotDeleteProject

void AppBase::slotDeleteProject ( )
slot

References UserManagement::checkConnection(), ExternalServicesComponent::closeProject(), ProjectManagement::deleteProject(), ot::ProjectInformation::getProjectName(), WelcomeWidget::getSelectedProjects(), mainWindow(), OT_LOG_EA, ExternalServicesComponent::projectIsOpened(), UserManagement::removeRecentProject(), WelcomeWidget::slotRefreshProjectList(), and slotShowErrorPrompt().

◆ slotExportProject

void AppBase::slotExportProject ( )
slot

References WelcomeWidget::getSelectedProjects(), OT_LOG_EA, and slotLockUI().

◆ slotGraphicsConnectionRequested

void AppBase::slotGraphicsConnectionRequested ( const ot::UID & _fromUid,
const std::string & _fromConnector,
const ot::UID & _toUid,
const std::string & _toConnector )
slot

References ot::GraphicsActionHandler::createConnectionRequestedDocument(), ExternalServicesComponent::EXECUTE, ot::WidgetViewManager::findViewFromWidget(), ot::ReturnMessage::fromJson(), ot::WidgetViewManager::getOwnerFromView(), ot::ReturnMessage::getWhat(), ot::GraphicsItemConnection, ot::GlobalWidgetViewManager::instance(), ot::ReturnMessage::Ok, OT_LOG_E, ExternalServicesComponent::sendRelayedRequest(), ot::GraphicsConnectionDropEvent::setConnectionCfg(), ot::GraphicsConnectionDropEvent::setEditorName(), and ot::GraphicsConnectionCfg::setLineStyle().

◆ slotGraphicsConnectionToConnectionRequested

void AppBase::slotGraphicsConnectionToConnectionRequested ( const ot::UID & _fromItemUid,
const std::string & _fromItemConnector,
const ot::UID & _toConnectionUid,
const ot::Point2DD & _newControlPoint )
slot

References ot::GraphicsActionHandler::createConnectionRequestedDocument(), ExternalServicesComponent::EXECUTE, ot::WidgetViewManager::findViewFromWidget(), ot::ReturnMessage::fromJson(), ot::WidgetViewManager::getOwnerFromView(), ot::ReturnMessage::getWhat(), ot::GraphicsItemConnection, ot::GlobalWidgetViewManager::instance(), ot::ReturnMessage::Ok, OT_LOG_E, ExternalServicesComponent::sendRelayedRequest(), ot::GraphicsConnectionDropEvent::setConnectionCfg(), ot::GraphicsConnectionCfg::setDestPos(), ot::GraphicsConnectionDropEvent::setEditorName(), and ot::GraphicsConnectionCfg::setLineStyle().

◆ slotGraphicsElementsChanged

void AppBase::slotGraphicsElementsChanged ( const ot::GraphicsChangeEvent & _event)
slot

References ot::GraphicsActionHandler::createChangeEventDocument(), ExternalServicesComponent::EXECUTE, ot::ReturnMessage::fromJson(), ot::ReturnMessage::getWhat(), ot::ReturnMessage::Ok, OT_INFO_SERVICE_TYPE_MODEL, OT_LOG_E, and ExternalServicesComponent::sendRelayedRequest().

◆ slotGraphicsItemDoubleClicked

void AppBase::slotGraphicsItemDoubleClicked ( const ot::GraphicsItemCfg * _itemConfig)
slot

References ot::GraphicsActionHandler::createItemDoubleClickedDocument(), ExternalServicesComponent::EXECUTE, ot::WidgetViewManager::findViewFromWidget(), ot::ReturnMessage::fromJson(), ot::GraphicsItemCfg::getName(), ot::WidgetViewManager::getOwnerFromView(), ot::GraphicsItemCfg::getUid(), ot::ReturnMessage::getWhat(), ot::GlobalWidgetViewManager::instance(), ot::ReturnMessage::Ok, OT_LOG_E, ExternalServicesComponent::sendRelayedRequest(), ot::GraphicsDoubleClickEvent::setEditorName(), ot::GraphicsDoubleClickEvent::setItemName(), and ot::GraphicsDoubleClickEvent::setItemUid().

◆ slotGraphicsItemRequested

void AppBase::slotGraphicsItemRequested ( const QString & _name,
const QPointF & _pos )
slot

References ot::GraphicsActionHandler::createItemRequestedDocument(), ExternalServicesComponent::EXECUTE, ot::WidgetViewManager::findViewFromWidget(), ot::ReturnMessage::fromJson(), ot::WidgetViewManager::getOwnerFromView(), ot::GraphicsView::getQWidget(), ot::ReturnMessage::getWhat(), ot::GlobalWidgetViewManager::instance(), ot::ReturnMessage::Ok, OT_LOG_E, ExternalServicesComponent::sendRelayedRequest(), ot::GraphicsItemDropEvent::setEditorName(), ot::GraphicsItemDropEvent::setItemName(), ot::GraphicsItemDropEvent::setScenePos(), and ot::QtFactory::toPoint2D().

◆ slotGraphicsSelectionChanged

void AppBase::slotGraphicsSelectionChanged ( )
slot

References clearNavigationTreeSelection(), ot::GraphicsConnectionItem::getConfiguration(), ot::GraphicsItem::getGraphicsItemUid(), ot::GraphicsScene::getGraphicsView(), ot::NavigationTreeView::getTree(), ot::GraphicsConnectionCfg::getUid(), ot::invalidUID, OT_LOG_E, OT_SLECTION_TEST_LOG, OTAssert, setNavigationTreeItemSelected(), ot::NavigationSelectionManager::setSelectedItems(), ot::WidgetView::setVisualizingItems(), and ot::User.

◆ slotHandleSelectionHasChanged

void AppBase::slotHandleSelectionHasChanged ( ot::SelectionHandlingResult * _result,
ot::SelectionOrigin _eventOrigin )
slot

References autoCloseUnpinnedViews(), ViewerComponent::getSelectedModelEntityIDs(), ot::SelectionInformation::getSelectedNavigationItems(), getSelectedNavigationTreeItems(), ViewerComponent::handleSelectionChanged(), OT_SLECTION_TEST_LOG, ot::SelectionData::setKeyboardModifiers(), ot::SelectionData::setSelectedTreeItems(), ot::SelectionData::setSelectionOrigin(), and ot::SelectionData::setViewHandlingFlags().

◆ slotLockSelectionAndModification

void AppBase::slotLockSelectionAndModification ( bool _flag)
slot

References ot::ServiceBase::getBasicServiceInformation(), ot::NavigationTreeView::getTree(), LockManager::lock(), lockManager(), ot::ModelRead, ot::ModelWrite, ot::NavigationWrite, ot::Flags< T, Storage >::set(), LockManager::unlock(), and ot::ViewWrite.

◆ slotLockUI

void AppBase::slotLockUI ( bool _flag)
slot

References ot::All, ot::ServiceBase::getBasicServiceInformation(), LockManager::lock(), lockManager(), and LockManager::unlock().

◆ slotManageProjectAccess

void AppBase::slotManageProjectAccess ( )
slot

References LoginData::getAuthorizationUrl(), WelcomeWidget::getQWidget(), WelcomeWidget::getSelectedProjects(), OT_LOG_EA, ot::Dialog::showDialog(), and slotLockUI().

◆ slotManageProjectOwner

void AppBase::slotManageProjectOwner ( )
slot

References ProjectManagement::canAccessProject(), UserManagement::checkConnection(), ExternalServicesComponent::closeProject(), LoginData::getAuthorizationUrl(), getCurrentLoginData(), ProjectManagement::getProjectCollection(), ot::ProjectInformation::getProjectName(), WelcomeWidget::getQWidget(), WelcomeWidget::getSelectedProjects(), LoginData::getUserName(), instance(), OT_LOG_EA, UserManagement::removeRecentProject(), ot::Dialog::showDialog(), and WelcomeWidget::slotRefreshProjectList().

◆ slotOpenProject

void AppBase::slotOpenProject ( )
slot

Open the currently selected project in the welcome screen.

References WelcomeWidget::getSelectedProjects(), OT_LOG_EA, and slotOpenSpecificProject().

◆ slotOpenProjectFromIndex

void AppBase::slotOpenProjectFromIndex ( int _index)
slot

References WelcomeWidget::getProjectInformationAt(), OT_LOG_EA, and slotOpenSpecificProject().

◆ slotOpenSpecificProject

void AppBase::slotOpenSpecificProject ( const QString & _projectName,
const QString & _projectVersion )
slot

References UserManagement::addRecentProject(), ProjectManagement::canAccessProject(), UserManagement::checkConnection(), ExternalServicesComponent::closeProject(), ProjectManagement::getProjectCollection(), ot::ProjectInformation::getProjectName(), ProjectManagement::getProjectType(), ProjectManagement::notifyProjectOpened(), ExternalServicesComponent::openProject(), ProjectManagement::projectExists(), ExternalServicesComponent::projectIsOpened(), UserManagement::removeRecentProject(), WelcomeWidget::slotRefreshProjectList(), slotShowErrorPrompt(), and slotShowInfoPrompt().

◆ slotPasteRequested

void AppBase::slotPasteRequested ( const ot::CopyInformation & _info)
slot

References ot::CopyInformation::addToJsonObject(), ExternalServicesComponent::EXECUTE, ot::ReturnMessage::fromJson(), ot::CopyInformation::fromRawString(), ot::CopyInformation::getDestinationScenePos(), ot::CopyInformation::getDestinationScenePosSet(), ot::CopyInformation::getDestinationViewInfo(), ot::ReturnMessage::getWhat(), ot::ReturnMessage::Ok, OT_ACTION_CMD_PasteEntities, OT_ACTION_MEMBER, OT_ACTION_PARAM_Config, OT_ACTION_PARAM_Raw, OT_INFO_SERVICE_TYPE_MODEL, OT_LOG_E, OT_LOG_EA, ExternalServicesComponent::sendRelayedRequest(), ot::CopyInformation::setDestinationScenePos(), and ot::CopyInformation::setDestinationViewInfo().

◆ slotPlotCurveDoubleClicked

void AppBase::slotPlotCurveDoubleClicked ( ot::UID _entityID,
bool _hasControlModifier )
slot

References ot::Plot::getAllDatasets(), ot::PlotBase::getConfig(), ot::BasicEntityInformation::getEntityID(), ot::NavigationTreeView::getTree(), isTreeItemSelected(), OT_LOG_E, OT_LOG_EA, OT_SLECTION_TEST_LOG, setNavigationTreeItemSelected(), toggleNavigationTreeItemSelection(), and ot::User.

◆ slotPlotResetItemSelectionRequest

void AppBase::slotPlotResetItemSelectionRequest ( )
slot

References ot::PlotBase::getConfig(), ot::BasicEntityInformation::getEntityID(), ot::NavigationTreeView::getTree(), OT_LOG_E, OT_LOG_EA, OT_SLECTION_TEST_LOG, setNavigationTreeItemSelected(), and ot::User.

◆ slotProcessMessage

void AppBase::slotProcessMessage ( const QString & _json)
slot

References ot::ActionDispatcherBase::dispatch(), ot::EXECUTE, and ot::ActionDispatcher::instance().

◆ slotPropertyGridValueChanged

void AppBase::slotPropertyGridValueChanged ( const ot::Property * _property)
slot

References ExternalServicesComponent::propertyGridValueChanged(), and ViewerComponent::propertyGridValueChanged().

◆ slotPropertyGridValueDeleteRequested

void AppBase::slotPropertyGridValueDeleteRequested ( const ot::Property * _property)
slot

References ExternalServicesComponent::propertyGridValueDeleteRequested().

◆ slotRefreshProjectOverivew

void AppBase::slotRefreshProjectOverivew ( )
slot

References OT_LOG_EA, and WelcomeWidget::slotRefreshProjectList().

◆ slotRenameProject

void AppBase::slotRenameProject ( )
slot

References UserManagement::addRecentProject(), UserManagement::checkConnection(), ExternalServicesComponent::closeProject(), ProjectManagement::getProjectCollection(), ot::ProjectInformation::getProjectName(), RenameProjectDialog::getProjectName(), ProjectManagement::getProjectType(), WelcomeWidget::getQWidget(), WelcomeWidget::getSelectedProjects(), ot::Dialog::Ok, ExternalServicesComponent::openProject(), OT_LOG_EA, ProjectManagement::projectExists(), ExternalServicesComponent::projectIsOpened(), UserManagement::removeRecentProject(), ProjectManagement::renameProject(), ot::Dialog::showDialog(), WelcomeWidget::slotRefreshProjectList(), and slotShowErrorPrompt().

◆ slotRequestVersion

void AppBase::slotRequestVersion ( const std::string & _versionName)
slot

References ExternalServicesComponent::activateVersion().

◆ slotRunCustomTimer

void AppBase::slotRunCustomTimer ( const QString & _timerId,
int _intervalMs )
slot

References customTimerTimeout().

◆ slotSendExecuteMessageToService

QVariantMap AppBase::slotSendExecuteMessageToService ( const QString & _serviceName,
const QString & _message )
slot

Sends an execute message to the specified service and wait for the response.

Parameters
_serviceNameName of the service to send the message to.
_messageMessage to send.
Returns
Map containing a boolean "success" indicating the success of the operation and a string "response" containing the response string.

References ExternalServicesComponent::getServiceFromName(), result, and slotSendExecuteMessageToUrl().

◆ slotSendExecuteMessageToUrl

QVariantMap AppBase::slotSendExecuteMessageToUrl ( const QString & _serviceUrl,
const QString & _message )
slot

Sends an execute message to the specified service URL and wait for the response.

Parameters
_serviceUrlURL of the service to send the message to.
_messageMessage to send.
Returns
Map containing a boolean "success" indicating the success of the operation and a string "response" containing the response string.

References result, and sendExecuteAPI().

◆ slotSendQueueMessageToService

bool AppBase::slotSendQueueMessageToService ( const QString & _serviceName,
const QString & _message )
slot

Sends a queue message to the specified service.

Parameters
_serviceNameName of the service to send the message to.
_messageMessage to send.
Returns
True on success, false on failure.

References ExternalServicesComponent::getServiceFromName(), and slotSendQueueMessageToUrl().

◆ slotSendQueueMessageToUrl

bool AppBase::slotSendQueueMessageToUrl ( const QString & _serviceUrl,
const QString & _message )
slot

Sends a queue message to the specified service URL.

Parameters
_serviceUrlURL of the service to send the message to.
_messageMessage to send.
Returns
True on success, false on failure.

References sendQueueAPI().

◆ slotSetProgressBarValue

void AppBase::slotSetProgressBarValue ( int _progressPercentage)
slot

◆ slotSetProgressBarVisibility

void AppBase::slotSetProgressBarVisibility ( QString _progressMessage,
bool _progressBaseVisible,
bool _continuous )
slot

◆ slotShowErrorPrompt

void AppBase::slotShowErrorPrompt ( const std::string & _title,
const std::string & _message,
const std::string & _detailedMessage )
slot

References ot::MessageDialogCfg::Critical, ot::MessageDialogCfg::Ok, and showPrompt().

◆ slotShowInfoPrompt

void AppBase::slotShowInfoPrompt ( const std::string & _title,
const std::string & _message,
const std::string & _detailedMessage )
slot

References ot::MessageDialogCfg::Information, ot::MessageDialogCfg::Ok, and showPrompt().

◆ slotShowOutputContextMenu

void AppBase::slotShowOutputContextMenu ( QPoint _pos)
slot

References ot::PlainTextEditView::getPlainTextEdit(), and OTAssertNullptr.

◆ slotShowWarningPrompt

void AppBase::slotShowWarningPrompt ( const std::string & _title,
const std::string & _message,
const std::string & _detailedMessage )
slot

References ot::MessageDialogCfg::Ok, showPrompt(), and ot::MessageDialogCfg::Warning.

◆ slotTableSaveRequested

void AppBase::slotTableSaveRequested ( )
slot

References ot::changesSaved, ot::Table::createConfig(), ot::TableActionHandler::createTableSaveRequestDocument(), ExternalServicesComponent::EXECUTE, ot::WidgetViewManager::findViewFromWidget(), ot::ReturnMessage::fromJson(), ot::WidgetViewManager::getOwnerFromView(), ot::ReturnMessage::getWhat(), ot::GlobalWidgetViewManager::instance(), ot::ReturnMessage::Ok, OT_LOG_E, OT_LOG_EA, OT_LOG_EAS, OT_LOG_W, ExternalServicesComponent::sendRelayedRequest(), ot::Table::setContentChanged(), and ot::WidgetViewBase::setEntityInformation().

◆ slotTextEditorSaveRequested

void AppBase::slotTextEditorSaveRequested ( )
slot

References ot::changesSaved, ot::TextEditorActionHandler::createTextEditorSaveRequestDocument(), ExternalServicesComponent::EXECUTE, ot::ReturnMessage::fromJson(), ot::TextEditor::getNextChunkStartIndex(), ot::WidgetViewManager::getOwnerFromView(), ot::ReturnMessage::getWhat(), ot::TextEditor::hasMoreToLoad(), ot::GlobalWidgetViewManager::instance(), ot::ReturnMessage::Ok, OT_LOG_E, OT_LOG_EA, OT_LOG_EAS, ExternalServicesComponent::sendRelayedRequest(), ot::TextEditor::setContentSaved(), ot::TextEditor::setNextChunkStartIndex(), and ot::TextEditor::toPlainText().

◆ slotTextLoadAllRequested

void AppBase::slotTextLoadAllRequested ( size_t _nextChunkStartIndex)
slot

References OT_LOG_E, and ot::WidgetViewBase::ViewText.

◆ slotTextLoadNextRequested

void AppBase::slotTextLoadNextRequested ( size_t _nextChunkStartIndex)
slot

References OT_LOG_E, and ot::WidgetViewBase::ViewText.

◆ slotTreeItemFocused

void AppBase::slotTreeItemFocused ( QTreeWidgetItem * _item)
slot

References OT_LOG_EA.

◆ slotTreeItemSelectionChanged

void AppBase::slotTreeItemSelectionChanged ( )
slot

Navigation tree item selection has changed.

References OT_SLECTION_TEST_LOG, and ot::User.

◆ slotTreeItemTextChanged

void AppBase::slotTreeItemTextChanged ( QTreeWidgetItem * _item,
int _column )
slot

References ExternalServicesComponent::itemRenamed(), and OT_LOG_EA.

◆ slotVersionDeselected

void AppBase::slotVersionDeselected ( )
slot

References ot::PropertyGrid::clear(), ot::PropertyGridView::getPropertyGrid(), and ExternalServicesComponent::versionDeselected().

◆ slotVersionSelected

void AppBase::slotVersionSelected ( const std::string & _versionName)
slot

References ExternalServicesComponent::versionSelected().

◆ slotViewAdded

void AppBase::slotViewAdded ( ot::WidgetView * _newView)
slot

References ot::BasicEntityInformation::getEntityName(), ot::WidgetView::getViewData(), ot::WidgetViewBase::getViewFlags(), ot::WidgetViewBase::getViewType(), OTAssertNullptr, ot::WidgetViewBase::ViewIsCentral, and ot::viewOpened.

◆ slotViewCloseRequested

void AppBase::slotViewCloseRequested ( ot::WidgetView * _view)
slot

References ot::WidgetViewManager::closeView(), ot::WidgetViewManager::getCurrentlyFocusedView(), ot::BasicEntityInformation::getEntityName(), ot::SelectionInformation::getSelectedNavigationItems(), ot::WidgetViewBase::getTitle(), ot::NavigationTreeView::getTree(), ot::WidgetView::getViewContentModified(), ot::WidgetView::getViewData(), ot::WidgetViewBase::getViewFlags(), ot::WidgetViewBase::getViewType(), ot::WidgetView::getVisualizingItems(), ot::GlobalWidgetViewManager::instance(), mainWindow(), ot::MessageDialogCfg::No, OT_SLECTION_TEST_LOG, ot::MessageDialogCfg::setButtons(), ot::MessageDialogCfg::setIcon(), ot::MessageDialogCfg::setText(), ot::DialogCfg::setTitle(), ot::MessageDialog::showDialog(), ot::User, ot::viewClosed, ot::WidgetViewBase::ViewIsCloseable, ot::MessageDialogCfg::Warning, and ot::MessageDialogCfg::Yes.

◆ slotViewDataModifiedChanged

void AppBase::slotViewDataModifiedChanged ( ot::WidgetView * _view)
slot

References ot::BasicEntityInformation::getEntityName(), ot::WidgetView::getViewContentModified(), ot::WidgetView::getViewData(), ot::WidgetViewBase::getViewFlags(), ot::WidgetViewBase::getViewType(), OT_LOG_W, ViewerComponent::viewDataModifiedChanged(), and ot::WidgetViewBase::ViewIsCentral.

◆ slotViewFocusChanged

void AppBase::slotViewFocusChanged ( ot::WidgetView * _focusedView,
ot::WidgetView * _previousView )
slot

References autoCloseUnpinnedViews(), ot::GraphicsPickerManager::clearPicker(), ot::BasicEntityInformation::getEntityName(), ot::GraphicsViewView::getGraphicsView(), ot::GraphicsView::getPickerKey(), ot::SelectionInformation::getSelectedNavigationItems(), ot::NavigationTreeView::getTree(), ot::WidgetView::getViewData(), ot::WidgetViewBase::getViewFlags(), ot::WidgetViewBase::getViewType(), ot::WidgetView::getVisualizingItems(), ot::GlobalWidgetViewManager::instance(), ot::NavigationSelectionManager::isSelectionHandlingRunning(), OT_SLECTION_TEST_LOG, ot::GraphicsPickerManager::setCurrentKey(), ot::SkipEntitySelection, ot::SkipViewHandling, ot::NavigationSelectionManager::slotViewDeselected(), ot::NavigationSelectionManager::slotViewSelected(), ot::View, ViewerComponent::viewerTabChanged(), and ot::WidgetViewBase::ViewIsCentral.

◆ slotViewTabClicked

void AppBase::slotViewTabClicked ( ot::WidgetView * _view)
slot

References ot::WidgetView::setAsCurrentViewTab().

◆ startSessionRefreshTimer()

void AppBase::startSessionRefreshTimer ( )

References LoginData::getAuthorizationUrl(), and LoginData::getSessionUser().

◆ storeSessionState()

void AppBase::storeSessionState ( )

References ot::VersionGraphManager::getCurrentViewMode(), ot::ProjectInformation::getProjectType(), ot::VersionGraphManagerView::getVersionGraphManager(), ot::GlobalWidgetViewManager::instance(), OT_LOG_D, ViewStateCfg::setViewConfig(), STATE_NAME_VERSIONVIEWMODE, STATE_NAME_VIEW, UserManagement::storeSetting(), ViewStateCfg::toJson(), and ot::VersionGraphManager::viewModeToString().

◆ storeSettingToDataBase()

bool AppBase::storeSettingToDataBase ( const ot::PropertyGridCfg & _config,
const std::string & _subKey )

References ot::PropertyGridCfg::addToJsonObject(), UserManagement::storeSetting(), and ot::JsonDocument::toJson().

◆ switchToMenuTab()

void AppBase::switchToMenuTab ( const std::string & _menu)

◆ switchToViewMenuTabIfNeeded()

void AppBase::switchToViewMenuTabIfNeeded ( ) const

◆ toggleNavigationTreeItemSelection

void AppBase::toggleNavigationTreeItemSelection ( ot::UID _itemID,
bool _considerChilds )
slot

References ot::NavigationTreeView::getTree().

◆ toolBarAvailable

void AppBase::toolBarAvailable ( QObject * _toolBar)
signal

Is emitted when the tool bar is available.

Parameters
_toolBarPointer to the tool bar.

◆ uiUID()

ot::UID AppBase::uiUID ( ) const
inline

◆ updateBufferSizeFromLogFlags()

void AppBase::updateBufferSizeFromLogFlags ( const ot::LogFlags & _flags)

References ot::ERROR_LOG, OT_LOG_BUFFER_LIMIT_LOW, OT_LOG_BUFFER_LIMIT_MAX, OT_LOG_D, and ot::WARNING_LOG.

◆ updateLogIntensityInfo()

void AppBase::updateLogIntensityInfo ( )

References ot::ALL_INCOMING_MESSAGE_LOG_FLAGS, ot::ALL_OUTGOING_MESSAGE_LOG_FLAGS, ot::DETAILED_LOG, ot::ERROR_LOG, flags, ot::LogDispatcher::getLogFlags(), ot::IconManager::getPixmap(), ot::INFORMATION_LOG, ot::LogDispatcher::instance(), ot::NO_LOG, ot::TEST_LOG, and ot::WARNING_LOG.

◆ updateStatusString()

void AppBase::updateStatusString ( const QString & _statusText)
overridevirtual

Implements otoolkit::APIInterface.

◆ updateStatusStringAsError()

void AppBase::updateStatusStringAsError ( const QString & _statusText)
overridevirtual

Implements otoolkit::APIInterface.

◆ updateTransparentColorStyleValue()

void AppBase::updateTransparentColorStyleValue ( void )

References ot::GlobalColorStyle::addStyle(), ot::ColorStyle::addValue(), ot::GlobalColorStyle::getCurrentStyle(), ot::GlobalColorStyle::instance(), ot::ColorStyleValue::setColor(), ot::ColorStyleValue::setEntryKey(), ot::ColorStyleValue::setPainter(), ot::Transparent, ot::WidgetAlternateBackground, and ot::WidgetBackground.

◆ url()

const QString & AppBase::url ( ) const
inline

◆ viewerSettingsChanged()

void AppBase::viewerSettingsChanged ( const ot::Property * _property)

References OTAssert, and ViewerComponent::settingsItemChanged().

◆ ~AppBase()

AppBase::~AppBase ( )
privatevirtual

Friends And Related Symbol Documentation

◆ KeyboardCommandHandler

friend class KeyboardCommandHandler
friend

◆ ToolBar

friend class ToolBar
friend
The documentation for this class was generated from the following files: