SGRedrawInfo Struct Reference

#include <sgtree.h>

List of all members.

Public Attributes
DocRect	Bounds
RenderRegion *	Renderer
DocColour	Foreground
DocColour	Background
DocColour	SelForeground
DocColour	SelBackground
DocColour	Transparent

---

Detailed Description

Comment: MonoOn typedef struct { DocRect Bounds RenderRegion *Renderer; BOOL BgRedraw; DocColour Foreground; DocColour Background; DocColour Transparent; } SGRedrawInfo; MonoOff

This structure is passed down through the SuperGallery Display Tree by the SGDisplayNode::HandleEvent method, when processing REDRAW events. It includes the redraw clipping region which needs to be redrawn, plus a formatting information structure to allow the items to calculate their layout.

Bounds indicates the 'clip rect' for the current redraw. Items outside Bounds should not be redrawn at all.

Renderer points to a render region with which you can draw stuff

Foreground, Background, Transparent, are predefined colours which should be used for the redraw. These are read from host OS settings, so should be used in preference to constant colours where possible, in order to be as host-OS friendly as possible.

A structure is used for easy addition of other information at a later date

See also:

SuperGallery; SGDisplayNode::HandleEvent; SGReformatInfo

Definition at line 364 of file sgtree.h.

---

Member Data Documentation

DocColour SGRedrawInfo::Background

Definition at line 371 of file sgtree.h.

DocRect SGRedrawInfo::Bounds

Definition at line 366 of file sgtree.h.

DocColour SGRedrawInfo::Foreground

Definition at line 370 of file sgtree.h.

RenderRegion* SGRedrawInfo::Renderer

Definition at line 367 of file sgtree.h.

DocColour SGRedrawInfo::SelBackground

Definition at line 373 of file sgtree.h.

DocColour SGRedrawInfo::SelForeground

Definition at line 372 of file sgtree.h.

DocColour SGRedrawInfo::Transparent

Definition at line 374 of file sgtree.h.

---

The documentation for this struct was generated from the following file:

• Kernel/sgtree.h (r1785/r1139)

---