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
Embarcadero Technologies does not currently have any additional information.
Handles a message from a control.
Initializes data about styles and style engines.
Embarcadero Technologies does not currently have any additional information.
Embarcadero Technologies does not currently have any additional information.
Check if a Vcl Style file is valid
Embarcadero Technologies does not currently have any additional information.
Embarcadero Technologies does not currently have any additional information.
Loads a VCL style from a file
Loads a style from the specified resource.
Notifies the style engine of an event that occured.
Registers the instance of a style specified by the Style parameter.
Registers a style class with extension, description, and resource type.
Embarcadero Technologies does not currently have any additional information.
Embarcadero Technologies does not currently have any additional information.
Embarcadero Technologies does not currently have any additional information.
Sets the active style by name, instance, or handle.
Loads a style from a resource without raising an exception.
Embarcadero Technologies does not currently have any additional information.
Sets the style specified by name as the active style, without raising an exception.
Uninitializes data about styles and style engines.
Embarcadero Technologies does not currently have any additional information.
Unregisters a style class specified by the StyleClass parameter.
Unregisters the style engine specified by the AEngineClass parameter.
Attributes
Returns the current style.
ClassName
Returns the TObject.ClassName
CustomStyleServices:
str:
CustomStyleServices:
StyleManager.TStyleClassDescriptor:
Provides access to the VCL style names.
- ActiveStyle¶
Returns the current style.
- CheckSysClassName(AClassName: str) bool ¶
Embarcadero Technologies does not currently have any additional information.
- DesignerStyle¶
CustomStyleServices:
- DesignerStyleName¶
str:
- 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.
- Initialize()¶
Initializes data about styles and style engines.
Note: This function is reserved for internal use only. Do not call it directly.
- IsCustomStyleAvailable(AControl: Control) bool ¶
Embarcadero Technologies does not currently have any additional information.
- IsSystemStyleDefault(AControl: Control) bool ¶
Embarcadero Technologies does not currently have any additional information.
- IsValidStyle()¶
Check if a Vcl Style file is valid
- LoadDesigningStyle(FileName: str) StyleManager.TStyleServicesHandle ¶
Embarcadero Technologies does not currently have any additional information.
- LoadDesigningStyles(FileNames: tuple) None ¶
Embarcadero Technologies does not currently have any additional information.
- LoadFromFile()¶
Loads a VCL style from a file
- 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.
- 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.
- RegisterStyle(Style: CustomStyleServices) None ¶
Registers the instance of a style specified by the Style parameter.
- 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.
- RemoveDesigningStyle(Name: str) None ¶
Embarcadero Technologies does not currently have any additional information.
- ResetActiveDesigningStyle()¶
- ResetDesigningStyles()¶
Embarcadero Technologies does not currently have any additional information.
- SetDesigningStyle(Name: str) None ¶
Embarcadero Technologies does not currently have any additional information. Embarcadero Technologies does not currently have any additional information.
- 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.
- 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.
- TrySetDesigningStyle(Name: str, ShowErrorDialog: bool) bool ¶
Embarcadero Technologies does not currently have any additional information.
- 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.
- UnInitialize()¶
Uninitializes data about styles and style engines.
Note: This function is reserved for internal use only. Do not call it directly.
- UnRegisterStyle(Style: CustomStyleServices) None ¶
Embarcadero Technologies does not currently have any additional information.
- UnRegisterStyleClass(StyleClass: CustomStyleServicesClass) None ¶
Unregisters a style class specified by the StyleClass parameter.
- UnRegisterStyleEngine(AEngineClass: CustomStyleEngineClass) None ¶
Unregisters the style engine specified by the AEngineClass parameter.