[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] Reference for unit 'FPimage' (#fcl)

TFPCustomImage

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

TFPCustomImage - FreePascal base definition for all Image classes

Declaration

Source position: fpimage.pp line 91

type TFPCustomImage = class(TPersistent)

protected

  procedure SetInternalColor(); virtual;

  

SetInternalColor - specify the internal colour (using TFPColor format)

  function GetInternalColor(); virtual;

  

GetInternalColor - finds the internal colour from local store

  procedure SetInternalPixel(); virtual; abstract;

  

SetInternalPixel - specifies the integer Color of a pixel located at the given coordinates

  function GetInternalPixel(); virtual; abstract;

  

GetInternalPixel - returns the integer Color of the specified pixel

  procedure SetUsePalette(); virtual;

  

SetUsePalette - specifies whether a palette is to be used in painting the Image

  procedure Progress(); virtual;

  

Progress - method for displaying the progress of a drawing or painting action

public

  constructor create(); virtual;

  

Create - constructor for TFPCustomImage: calls inherited Create then initialises position and size, makes a stringlist

  destructor destroy; override;

  

Destroy - destructor for TFPCustomImage: frees the Palette then calls inherited Destroy

  procedure Assign(); override;

  procedure LoadFromStream();

  

LoadFromStream loads data from the specified stream, optionally using the specified reader

  procedure LoadFromFile();

  

LoadFromFile - reads data from the specified file, optionally using the specified reader

  procedure SaveToStream();

  

SaveToStream - writes the data to the specified stream, using the specified writer

  procedure SaveToFile();

  

SaveToFile - writes image data to the specifed file, using the specified writer

  procedure SetSize(); virtual;

  

SetSize - specify the size of the Image

  property Height: Integer; [rw]

  

The Height of the image

  property Width: Integer; [rw]

  

The Width of the image

  property Colors: TFPColor; default; [rw]

  

The Colors to be used at the nominated position

  property UsePalette: Boolean; [rw]

  

UsePalette - Use of palette for colors

  property Palette: TFPPalette; [r]

  

The Palette to be used in painting the Image

  property Pixels: Integer; [rw]

  

The Pixels (integer value) found at the specified location

  property Extra: String; [rw]

  

Extra - Info unrelated with the image representation

  property ExtraValue: String; [rw]

  

ExtraValue - additional information stored with the image

  property ExtraKey: String; [rw]

  

ExtraKey - an additional key stored with the image

  procedure RemoveExtra();

  

RemoveExtra - ge rid of the ExtraKey

  function ExtraCount;

  

ExtraCount - the number of additional (non-image) items stored with the Image

  property OnProgress: TFPImgProgressEvent; [rw]

  

OnProgress - event handler for displaying progress of the painting process

end;

Inheritance

TFPCustomImage

  

TFPCustomImage - FreePascal base definition for all Image classes

|

TPersistent

|

TObject

The latest version of this document can be found at lazarus-ccr.sourceforge.net.