JCL Help:GetColorFlag

 JCL Help: GetColorFlag Function

Graphics.Colors

JEDI Code Library Help

• Packages
  • RTL enhancements
  • Containers
  • Developer Tools
  • VCL enhancements
• Files
  • Classes
  • Interfaces
  • Functions
  • Variables
  • Constants
  • Types
  • Records
• Project summary
• License

Search in JCL Help

 

Search in all projects

 

Summary

Extracts the Flag component from a TColor.

Pascal

 function GetColorFlag(const Color: TColor): Byte;

Parameters

Parameters	Description
const Color: TColor	The Color value from which to extract the Flag component.

Return Value

The Flag component from the supplied TColor. The value ranges from 0 to 2.

Description

GetColorFlag extracts the Flag component from a TColor value. The Flag component is contained in the high order byte of the TColor value and determines how Delphi displays the color. Currently this can be either 0, 1, or 2 and have the following meaning:

Value	Description
0	The color obtained is the closest matching color in the system palette.
1	The color obtained is the closest matching color in the currently realized palette.
2	The value is matched with the nearest color in the logical palette of the current device context.

See Also

GetRGBValue GetColorRed GetColorGreen GetColorBlue

About

Unit

JclGraphUtils

Donator

Pelle F. S. Liljendal

Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page

The JEDI Code Library source code is hosted at : link to view the current source code, link to the subversion repository