namespace CCL::Signals

Overview

namespace Signals {

// global variables

 kPluginPresentationChanged;
 kApplication;
CCL Application;
 kFeatureDisabled;
 FeatureDisabled;
 kRequestRestart;
 RequestRestart;
 kRequestQuit;
 RequestQuit;
 kPresetManager;
CCL PresetManager;
 kPresetCreated;
 PresetCreated;
 kPresetRemoved;
 PresetRemoved;
 kPresetsRefreshed;
 PresetsRefreshed;
 kPresetSubFolderAdded;
 PresetSubFolderAdded;
 kPresetSubFolderRemoved;
 PresetSubFolderRemoved;
 kPresetFavoritesChanged;
 PresetFavoritesChanged;
 kOpenPreset;
 OpenPreset;
 kRevealPreset;
 RevealPreset;
 kExtendPresetMenu;
 ExtendPresetMenu;
 kGetPresetsCompleted;
 GetPresetsCompleted;
 kDocumentManager;
CCL DocumentManager;
 kDocumentDirty;
 DocumentDirty;
 kEditorRegistry;
CCL EditorRegistry;
 kEditorActivated;
 EditorActivated;
 kEditing;
CCL Editing;
 kInsertData;
 InsertData;
 kDebug;
CCL Debug;
 kExtendDebugMenu;
 kExtensionManager;
CCL ExtensionManager;
 kExtensionInstalled;
 kGUI;
 GUI;
 kOrientationChanged;
 OrientationChanged;
 kColorSchemeChanged;
 ColorSchemeChanged;
 kSystemMetricsChanged;
 SystemMetricsChanged;
 kGraphicsEngineReset;
 GraphicsEngineReset;
 kControls;
GUI Controls;
 kControlContextMenu;
 ControlContextMenu;
 kHideTooltip;
 HideTooltip;
 kHideContextMenu;
 HideContextMenu;
 kRestoreContextMenu;
 RestoreContextMenu;
 kContextMenuOpened;
 ContextMenuOpened;
 kTabViewTabMenu;
GUI TabView TabMenu;
 kTabViewBeforeDrag;
GUI TabView BeforeDrag;
 kTabViewGetDataTarget;
GUI TabView GetDataTarget;
 kTabViewReorder;
GUI TabView Reorder;
 kTabViewCanReorder;
GUI TabView CanReorder;
 kDividerDoubleClick;
 kHelpManager;
CCL HelpManager;
 kHelpFileNotFound;
 kTransfers;
CCL Transfers;
 kRevealTransfer;
 RevealTransfer;
 kTransferPaused;
 kWebFiles;
CCL WebFiles;
 kVolumesChanged;
 VolumesChanged;
 kVolumeChangeMounted;
 mounted;
 kVolumeChangeUnmounted;
 unmounted;
 kDirectoryChanged;
 DirectoryChanged;
 kVolumeInfoChanged;
 VolumeInfoChanged;
 kRevealVolume;
 kPlugIns;
CCL PlugIns;
 kClassCategoryChanged;
 ClassCategoryChanged;
 kRescanPlugIns;
 RescanPlugIns;
 kResetBlocklist;
 ResetBlocklist;
 kResetBlocklistDone;
 ResetBlocklistDone;
 kTerminatePlugIns;
 kAuthorization;
 Authorization;
 kAuthorizationPolicyChanged;
 kErrorHandler;
CCL ErrorHandler;
 kCrashReported;
 CrashReported;
 kLowMemoryWarning;
 kLocales;
CCL Locales;
 kInputLanguageChanged;
 InputLanguageChanged;
 kApplicationLanguageChanged;
 kFileSystem;
CCL FileSystem;
 kReleaseFile;
 ReleaseFile;
 kFileCreated;
 FileCreated;
 kFileRemoved;
 FileRemoved;
 kFileMoved;
 FileMoved;
 kFileChanged;
 kPackageHandler;
CCL PackageHandler;
 kPackageLocationChanged;
 PackageLocationChanged;
 kPackagesChanged;
 PackagesChanged;
 kPackageMounted;
 PackageMounted;
 kPackageUnmounted;
 PackageUnmounted;
 kRescanPackages;
 kSafetyManagement;
CCL Safety;
 kSafetyOptionsChanged;
 SafetyOptionsChanged;
 kModuleException;
 kSystemInformation;
CCL SystemInformation;
 kContentLocationChanged;
 ContentLocationChanged;
 kDeploymentLocationChanged;
 kSettings;
CCL Settings;
 kAutoSaveSettings;
 AutoSaveSettings;
 kBackupSettings;

} // namespace Signals

Detailed Documentation

Global Variables

 kPluginPresentationChanged

args[0]: sender [object] or change type [string] (optional, see type strings in IPluginPresentation) args[1]: affected plug-in category (optional, for certain change types)

 kApplication

Signals related to Application.

CCL Application

(IN) Feature is disabled.

 FeatureDisabled

(IN) Request application restart.

args[0]: additional message, args[1]: already confirmed by user (tbool)

 RequestRestart

(IN) Request application shutdown.

args[0]: IVariant, false if quit has been canceled

 RequestQuit

Signals related to Preset Manager.

CCL PresetManager

(OUT) arg[0]: IPreset.

A new preset was created.

 PresetCreated

(OUT) arg[0]: IPreset.

A preset was removed.

 PresetRemoved

(OUT) New presets might have been found, others might have disappeared (no individual kPresetCreated/kPresetRemoved messages are sent).

 PresetsRefreshed

(OUT) arg[0]: preset class (string, e.g.

plug-in class ID); arg[1]: sortPath (string). The subfolders for a preset class have changed, e.g. a folder was created or removed.

 PresetSubFolderRemoved

(OUT) arg[0]: preset class (string, e.g.

plug-in class ID), arg[1]: favorite folder path of interest (string). Favorite presets for a preset class have changed, e.g. favorite state or favorite folder of a preset changed, or favorite folder was created, removed, renamed.

 PresetFavoritesChanged

(OUT) arg[0]: IPreset.

The user wants to “open” the preset.

 OpenPreset

(OUT) arg[0]: IUrl of a preset file; arg[1]: meta info as IAttributeList.

The preset should be “revealed” (e.g. in a browser).

 RevealPreset

(OUT) arg[0]: IMenu; arg[1]: IObjectNode (preset component).

A preset menu is about to be opened and may be extended.

 ExtendPresetMenu

(OUT) args[0]: IUnknownList with presets.

Asynchronous preset scan has completed.

 GetPresetsCompleted

Signals related to Document Manager.

CCL DocumentManager

(IN) args[0]: IDocument (optional)

 DocumentDirty

Signals related to Editors.

CCL EditorRegistry

(OUT) args[0]: IObject of editor.

 EditorActivated

Signals related to Editing.

CCL Editing

(OUT) args[0]: (IUnkown) data (e.g.

an IUrl) to be inserted at current “insert position”; arg[1]: (bool) replace existing data.

 InsertData

Signals related to Debugging.

CCL Debug

(OUT) args[1]: IMenu

 kExtensionManager

Signals related to Extensions.

CCL ExtensionManager

Extension has been installed.

arg[0]: IExtensionDescription

 kGUI

General GUI related signals.

 GUI

arg[0]: new orientation (OrientationType)

 OrientationChanged

arg[0]: IColorScheme

 ColorSchemeChanged

Dimensions of status bar etc.

changed

 SystemMetricsChanged

Graphics engine reset happened.

 GraphicsEngineReset

Signals related to Controls.

GUI Controls

arg[0]: menu (IContextMenu), arg[1]: identity (IUnknown), arg[2]: result (IVariant), args[3]: control class (optional, UID string)

 ControlContextMenu

Hide all user tooltips.

 HideTooltip

Hide (non-modal) context menu.

 HideContextMenu

Restore a previously hidden (non-modal) context menu; arg[0]: x-position (int), arg[1]: y-position (int) - both optional, in screen coords.

 RestoreContextMenu

Signal that a context menu was opened (arg0 true) or closed (arg0 false)

 ContextMenuOpened

Messages sent by a TabView to the controller of its parameter.

Sent when tab menu icon clicked; arg[0]: parameter name (string), arg[1]: tab index (int), arg[2]: (IMenu)

GUI TabView TabMenu

Sent before dragging a tab; arg[0]: parameter name (string), arg[1]: dragged tab index (int), arg[2]: drag session (IDragSession)

GUI TabView BeforeDrag

Sent e.g.

when receiving a drag session; arg[0]: parameter name (string), arg[1]: result (IDataTarget, out), args[2]: data (IUnknownList), arg[3]: drag session (IDragSession)

GUI TabView GetDataTarget

Sent to perform tab reordering; arg[0]: parameter name (string), arg[1]: tab index to move (int), arg[2]: target index (int)

GUI TabView Reorder

Sent to query if tab reordering is allowed; arg[0]: parameter name (string), arg[1]: tab index to move (int), arg[2]: target index (int); arg[3]: result value (IVariant as bool)

GUI TabView CanReorder

Messages sent by a Divider to the controller of its parameter.

Sent on a double click on a divder, controller sets arg[1] to true if handled; arg[0]: parameter (IParameter), arg[1]: result (bool, out)

 kHelpManager

Signals related to help system.

CCL HelpManager

(OUT) Help file not found.

args[0]: IVariant, true to suppress error message.

 kTransfers

Signals related to transfer manager.

CCL Transfers

Reveal given transfer args[0]: ITransfer args[1]: force (tbool)

 RevealTransfer

Transfer is paused args[0]: ITransfer args[1]: state (tbool)

 kWebFiles

Signals related to web file service.

CCL WebFiles

Volumes have changed.

arg[0]: volume name; arg[1]: type of change (optional, e.g. “mounted”, “unmounted”)

 unmounted

Directory has changed (upload via transfer manager or file operation) args[0]: WebFS URL (IUrl)

 DirectoryChanged

Volume information has changed.

arg[0]: volume name

 VolumeInfoChanged

Reveal given volume arg[0]: volume name.

 kPlugIns

Signals related to Plug-In Manager.

CCL PlugIns

arg[0]: class category (String)

 ClassCategoryChanged

arg[0]: IProgressNotify, args[1]: IUnknownList

 RescanPlugIns

no arguments

 ResetBlocklist

no arguments

 ResetBlocklistDone

no arguments

 kErrorHandler

Signals related to Error Handler.

CCL ErrorHandler

[OUT] A crash is being reported arg[0]: IStream

 CrashReported

[OUT] Low memory notification.

 kLocales

Signals related to Locales.

CCL Locales

[OUT] Input language (keyboard layout) changed.

 InputLanguageChanged

[OUT] Application language changed (valid after next restart).

args[0]: language code; args[1]: ILanguagePack (can be null).

 kFileSystem

Signals related to the native file system.

CCL FileSystem

(OUT) arg[0]: IUrl.

A file is about to be moved or deleted.

 ReleaseFile

(OUT) arg[0]: IUrl.

A file has been created or found by the application.

 FileCreated

(OUT) arg[0]: IUrl.

A file has been removed from it’s original location.

 FileRemoved

(OUT) arg[0]: IUrl old path, arg[1] IUrl new path, arg[2] bool success.

A file has been moved to a new location.

 FileMoved

(OUT) arg[0]: IUrl.

A file has been modified.

 kPackageHandler

Signals related to package handler.

CCL PackageHandler

A package location changed.

 PackageLocationChanged

List of mounted packages has changed.

 PackagesChanged

A package was mounted.

arg[0]: IPackageFile

 PackageMounted

A package was unmounted.

arg[0]: IPackageFile

 PackageUnmounted

Rescan packages.

 kSafetyManagement

Signals related to safety management.

CCL Safety

(OUT) Safety options changed.

 SafetyOptionsChanged

(OUT) One or more modules behaved unexpectedly.

arg[0]: List of IUrl ‘s, module paths.

 kSystemInformation

Signals related to System Information.

CCL SystemInformation

(OUT) arg[0]: IUrl with new content location; arg[1]: IUrl with old location.

 ContentLocationChanged

(OUT) arg[0]: IUrl with new deployment location.

 kSettings

Signals related to Settings.

CCL Settings

Auto-save Settings.

 AutoSaveSettings

Backup Settings (args[0]: IUnknownList to collect IUrls)