nx_cloud_storage_sdk  1.0
Cloud Storage SDK
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
nx::sdk::IActiveSettingChangedAction Class Referenceabstract

#include <i_active_setting_changed_action.h>

Inheritance diagram for nx::sdk::IActiveSettingChangedAction:
nx::sdk::Interface< IActiveSettingChangedAction > nx::sdk::IRefCountable nx::sdk::RefCountable< IActiveSettingChangedAction > nx::sdk::ActiveSettingChangedAction

Public Member Functions

virtual const char * activeSettingName () const =0
 
virtual const char * settingsModel () const =0
 
Ptr< const IStringMapsettingsValues () const
 
Ptr< const IStringMapparams () const
 
- Public Member Functions inherited from nx::sdk::Interface< IActiveSettingChangedAction >
virtual IRefCountablequeryInterface (const InterfaceId *id)
 
Ptr< InterfacequeryInterface ()
 
Ptr< const InterfacequeryInterface () const
 
- Public Member Functions inherited from nx::sdk::IRefCountable
virtual ~IRefCountable ()=default
 
template<class Interface >
Ptr< InterfacequeryInterface ()
 
template<class Interface >
Ptr< const InterfacequeryInterface () const
 
virtual int addRef () const =0
 
virtual int releaseRef () const =0
 
int refCountThreadUnsafe () const
 

Static Public Member Functions

static auto interfaceId ()
 
- Static Public Member Functions inherited from nx::sdk::IRefCountable
static auto interfaceId ()
 

Protected Member Functions

virtual const IStringMapgetSettingsValues () const =0
 
virtual const IStringMapgetParams () const =0
 
- Protected Member Functions inherited from nx::sdk::Interface< IActiveSettingChangedAction >
virtual IRefCountablequeryInterface (const IRefCountable::InterfaceId *id) override
 
IRefCountablequeryInterfaceSupportingDeprecatedId (const IRefCountable::InterfaceId *id, const Uuid &deprecatedInterfaceId)
 

Additional Inherited Members

- Static Protected Member Functions inherited from nx::sdk::IRefCountable
template<int len>
static constexpr const InterfaceIdmakeId (const char(&charArray)[len])
 
template<class TemplateInstance , class TemplateArg , int len>
static const InterfaceIdmakeIdForTemplate (const char(&baseIdCharArray)[len])
 

Detailed Description

Data sent from the Client to the plugin when the user changes the state of an Active setting.

Member Function Documentation

◆ activeSettingName()

virtual const char* nx::sdk::IActiveSettingChangedAction::activeSettingName ( ) const
pure virtual
Returns
Name of a setting which has triggered this notification.

Implemented in nx::sdk::ActiveSettingChangedAction.

◆ getParams()

virtual const IStringMap* nx::sdk::IActiveSettingChangedAction::getParams ( ) const
protectedpure virtual

Called by params()

Implemented in nx::sdk::ActiveSettingChangedAction.

◆ getSettingsValues()

virtual const IStringMap* nx::sdk::IActiveSettingChangedAction::getSettingsValues ( ) const
protectedpure virtual

◆ params()

Ptr<const IStringMap> nx::sdk::IActiveSettingChangedAction::params ( ) const
inline

If the Active setting defines params in the Manifest, contains the array of their values after they are filled by the user via the Client form. Otherwise, null.

◆ settingsModel()

virtual const char* nx::sdk::IActiveSettingChangedAction::settingsModel ( ) const
pure virtual
Returns
Model of settings the Active setting has been triggered on. Never null.

Implemented in nx::sdk::ActiveSettingChangedAction.

◆ settingsValues()

Ptr<const IStringMap> nx::sdk::IActiveSettingChangedAction::settingsValues ( ) const
inline
Returns
Values currently set in the GUI. Never null.

The documentation for this class was generated from the following file: