David Alm: Automated Syncronization with Documentation

2012-10-18T17:19:06Z

Automated Syncronization with Documentation

New page

<b><span style="color:red">
This is a Beta Read Only version of this page.
Please review and send recommendations to [mailto:mitov@mitov.com mitov@mitov.com].
We will enable the editing as soon as we are happy with the overall Wiki site.
</span></b>

'''Class:''' [[Interface IGDIPlus.IGPGraphics|IGPGraphics]]

== Syntax ==
=== Delphi: ===
<code>
'''function''' EndContainer( state : TGPGraphicsContainer ) : [[Class IGDIPlus.TGPGraphics|TGPGraphics]];
</code>

=== C++ Builder: ===
<code>
[[Class IGDIPlus.TGPGraphics|TGPGraphics]] '''__fastcall''' EndContainer( TGPGraphicsContainer state );
</code>

=== Visual C++ (MFC): ===
<code>
EndContainer( state );
</code>

== Summary ==
Closes a graphics container that was previously opened by the [[Method function IGDIPlus.IGPGraphics.BeginContainer(TGPRect;TGPRect;TGPUnit) : TGPGraphicsContainer|BeginContainer]] method.

== Description ==
Call this method to close a graphics container that was
previously opened by the [[Method function IGDIPlus.IGPGraphics.BeginContainer(TGPRect;TGPRect;TGPUnit) : TGPGraphicsContainer|BeginContainer]] method.

Example:

The following example sets a clipping region for a Graphics
object and begins a graphics container. It then sets an
additional clipping region for the container and draws
rectangles that demonstrate the effective clipping region
inside the container.

<code>
var
AGraphics : [[Interface IGDIPlus.IGPGraphics|IGPGraphics]];
APath : GraphicsPath ;
ABlackPen : [[Interface IGDIPlus.IGPPen|IGPPen]];
AContainer : IGPGraphicsContainer;

begin
AGraphics := [[Class IGDIPlus.TGPGraphics|TGPGraphics]].Create( ACanvas );

// Set the clipping region for the Graphics object.
AGraphics.[[Method function IGDIPlus.IGPGraphics.SetClip(IGPGraphics;TGPCombineMode) : TGPGraphics|SetClip]](MakeRect(10, 10, 150, 150));

// Begin a graphics container.
AContainer = AGraphics.[[Method function IGDIPlus.IGPGraphics.BeginContainer(TGPRect;TGPRect;TGPUnit) : TGPGraphicsContainer|BeginContainer]]();

// Set an additional clipping region for the container.
AGraphics.[[Method function IGDIPlus.IGPGraphics.SetClip(IGPGraphics;TGPCombineMode) : TGPGraphics|SetClip]]( MakeRect( 100, 50, 100, 75 ));

// Fill a red rectangle in the container.
AGraphics.[[Method function IGDIPlus.IGPGraphics.FillRectangle(IGPBrush;TGPRect) : TGPGraphics|FillRectangle]]( [[Class IGDIPlus.TGPSolidBrush|TGPSolidBrush]].Create( aclRed ), 0, 0, 400, 400);

// End the container, and fill the same rectangle with blue.
graphics.EndContainer( AContainer );
AGraphics.[[Method function IGDIPlus.IGPGraphics.FillRectangle(IGPBrush;TGPRect) : TGPGraphics|FillRectangle]]( [[Class IGDIPlus.TGPSolidBrush|TGPSolidBrush]].Create( aclBlue ), 0, 0, 400, 400);

// Set the clipping region to infinite, and draw the outlines
// of the two previous clipping regions.
AGraphics.[[Method function IGDIPlus.IGPGraphics.ResetClip() : TGPGraphics|ResetClip]]();
ABlack := [[Class IGDIPlus.TGPPen|TGPPen]].Create( aclBlack, 2.0 );
AGraphics.[[Method function IGDIPlus.IGPGraphics.DrawRectangle(IGPPen;TGPRect) : TGPGraphics|DrawRectangle]]( ABlack, 10, 10, 150, 150 );
AGraphics.[[Method function IGDIPlus.IGPGraphics.DrawRectangle(IGPPen;TGPRect) : TGPGraphics|DrawRectangle]]( ABlack, 100, 50, 100, 75 );
end;
</code>
Remarks
When you call the [[Method function IGDIPlus.IGPGraphics.BeginContainer(TGPRect;TGPRect;TGPUnit) : TGPGraphicsContainer|BeginContainer]] method of a Graphics object,
an information block that holds the state of the Graphics
object is put on a stack. The [[Method function IGDIPlus.IGPGraphics.BeginContainer(TGPRect;TGPRect;TGPUnit) : TGPGraphicsContainer|BeginContainer]] method returns a
value that identifies that information block. When you pass
the identifying value to the EndContainer method, the
information block is removed from the stack and is used to
restore the Graphics object to the state it was in at the
time of the [[Method function IGDIPlus.IGPGraphics.BeginContainer(TGPRect;TGPRect;TGPUnit) : TGPGraphicsContainer|BeginContainer]] call.

Containers can be nested; that is, you can call the
[[Method function IGDIPlus.IGPGraphics.BeginContainer(TGPRect;TGPRect;TGPUnit) : TGPGraphicsContainer|BeginContainer]] method several times before you call the
EndContainer method. Each time you call the [[Method function IGDIPlus.IGPGraphics.BeginContainer(TGPRect;TGPRect;TGPUnit) : TGPGraphicsContainer|BeginContainer]]
method, an information block is put on the stack, and you
receive an identifier for the information block. When you
pass one of those identifiers to the EndContainer method, the
Graphics object is returned to the state it was in at the
time of the [[Method function IGDIPlus.IGPGraphics.BeginContainer(TGPRect;TGPRect;TGPUnit) : TGPGraphicsContainer|BeginContainer]] call that returned that particular
identifier. The information block placed on the stack by that
[[Method function IGDIPlus.IGPGraphics.BeginContainer(TGPRect;TGPRect;TGPUnit) : TGPGraphicsContainer|BeginContainer]] call is removed from the stack, and all
information blocks placed on that stack after that
[[Method function IGDIPlus.IGPGraphics.BeginContainer(TGPRect;TGPRect;TGPUnit) : TGPGraphicsContainer|BeginContainer]] call are also removed.

Calls to the [[Method function IGDIPlus.IGPGraphics.Save() : TGPGraphicsState|Save]] method place information blocks on the same
stack as calls to the [[Method function IGDIPlus.IGPGraphics.BeginContainer(TGPRect;TGPRect;TGPUnit) : TGPGraphicsContainer|BeginContainer]] method. Just as an
EndContainer call is paired with a [[Method function IGDIPlus.IGPGraphics.BeginContainer(TGPRect;TGPRect;TGPUnit) : TGPGraphicsContainer|BeginContainer]] call, a
[[Method function IGDIPlus.IGPGraphics.Restore(TGPGraphicsState) : TGPGraphics|Restore]] call is paired with a [[Method function IGDIPlus.IGPGraphics.Save() : TGPGraphicsState|Save]] call.

Caution When you call EndContainer, all information blocks
placed on the stack (by [[Method function IGDIPlus.IGPGraphics.Save() : TGPGraphicsState|Save]] or by [[Method function IGDIPlus.IGPGraphics.BeginContainer(TGPRect;TGPRect;TGPUnit) : TGPGraphicsContainer|BeginContainer]]) after the
corresponding call to [[Method function IGDIPlus.IGPGraphics.BeginContainer(TGPRect;TGPRect;TGPUnit) : TGPGraphicsContainer|BeginContainer]] are removed from the
stack. Likewise, when you call [[Method function IGDIPlus.IGPGraphics.Restore(TGPGraphicsState) : TGPGraphics|Restore]], all information
blocks placed on the stack (by [[Method function IGDIPlus.IGPGraphics.Save() : TGPGraphicsState|Save]] or by [[Method function IGDIPlus.IGPGraphics.BeginContainer(TGPRect;TGPRect;TGPUnit) : TGPGraphicsContainer|BeginContainer]])
after the corresponding call to [[Method function IGDIPlus.IGPGraphics.Save() : TGPGraphicsState|Save]] are removed from the
stack.

Method function IGDIPlus.IGPGraphics.EndContainer(TGPGraphicsContainer) : TGPGraphics - Revision history

David Alm: Automated Syncronization with Documentation