StyleManager¶

Qualified name: delphivcl.StyleManager

class StyleManager¶

Bases: Object

Handles styles-related operations. Use TStyleManager to:

Register and unregister style classes. Set the active style. Load styles from files or resources. Retrieve styles and their descriptors. Replace and retrieve the style engine.

Methods

`CheckSysClassName`	TStyleManager.CheckSysClassName(AClassName: str) -> bool Embarcadero Technologies does not currently have any additional information.
`HandleMessage`	TStyleManager.HandleMessage(Control: WinControl, Message: Message, DefWndProc: Callable[[Message], None]) -> bool Handles a message from a control.
`Initialize`	Initializes data about styles and style engines.
`IsCustomStyleAvailable`	TStyleManager.IsCustomStyleAvailable(AControl: Control) -> bool Embarcadero Technologies does not currently have any additional information.
`IsSystemStyleDefault`	TStyleManager.IsSystemStyleDefault(AControl: Control) -> bool Embarcadero Technologies does not currently have any additional information.
`IsValidStyle`	TStyleManager.IsValidStyle() Check if a Vcl Style file is valid
`LoadDesigningStyle`	TStyleManager.LoadDesigningStyle(FileName: str) -> StyleManager.TStyleServicesHandle Embarcadero Technologies does not currently have any additional information.
`LoadDesigningStyles`	TStyleManager.LoadDesigningStyles(FileNames: tuple) -> None Embarcadero Technologies does not currently have any additional information.
`LoadFromFile`	TStyleManager.LoadFromFile() Loads a VCL style from a file
`LoadFromResource`	TStyleManager.LoadFromResource(Instance: int, ResourceName: str) -> StyleManager.TStyleServicesHandle Loads a style from the specified resource.
`Notification`	TStyleManager.Notification(Operation: CustomStyleEngine.TStyleEngineNotification, Data: Pointer) -> None Notifies the style engine of an event that occured.
`RegisterStyle`	TStyleManager.RegisterStyle(Style: CustomStyleServices) -> None Registers the instance of a style specified by the Style parameter.
`RegisterStyleClass`	TStyleManager.RegisterStyleClass(Extension: str, Description: str, ResourceType: str, StyleClass: CustomStyleServicesClass) -> None Registers a style class with extension, description, and resource type.
`RemoveDesigningStyle`	TStyleManager.RemoveDesigningStyle(Name: str) -> None Embarcadero Technologies does not currently have any additional information.
`ResetActiveDesigningStyle`	TStyleManager.ResetActiveDesigningStyle()
`ResetDesigningStyles`	Embarcadero Technologies does not currently have any additional information.
`SetDesigningStyle`	TStyleManager.SetDesigningStyle(Name: str) -> None Embarcadero Technologies does not currently have any additional information.
`SetStyle`	TStyleManager.SetStyle(Name: str) -> None Sets the active style by name, instance, or handle.
`TryLoadFromResource`	TStyleManager.TryLoadFromResource(Instance: int, ResourceName: str, ResourceType: PWideChar, Handle: StyleManager.TStyleServicesHandle) -> bool Loads a style from a resource without raising an exception.
`TrySetDesigningStyle`	TStyleManager.TrySetDesigningStyle(Name: str, ShowErrorDialog: bool) -> bool Embarcadero Technologies does not currently have any additional information.
`TrySetStyle`	TStyleManager.TrySetStyle(Name: str, ShowErrorDialog: bool) -> bool Sets the style specified by name as the active style, without raising an exception.
`UnInitialize`	Uninitializes data about styles and style engines.
`UnRegisterStyle`	TStyleManager.UnRegisterStyle(Style: CustomStyleServices) -> None Embarcadero Technologies does not currently have any additional information.
`UnRegisterStyleClass`	TStyleManager.UnRegisterStyleClass(StyleClass: CustomStyleServicesClass) -> None Unregisters a style class specified by the StyleClass parameter.
`UnRegisterStyleEngine`	TStyleManager.UnRegisterStyleEngine(AEngineClass: CustomStyleEngineClass) -> None Unregisters the style engine specified by the AEngineClass parameter.

Attributes

`ActiveStyle`	Returns the current style.
`ClassName`	Returns the TObject.ClassName
`DesignerStyle`	CustomStyleServices:
`DesignerStyleName`	str:
`Style`	CustomStyleServices:
`StyleDescriptor`	StyleManager.TStyleClassDescriptor:
`StyleNames`	Provides access to the VCL style names.

ActiveStyle¶: Returns the current style.

classmethod CheckSysClassName(AClassName: str) → bool¶: Embarcadero Technologies does not currently have any additional information.

DesignerStyle¶: CustomStyleServices:

DesignerStyleName¶: str:

classmethod HandleMessage(Control: WinControl, Message: Message, DefWndProc: Callable[[Message], None]) → bool¶

Handles a message from a control. HandleMessage sends the message received from a control to the style engine.

Parameter

Meaning

Control

The component that passes the message.

Message

The message that is passed to the engine.

DefWndProc

The default window procedure to be called for the message.

classmethod Initialize()¶

Initializes data about styles and style engines.

Note: This function is reserved for internal use only. Do not call it directly.

classmethod IsCustomStyleAvailable(AControl: Control) → bool¶: Embarcadero Technologies does not currently have any additional information.

classmethod IsSystemStyleDefault(AControl: Control) → bool¶: Embarcadero Technologies does not currently have any additional information.

IsValidStyle()¶: Check if a Vcl Style file is valid

classmethod LoadDesigningStyle(FileName: str) → StyleManager.TStyleServicesHandle¶: Embarcadero Technologies does not currently have any additional information.

classmethod LoadDesigningStyles(FileNames: tuple) → None¶: Embarcadero Technologies does not currently have any additional information.

LoadFromFile()¶: Loads a VCL style from a file

classmethod LoadFromResource(Instance: int, ResourceName: str) → StyleManager.TStyleServicesHandle¶

Loads a style from the specified resource. Note that LoadFromResource does not automatically switch to the loaded style. To do that, call the SetStyle method.

Parameter

Meaning

Instance

The instance handle of the loaded resource.

ResourceName

The string associated with the resource.

ResType

A string that identifies the type of resource. Loads a style from the specified resource. Note that LoadFromResource does not automatically switch to the loaded style. To do that, call the SetStyle method.

Parameter

Meaning

Instance

The instance handle of the loaded resource.

ResourceName

The string associated with the resource.

ResType

A string that identifies the type of resource.

classmethod Notification(Operation: CustomStyleEngine.TStyleEngineNotification, Data: Pointer) → None¶

Notifies the style engine of an event that occured.

Parameter

Meaning

Operation

The action that is performed.

Data

The data on which the operation is executed.

classmethod RegisterStyle(Style: CustomStyleServices) → None¶: Registers the instance of a style specified by the Style parameter.

classmethod RegisterStyleClass(Extension: str, Description: str, ResourceType: str, StyleClass: CustomStyleServicesClass) → None¶

Registers a style class with extension, description, and resource type.

Parameter

Meaning

Extension

A string that specifies the extension used with the style files.

Description

A string that specifies a description of the style.

ResourceType

A string associated with the resource type.

StyleClass

Specifies the style class to be registered. Registers a style class with extension, description, and resource type.

Parameter

Meaning

Extension

A string that specifies the extension used with the style files.

Description

A string that specifies a description of the style.

ResourceType

A string associated with the resource type.

StyleClass

Specifies the style class to be registered.

classmethod RemoveDesigningStyle(Name: str) → None¶: Embarcadero Technologies does not currently have any additional information.

classmethod ResetActiveDesigningStyle()¶

classmethod ResetDesigningStyles()¶: Embarcadero Technologies does not currently have any additional information.

classmethod SetDesigningStyle(Name: str) → None¶: Embarcadero Technologies does not currently have any additional information. Embarcadero Technologies does not currently have any additional information.

classmethod SetStyle(Name: str) → None¶

Sets the active style by name, instance, or handle.

Parameter

Meaning

Name

The name of the style to be set as the active style.

Style

A style instance to be set as the active style.

Handle

The handle of the style to be set as the active style, as returned by the LoadFromFile or LoadFromResource method. Sets the active style by name, instance, or handle.

Parameter

Meaning

Name

The name of the style to be set as the active style.

Style

A style instance to be set as the active style.

Handle

The handle of the style to be set as the active style, as returned by the LoadFromFile or LoadFromResource method. Sets the active style by name, instance, or handle.

Parameter

Meaning

Name

The name of the style to be set as the active style.

Style

A style instance to be set as the active style.

Handle

The handle of the style to be set as the active style, as returned by the LoadFromFile or LoadFromResource method.

Style¶: CustomStyleServices:

StyleDescriptor¶: StyleManager.TStyleClassDescriptor:

StyleNames¶: Provides access to the VCL style names.

classmethod TryLoadFromResource(Instance: int, ResourceName: str, ResourceType: PWideChar, Handle: StyleManager.TStyleServicesHandle) → bool¶

Loads a style from a resource without raising an exception. TryLoadFromResource returns True if the style was successfully loaded, or False otherwise.

Parameter

Meaning

Instance

The instance handle of the loaded resource.

ResourceName

The string associated with the resource.

ResType

A string that identifies the type of resource.

Handle

The handle of the loaded style.

classmethod TrySetDesigningStyle(Name: str, ShowErrorDialog: bool) → bool¶: Embarcadero Technologies does not currently have any additional information.

classmethod TrySetStyle(Name: str, ShowErrorDialog: bool) → bool¶

Sets the style specified by name as the active style, without raising an exception. TrySetStyle returns True if the style was successfully set as the active style, and False otherwise.

Parameter

Meaning

Name

A string that specifies the name of the style to be set as active.

ShowErrorDialog

Specifies whether an error dialog box is shown if the style cannot be set as the active style.

classmethod UnInitialize()¶

Uninitializes data about styles and style engines.

Note: This function is reserved for internal use only. Do not call it directly.

classmethod UnRegisterStyle(Style: CustomStyleServices) → None¶: Embarcadero Technologies does not currently have any additional information.

classmethod UnRegisterStyleClass(StyleClass: CustomStyleServicesClass) → None¶: Unregisters a style class specified by the StyleClass parameter.

classmethod UnRegisterStyleEngine(AEngineClass: CustomStyleEngineClass) → None¶: Unregisters the style engine specified by the AEngineClass parameter.