pCon.planner Plugin SDK  Version 8.8.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events
Public Member Functions | Properties | Events | List of all members
X3g::Plugin::IAppManager Class Reference

Application Manager. More...

Public Member Functions

void SetStatusMessage (String^ pStatusMessage)
 Sets the applications status message. More...
 
void PopUpNotification (String^ pMessage)
 Shows a pop-up notification in lower right corner. More...
 
unsigned int StartProgress (String^ pMessage, int pLimit, bool pAbortable)
 Starts a new progess and returns its id. More...
 
bool SetProgress (unsigned int pProgressId, int pProgress)
 Sets the progess for the given progress id. More...
 
void EndProgress (unsigned int pProgressId)
 Ends a progess. More...
 
void BeginShowOperationDelay ()
 Notifies the application about the beginning of a longer-lasting operation. More...
 
void EndShowOperationDelay ()
 Notifies the application about the end of a longer-lasting operation. More...
 
bool IsFeatureEnabled (String^ pFeatureKey)
 Returns true if a feature is available or a license can be locked (is already locked). More...
 
StringGetFeatureInfo (String^ pFeatureKey)
 Returns a JSON string containing more information to the specified feature/license (pCon.login licensing system). More...
 
Windows::Forms::IWin32Window^ GetMainWindow ()
 Returns the applications main window which can be used as a parent for other windows. More...
 
bool Terminate (AppTerminateFlags pFlags)
 Request to terminate the application. More...
 
void BringWindowToTop ()
 Brings application window to the top. More...
 

Properties

IAppDialogOverride^  DialogOverride
 Replace the default handler to override application dialogs. More...
 
Windows::Forms::FormWindowState WindowState [get, set]
 Window state of application main window. More...
 
bool WindowVisibility [get, set]
 Visibility of application main window. More...
 

Events

System::EventHandler^  FeaturesChanged [add, remove, raise]
 Raised when feature states changed and when features were added or removed. More...
 

Detailed Description

Application Manager.

Member Function Documentation

void X3g::Plugin::IAppManager::BeginShowOperationDelay ( )

Notifies the application about the beginning of a longer-lasting operation.

While it takes place the user has to wait. The application may lock the user interface and show some kind of wait-cursor.

void X3g::Plugin::IAppManager::BringWindowToTop ( )

Brings application window to the top.

void X3g::Plugin::IAppManager::EndProgress ( unsigned int  pProgressId)

Ends a progess.

void X3g::Plugin::IAppManager::EndShowOperationDelay ( )

Notifies the application about the end of a longer-lasting operation.

String X3g::Plugin::IAppManager::GetFeatureInfo ( String pFeatureKey)

Returns a JSON string containing more information to the specified feature/license (pCon.login licensing system).

The license has to be obtained before (see IAppManager::IsFeatureEnabled).

Parameters
pFeatureKeyFormatted feature key. Supported schemas are:
Query application or aplication feature: "license.el.<AppID>[:<FeatureID>]"
Query pCon.planner feature: "license.el:<FeatureID>"

<AppID> - pCon.login Application ID
<FeatureID> - pCon.login Feature ID

System::Windows::Forms::IWin32Window X3g::Plugin::IAppManager::GetMainWindow ( )

Returns the applications main window which can be used as a parent for other windows.

bool X3g::Plugin::IAppManager::IsFeatureEnabled ( String pFeatureKey)

Returns true if a feature is available or a license can be locked (is already locked).


A license will be locked if necessary. It is released when the application is shut down.

Parameters
pFeatureKeyFormatted feature key. Supported schemas are:
DLM system: "license.dlm:<Key>:<Value>"
Safenet licensing: "license.safenet:<ProductNumber>:<FeatureNumber>"
pCon.login licensing: "license.el<AppID>[:<FeatureID>]"

A pCon.login license should first be locked without a FeatureID. A query can fail if not logged in. Just a query with no FeatureID prompts the user to sign if needed.
Multiple features of a license should queried using IAppManager::GetFeatureInfo.
IsFeatureEnabled() is very dynamic - a feature is not guaranteed to always be available or remain available once it has been. (see FeaturesChanged event). Do not rely on IsFeatureEnabled during X3gInitialize!

void X3g::Plugin::IAppManager::PopUpNotification ( String pMessage)

Shows a pop-up notification in lower right corner.

bool X3g::Plugin::IAppManager::SetProgress ( unsigned int  pProgressId,
int  pProgress 
)

Sets the progess for the given progress id.

This function returns false if the operation belonging to the current progress shall be aborted.

void X3g::Plugin::IAppManager::SetStatusMessage ( String pStatusMessage)

Sets the applications status message.

unsigned int X3g::Plugin::IAppManager::StartProgress ( String pMessage,
int  pLimit,
bool  pAbortable 
)

Starts a new progess and returns its id.

Parameters
pMessageA description for the progress.
pLimitMaximum number of progress steps. Set to -1 if the number of steps is undetermined. SetProgress() should not be called in this case.
pAbortableTells if the progress is abortable.
bool X3g::Plugin::IAppManager::Terminate ( AppTerminateFlags  pFlags)

Request to terminate the application.

Returns true if the application will terminate.

Property Documentation

IAppDialogOverride^ X3g::Plugin::IAppManager::DialogOverride

Replace the default handler to override application dialogs.

Windows:: Forms:: FormWindowState X3g::Plugin::IAppManager::WindowState
getset

Window state of application main window.

bool X3g::Plugin::IAppManager::WindowVisibility
getset

Visibility of application main window.

Event Documentation

System:: EventHandler^ X3g::Plugin::IAppManager::FeaturesChanged
addremoveraise

Raised when feature states changed and when features were added or removed.