SHAPER  9.12.0
ModuleBase_Preferences Class Reference

Class for manipulation with preferences in the application. More...

Static Public Member Functions

static bool editPreferences (ModuleBase_Prefs &theModified)
 Shows a dialog box to edit preferences. More...
 
static SUIT_ResourceMgr * resourceMgr ()
 Returns currently installed resource manager. More...
 
static void setResourceMgr (SUIT_ResourceMgr *theMgr)
 Sets a resource manager It is used in case of necessity to define external resource manager (not SHAPER) More...
 
static void updateConfigByResources ()
 Updates Config_PropManager properties by module from SUIT_ResourceMgr. More...
 
static void loadCustomProps ()
 Loads properties defined by module to Config_PropManager. More...
 
static void createEditContent (ModuleBase_IPrefMgr *thePref, int thePage)
 Create editable content. More...
 
static void resetResourcePreferences (SUIT_PreferenceMgr *thePref)
 Retrieve preferences of resource manage to default state. More...
 
static void resetConfigPropPreferences (SUIT_PreferenceMgr *thePref)
 Retrieve preferences of config prop to default state. More...
 
static void updateSketchTab (ModuleBase_IPrefMgr *thePref, int thePageId)
 Updates content of preferences for sketch tab. More...
 

Static Public Attributes

static const QString VIEWER_SECTION = "Viewer"
 Name of preferences of viewer section. More...
 
static const QString MENU_SECTION = "Menu"
 Name of preferences of menu section. More...
 
static const QString GENERAL_SECTION = "General"
 Name of preferences of general section. More...
 

Detailed Description

Class for manipulation with preferences in the application.

Member Function Documentation

◆ editPreferences()

bool ModuleBase_Preferences::editPreferences ( ModuleBase_Prefs &  theModified)
static

Shows a dialog box to edit preferences.

Parameters
theModifieda list of modified preferences

◆ resourceMgr()

SUIT_ResourceMgr * ModuleBase_Preferences::resourceMgr ( )
static

Returns currently installed resource manager.

◆ setResourceMgr()

static void ModuleBase_Preferences::setResourceMgr ( SUIT_ResourceMgr *  theMgr)
inlinestatic

Sets a resource manager It is used in case of necessity to define external resource manager (not SHAPER)

Parameters
theMgrresource manager

◆ updateConfigByResources()

void ModuleBase_Preferences::updateConfigByResources ( )
static

Updates Config_PropManager properties by module from SUIT_ResourceMgr.

◆ loadCustomProps()

void ModuleBase_Preferences::loadCustomProps ( )
static

Loads properties defined by module to Config_PropManager.

◆ createEditContent()

void ModuleBase_Preferences::createEditContent ( ModuleBase_IPrefMgr thePref,
int  thePage 
)
static

Create editable content.

Parameters
thePrefinterface to preference manager
thePagean id of a page

◆ resetResourcePreferences()

void ModuleBase_Preferences::resetResourcePreferences ( SUIT_PreferenceMgr thePref)
static

Retrieve preferences of resource manage to default state.

◆ resetConfigPropPreferences()

void ModuleBase_Preferences::resetConfigPropPreferences ( SUIT_PreferenceMgr thePref)
static

Retrieve preferences of config prop to default state.

◆ updateSketchTab()

void ModuleBase_Preferences::updateSketchTab ( ModuleBase_IPrefMgr thePref,
int  thePageId 
)
static

Updates content of preferences for sketch tab.

Field Documentation

◆ VIEWER_SECTION

const QString ModuleBase_Preferences::VIEWER_SECTION = "Viewer"
static

Name of preferences of viewer section.

◆ MENU_SECTION

const QString ModuleBase_Preferences::MENU_SECTION = "Menu"
static

Name of preferences of menu section.

◆ GENERAL_SECTION

const QString ModuleBase_Preferences::GENERAL_SECTION = "General"
static

Name of preferences of general section.