1.17.0.1
Prysm
cohtml::SystemSettings Struct Reference

Settings for a System. More...

Classes

struct  FallBackFormats
 

Public Member Functions

 SystemSettings ()
 

Public Attributes

struct cohtml::SystemSettings::FallBackFormats Formats
 
IAsyncResourceHandlerResourceHandler
 Resource handler for loading assets. More...
 
IDataStorageHandlerDataStorageHandler = nullptr
 Data storage handler used for saving and loading persistent data. More...
 
ILocalizationManagerLocalizationManagerInstance = nullptr
 Optional localization manager. This object MUST outlive the System. Any HTML element created with the data-l10n-id attribute will get its text content replaced by the value returned from this object's ILocalizationManager::Translate method. More...
 
ITextTransformationManagerTextTransformationManager = nullptr
 Optional text transformation manager used to support modifying text in a locale-aware way. CSS properties like text-transform require this interface to be set and implemented to work. More...
 
IInternationalizationManagerInternationalizationManager = nullptr
 Optional internationalization manager used for creating text break iterators. Eastern languages like Chinese, Japanese and Thai won't wrap properly without this implemented. More...
 
CachedResourcesWatermarks CachedImagesSettings
 Controls the low and high watermarks used when deciding when to prune the image cache. More...
 
CachedResourcesWatermarks CachedSVGsSettings
 
int DebuggerPort
 Sets the port where the Debugger can connect to inspect the active Views. Set it to <= 0 to disable debugging. More...
 
bool EnableDebugger
 Enable/Disable the Debugger during the lifetime of the program. More...
 
bool AsynchronousResourceRequestCalls
 Enabled by default. When enabled, each resource request will post a job in the work queue. The IAsyncResourceHandler callbacks will be invoked on a worker thread. This asynchronous behavior allows the client to easily implement resource reading functionality without having to deal with multithreading and yet achieving non-blocking resource reading. When disabled, the IAsyncResourceHandler callbacks will be invoked on the main thread, and its a client's responsibility to schedule any potential blocking operations to achieve asynchronous resource loading and avoid stalling the main thread. More...
 
const char * GenericFontFamilyNameFont
 This options sets the family name of the font that will be used when a generic font family is encountered. Generic font families are "serif", "sans-serif", "monospace", etc. When a font name for the generic family is not specified Cohtml will use the default family name specified by LibraryParams::DefaultStyleFontFamily. More...
 
Fonts::LastResortFontMode LastResortFontMode
 Cohtml uses an embedded font as a last resort font fallback. This option controls how the last resort font is visualized. By default Cohtml will render ASCII printable characters from the last resort font when no other suitable font is found and a square symbol for unresolved unicode characters. The default option is suitable for visualizing simple texts without loading any fonts. FF_Squares will render squares for all characters for which a suitable font was not found which can aid developers to recognize when their font fallback setup isn't working properly. FF_None will disable the last resort font visualization. More...
 

Detailed Description

Settings for a System.

Constructor & Destructor Documentation

◆ SystemSettings()

cohtml::SystemSettings::SystemSettings ( )
inline

Member Data Documentation

◆ AsynchronousResourceRequestCalls

bool cohtml::SystemSettings::AsynchronousResourceRequestCalls

Enabled by default. When enabled, each resource request will post a job in the work queue. The IAsyncResourceHandler callbacks will be invoked on a worker thread. This asynchronous behavior allows the client to easily implement resource reading functionality without having to deal with multithreading and yet achieving non-blocking resource reading. When disabled, the IAsyncResourceHandler callbacks will be invoked on the main thread, and its a client's responsibility to schedule any potential blocking operations to achieve asynchronous resource loading and avoid stalling the main thread.

Note
To make efficient use of the abort resource notifications, this option should be disabled.

◆ CachedImagesSettings

CachedResourcesWatermarks cohtml::SystemSettings::CachedImagesSettings

Controls the low and high watermarks used when deciding when to prune the image cache.

◆ CachedSVGsSettings

CachedResourcesWatermarks cohtml::SystemSettings::CachedSVGsSettings

◆ DataStorageHandler

IDataStorageHandler* cohtml::SystemSettings::DataStorageHandler = nullptr

Data storage handler used for saving and loading persistent data.

◆ DebuggerPort

int cohtml::SystemSettings::DebuggerPort

Sets the port where the Debugger can connect to inspect the active Views. Set it to <= 0 to disable debugging.

◆ EnableDebugger

bool cohtml::SystemSettings::EnableDebugger

Enable/Disable the Debugger during the lifetime of the program.

Note
If enabled it may influence application performance, make sure it is not enabled during benchmarking.

◆ Formats

struct cohtml::SystemSettings::FallBackFormats cohtml::SystemSettings::Formats

◆ GenericFontFamilyNameFont

const char* cohtml::SystemSettings::GenericFontFamilyNameFont

This options sets the family name of the font that will be used when a generic font family is encountered. Generic font families are "serif", "sans-serif", "monospace", etc. When a font name for the generic family is not specified Cohtml will use the default family name specified by LibraryParams::DefaultStyleFontFamily.

◆ InternationalizationManager

IInternationalizationManager* cohtml::SystemSettings::InternationalizationManager = nullptr

Optional internationalization manager used for creating text break iterators. Eastern languages like Chinese, Japanese and Thai won't wrap properly without this implemented.

◆ LastResortFontMode

Fonts::LastResortFontMode cohtml::SystemSettings::LastResortFontMode

Cohtml uses an embedded font as a last resort font fallback. This option controls how the last resort font is visualized. By default Cohtml will render ASCII printable characters from the last resort font when no other suitable font is found and a square symbol for unresolved unicode characters. The default option is suitable for visualizing simple texts without loading any fonts. FF_Squares will render squares for all characters for which a suitable font was not found which can aid developers to recognize when their font fallback setup isn't working properly. FF_None will disable the last resort font visualization.

◆ LocalizationManagerInstance

ILocalizationManager* cohtml::SystemSettings::LocalizationManagerInstance = nullptr

Optional localization manager. This object MUST outlive the System. Any HTML element created with the data-l10n-id attribute will get its text content replaced by the value returned from this object's ILocalizationManager::Translate method.

◆ ResourceHandler

IAsyncResourceHandler* cohtml::SystemSettings::ResourceHandler

Resource handler for loading assets.

◆ TextTransformationManager

ITextTransformationManager* cohtml::SystemSettings::TextTransformationManager = nullptr

Optional text transformation manager used to support modifying text in a locale-aware way. CSS properties like text-transform require this interface to be set and implemented to work.