GuiAPI

Description

GUI API interface.

Access to elements in the graphical user interface.

Object name: cnGuiAPI.

Since

1.0, 05.2025

Functions
ApiJsonResponse	closeApplication ()
ApiJsonResponse	importFiles ()
ApiJsonResponse	openURL (QString &url)
STARTPAGE
ApiJsonResponse	openStartPage ()
ApiJsonResponse	closeStartPage ()
PROJECT
ApiJsonResponse	newProject ()
ApiJsonResponse	openProject ()
ApiJsonResponse	saveProject ()
ApiJsonResponse	saveProjectAs ()
ApiJsonResponse	closeProject ()
GUI 3D VIEWER
ApiJsonResponse	createViewpoint ()
MENU BAR
ApiJsonResponse	menuBarSetConfiguration (QVariantMap configuration)
ApiJsonResponse	menuBarGetConfiguration ()
ApiJsonResponse	menuBarReset ()
ACTIONS
ApiJsonResponse	getAvailableActions ()
ApiJsonResponse	triggerAction (QString &actionName, QVariantMap &params=QVariantMap())

Function Documentation

closeApplication

ApiJsonResponse closeApplication ( )

slot

Closes the application.

Since

1.0.0, ...

closeProject

ApiJsonResponse closeProject ( )

slot

...

Since

1.0.0, ...

closeStartPage

ApiJsonResponse closeStartPage ( )

slot

Close ColneoPro start page.

Since

1.0.0

createViewpoint

ApiJsonResponse createViewpoint ( )

slot

Open dialogue to create a new viewpoint.

Since

1.0, 05.2025, jh

getAvailableActions

ApiJsonResponse getAvailableActions ( )

slot

Get list of available actions.

Returns

data : string[]

Since

1.0, Jan 2025

importFiles

ApiJsonResponse importFiles ( )

slot

Show import dialog and call import methods.

Returns

ApiResponse object

Since

1.0.0, ...

menuBarGetConfiguration

ApiJsonResponse menuBarGetConfiguration ( )

slot

Return the current configuration of the menubar as JSON-Object.

Returns

{
    'status' : 200,
    'data' : {}
}

Since

1.0.0

menuBarReset

ApiJsonResponse menuBarReset ( )

slot

resets the menubar to the default configuration

Parameters

url

Returns

\code
{
    'status'    : 200       
}

Since

1.0.0

menuBarSetConfiguration

ApiJsonResponse menuBarSetConfiguration ( QVariantMap configuration )

slot

changes the menubar according to the given configuration

Parameters

configuration

Returns

{
    'status' : 200
}

Since

1.0.0

newProject

ApiJsonResponse newProject ( )

slot

...

Since

1.0.0, ...

openProject

ApiJsonResponse openProject ( )

slot

Show open file dialog and open selected project.

Returns

ApiResponse object

Since

1.0.0, ...

openStartPage

ApiJsonResponse openStartPage ( )

slot

Open ColneoPro start page.

Since

1.0.0

openURL

ApiJsonResponse openURL ( QString & url )

slot

Opens the url in the standard browser.

Parameters

url

Returns

{
    key: value
}

Since

1.0.0, 2024

saveProject

ApiJsonResponse saveProject ( )

slot

Save current project, show SaveFileDialog if project was newly created and no file path is available.

Returns

ApiResponse object

Since

1.0.0, ...

saveProjectAs

ApiJsonResponse saveProjectAs ( )

slot

Show save SaveFileDialog and save the project.

Returns

ApiResponse object

Since

1.0.0, ...

triggerAction

ApiJsonResponse triggerAction ( QString & actionName, QVariantMap & params = QVariantMap() )

slot

Triggers an action.

Parameters

actionName	Name of the action
params	Optional parameters, depending on the action. Example: { dockWidgetArea : 'left' | 'right' | 'top' | 'bottom' | 'float' }

Returns

data: 

See also

getAvailableActions();

Since

1.0, Jan 2025