Show: Object Pascal C++
Display Preferences

Customizing FireMonkey Applications with Styles

From Appmethod Topics
Jump to: navigation, search

Go Up to FireMonkey Application Design


FireMonkey controls are arrangements of a tree composed of subcontrols, primitive shapes, and brushes, decorated with effects. These compositions are defined as styles, stored in a style book. The individual elements of a style are internally called resources; because that term has several other meanings, the term style-resource is used for clarity. Styles provide a great deal of customizations without subclassing.

The FireMonkey styles that are provided with the product are saved in .Style files located in C:\Program Files (x86)\Embarcadero\Studio\17.0\Redist\styles\Fmx. You can load these styles with FireMonkey Style Designer.

Default Styles

In FireMonkey, each control class has a default style, hard-coded per platform. A copy of the internal hard-coded style for a control class is created after you clicked the Edit Default Style command on the control's shortcut menu.

To see the style definitions in the FireMonkey Style Designer:

  1. Drop a TStyleBook on the form in the Form Designer.
  2. Double-click the stylebook.

For example, the default style of FMX.StdCtrls.TPanel is defined simply as:

  • panelstyle: TRectangle

The name of the style-resource that defines the style is "panelstyle". It refers to a TRectangle. The appearance of this rectangle can be changed in the Style Designer, and then every TPanel on the form will have that appearance by default.

However, there is no rule that a TPanel must be represented by a TRectangle. A TRoundRect or TEllipse would work. Even simple controls can be a complex composition.

Consider FMX.StdCtrls.TCheckBox, which looks something like:

  • checkboxstyle: TLayout (the entire control)
    • TLayout (the layout for the box)
      • background: TRectangle (the box itself, which is a composition of:)
        • TGlowEffect (glows when the control has focused)
        • TRectangle (the outside rectangle that forms the box)
        • TRectangle (the inside rectangle)
        • TColorAnimation (color animation when the mouse moves over)
        • TColorAnimation (and back out)
        • checkmark: TPath (the check inside the box, drawn as a path, which has:)
          • TColorAnimation (its color animation when the check is toggled on or off)
    • text: TText (and back under the top level, the text label)

The style is named so that it can be found and used. In addition, certain subelements are named, so that they can be referenced. When the IsChecked property is toggled, the "checkmark" has its visibility changed (by animating the opacity of its color from solid to transparent). Setting the Text property of the TCheckBox sets the Text property of the underlying TText named "text".

Resource Naming and Referencing

Two properties with similar names form the links between a control, its style, and its subcomponents:

  • The StyleName is the name by which a style or style subcomponent is known to others and can be found.
  • A control's StyleLookup property is set to the name of the desired style-resource to adopt that style for the specific control. When StyleLookup is empty, the default style is used.
  • Subcomponents can be found by calling FindStyleResource with the desired name.

A control has both properties because it can be styled, and it can be a style element (or part of one). Simpler components like shapes cannot be styled, and can only be a style element.

Style Resource Storage: Multi-Platform TStyleBook

Now in FireMonkey, a TStyleBook component is a collection of styles for various target platforms. Each item of the collection includes a style and a platform marker (a string). There are two different platform style markers for a custom style and a platform style.

  • For Platform style, there are 4 markers for each target platform, such as Windows, OS X, Android, and iOS.

StyleBook.png

  • For Custom style, the number of markers increased because a customized control should be native on each version of the target platform. Now FireMonkey supports the custom styles for the following platforms:
    • Windows
    • Windows 7
    • Windows 8 Desktop
    • Windows 10 Desktop
    • OSX Yosemite
    • OSX Lion
    • iOS
    • Android Light

Note: There is also the "Default" platform marker. FireMonkey application loads the Default style when the application cannot find the matching styles for the current platform.

The FireMonkey Style Designer allows you to edit, add or remove styles from a TStyleBook component.

To open the FireMonkey Style Designer:

  1. Drop a TStyleBook on the form in the Form Designer.
  2. Double-click the stylebook.

For more information, see FireMonkey Style Designer.

The newly created object is set as the form's StyleBook property so that it takes effect for the form.

A form may have more than one TStyleBook object. The form's StyleBook property may reference any of them, one at a time; or it can be set to nil, which causes the form to revert to hard-coded default styles only.

The FireMonkey Style Designer edits the styles for a single TStyleBook at a time. Double-clicking a TStyleBook on a form opens the Style Designer with those styles. The Style Designer can save the TStyleBook in a text format to a .style file, and can load such a file. The entire set of hard-coded default styles can also be loaded into the Style Designer.

Platform Styles

In FireMonkey, the term platform style refers to a .Style file that contains a set of resources for a platform. To start working with Platform styles, in the Form Designer, double-click the TStyleBook component to open the FireMonkey Style Designer.

In the FireMonkey Style Designer window, you can open an existing .Style file or save current styles to a .Style file, using the Load FMStyle.png and Save FMStyle.png buttons, respectively. The structure tree of the style is displayed in the Structure pane:

Platform Styles.png

Custom Styles

New styles can be created by modifying default styles, or starting from scratch with a single component.

  • To modify a default style, right-click a control on the Form Designer and select Edit Custom Style. The generated style name is derived from the control's name, so you can save a step by choosing a good name for the control first. The generated name is assigned as the control's StyleLookup property, so that it takes effect for that control. The new style is a copy of the control's current style.
    FireMonkey Platform Style.png
  • To add a custom style for new platform, in the FireMonkey Style Designer, click the FireMonkey Style Designer Add Platform.png button and follow the provided onscreen instructions. For more information, see FireMonkey Style Designer.
  • To create a completely new style, modify a .style file and load it with the FireMonkey Style Designer. For example, after saving the current set of styles, edit the file to add before the final end:
object TBrushObject
  StyleName = 'somebrush'
end

Note: After you add a new platform or change the current platform, FireMonkey automatically recreates the custom style for the target control.

Nested Styles

Styles may refer to other styled components. As always, styles are found by their top-level names in the TStyleBook. For example, to use the same gradient:

  1. In the FireMonkey Style Designer, save the existing styles in a .style file.
  2. Edit the file with a text editor to create a TBrushObject. Use an appropriate StyleName.
  3. Load the .style file.
  4. Select the newly defined style so that it appears in the Object Inspector.
  5. Open the Brush property:
    1. Edit the Gradient property with the Brush Designer (choose Edit from the property value's drop-down menu).
    2. Set the Kind property to Gradient.
  6. For each component using the gradient, for example, with a TRectangle's Fill property:
    1. Set the Kind property to Resource.
    2. Open the Resource property (a TBrushResource) and set the StyleLookup to the name of the gradient in Step 2.

Style-Resource Search Sequence

To find a control style, Appmethod goes through the following set of steps, stopping at the first match:

  1. If the form's StyleBook property is set, the Style Book is searched using two names:
    1. The control's StyleLookup property, if set.
    2. A default name constructed from the control's class name in the following way: the default name is composed of the class name without the leading "T", followed by the string "style". For example, if the class name is TEdit, the style name is Editstyle.
  2. The hard-coded default styles are searched using three names:
    1. The control's StyleLookup property, if set.
    2. The default style name constructed from the control's class name.
    3. A default name constructed from the control's parent class name, using the same steps.

Example: The default names for TPanel are "Panelstyle" and "Controlstyle". For TCalloutPanel, the default names are "CalloutPanelstyle" and "Panelstyle".

Note: FireMonkey generates names of default styles (see Steps 2.2 and 2.3) using the GetDefaultStyleLookupName and GetParentClassStyleLookupName virtual methods. Optionally, you can override these methods to change the name generation algorithm.

Name matching is not case-sensitive. If no match is found, the control has no content and is effectively invisible. The code that depends on finding subcomponents will fail. (That should only happen for incomplete or improperly bundled custom controls, since all built-in controls have corresponding hard-coded styles. Direct descendants of built-in classes would have their base class content; second-generation descendants would be empty.)

Form Style

Although TForm is not a control or subclass of TStyledControl, TForm is styled. Its StyleLookup property defaults to "backgroundstyle". The default style-resource with that StyleName is a grey TRectangle.

When loaded, the Align property of the resource is set to Contents to fill the form as the background. It is the first object painted, before the form's other children.

Note: If you call the TStyleManager.SetStyle function in the initialization section of a unit on the main project file, before Application.Initialize, then the style is applied to all forms.

See Also

Personal tools
In other languages