PendingRedraws Class Reference

Encapsulates a set of regions in a DocView, which must be accumulated in order for them to be redrawn at some point, possibly all in one go. This class chooses the most efficient invalidation method, according to the number and nature of regions added. More...

#include <docview.h>

Inheritance diagram for PendingRedraws:

List of all members.

Public Member Functions
	PendingRedraws ()
	Initialise a PendingRedraws object.
	~PendingRedraws ()
	Destroys a PendingRedraws object.
BOOL	AddInvalidRegion (Spread *, DocRect, Node *pInvalidNode)
	Add another invalid region to the specified Spread's collection.
void	FlushRedraw (DocView *)
	Cause all pending update regions on all spreads for this DocView to be updated immediately.
void	HandleNodeDeletion (Node *pNode)
	Cause all pending update regions on all spreads for this DocView to be updated immediately.
Private Member Functions
	CC_DECLARE_MEMDUMP (PendingRedraws)

---

Detailed Description

Encapsulates a set of regions in a DocView, which must be accumulated in order for them to be redrawn at some point, possibly all in one go. This class chooses the most efficient invalidation method, according to the number and nature of regions added.

Author:

Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>

Date:

22/12/94

See also:

SpreadRedraws

Definition at line 174 of file docview.h.

---

Constructor & Destructor Documentation

PendingRedraws::PendingRedraws (   )

Initialise a PendingRedraws object. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 22/12/94 See also: SpreadRedraws; PendingRedraws Definition at line 538 of file docview.cpp. { }

PendingRedraws::~PendingRedraws (   )

Destroys a PendingRedraws object. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 22/12/94 See also: SpreadRedraws; PendingRedraws Definition at line 554 of file docview.cpp. { DeleteAll(); }

---

Member Function Documentation

BOOL PendingRedraws::AddInvalidRegion (  Spread *  pSpread, DocRect  Rect, Node *  pInvalidNode )

Add another invalid region to the specified Spread's collection. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 22/12/94 Parameters: pSpread  - the spread on which the invalid region is located. [INPUTS] Rect - the invalid region (in document co-ordinates) Returns: TRUE if added ok; FALSE if not Errors: Out of memory => ERROR1 See also: SpreadRedraws; PendingRedraws Definition at line 576 of file docview.cpp. { // Look for this spread in our list SpreadRedraws *pItem = (SpreadRedraws *) GetHead(); while ((pItem != NULL) && (pItem->GetSpread() != pSpread)) { // Nope - try next item pItem = (SpreadRedraws *) GetNext(pItem); } if (pItem == NULL) { // No entry for the spread - we'd better make one pItem = new SpreadRedraws(pSpread); // Did it work? if (pItem == NULL) return FALSE; // Yes - add to the list AddTail(pItem); } // Got an an entry for this spread - add the region pItem->AddInvalidRegion(Rect, pInvalidNode); // All ok return TRUE; }

PendingRedraws::CC_DECLARE_MEMDUMP (  PendingRedraws   )  [private]

void PendingRedraws::FlushRedraw (  DocView *  pDocView  )

Cause all pending update regions on all spreads for this DocView to be updated immediately. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 22/12/94 Parameters: pDocView  - the DocView to invalidate. [INPUTS] See also: SpreadRedraws; PendingRedraws Definition at line 620 of file docview.cpp. { // Invalidate the regions on each spread... SpreadRedraws *pItem = (SpreadRedraws *) GetHead(); while (pItem != NULL) { // Invalid the regions on this spread, and delete this item pItem->FlushRedraw(pDocView); delete RemoveItem(pItem); // Now try the next item... pItem = (SpreadRedraws *) GetHead(); } }

void PendingRedraws::HandleNodeDeletion (  Node *  pNode  )

Cause all pending update regions on all spreads for this DocView to be updated immediately. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 22/12/94 Parameters: pDocView  - the DocView to invalidate. [INPUTS] See also: SpreadRedraws; PendingRedraws Definition at line 650 of file docview.cpp. { // Invalidate the regions on each spread... SpreadRedraws *pItem = (SpreadRedraws *) GetHead(); while (pItem != NULL) { pItem->ClearBackmostChangedNode(pNode); // Now try the next item... pItem = (SpreadRedraws *) this->GetNext(pItem); } }

---

The documentation for this class was generated from the following files:

• Kernel/docview.h (r1785/r1718)
• Kernel/docview.cpp (r1785/r1729)

---