CIP C++ documentation for class "uifcDrawingArea"

Class uifcDrawingArea

# include <uifcDrawingArea.h> class uifcDrawingArea : public virtual uifcComponent { xaideclare(uifcDrawingArea) ... };

Description

Method Summary


`void`	`AddActionListener (uifcDrawingAreaListener_ptr listener)`


`xbool`	`CanRedraw ()`


`void`	`Clear ()`


`void`	`CopyRectangle (uifcRectangle_ptr rect, uifcPoint_ptr point)`


`void`	`CreateTimer (uifcDrawingAreaTimer_ptr timer, xrstring timerName, xbool writeInTrail)`


`void`	`DeleteChild (xrstring name)`


`void`	`DeletePopupMenu ()`


`xbool`	`DoesAllowKeyboardInput ()`


`xbool`	`DoesAllowWheelInput ()`


`xbool`	`DoesClipChildren ()`


`xbool`	`DoesTrackMouse ()`


`void`	`DrawArc (uifcArc_ptr arc)`


`void`	`DrawArcArray (uifcArcs_ptr arcs)`


`void`	`DrawEllipse (uifcRectangle_ptr rect)`


`void`	`DrawEllipseArray (uifcRectangles_ptr rects)`


`void`	`DrawImage (xrstring image, uifcPoint_ptr position, uifcImageFlags flags)`


`void`	`DrawImages (xstringsequence_ptr images, uifcRectangles_ptr rects, uifcRectangles_ptr content_rects, uifcImageFlags flags)`


`void`	`DrawLine (uifcPoint_ptr start_point, uifcPoint_ptr end_point)`


`void`	`DrawLineArray (uifcPoints_ptr start_points, uifcPoints_ptr end_points)`


`void`	`DrawMultipleImages (xstringsequence_ptr images, uifcPoints_ptr points, uifcImageFlags flags)`


`void`	`DrawPoint (uifcPoint_ptr point)`


`void`	`DrawPointArray (uifcPoints_ptr points)`


`void`	`DrawPolygon (uifcPoints_ptr points)`


`void`	`DrawPolyline (uifcPoints_ptr points)`


`void`	`DrawRectangle (uifcRectangle_ptr rect)`


`void`	`DrawRectangleArray (uifcRectangles_ptr rects)`


`void`	`DrawText (xrstring str, uifcPoint_ptr position)`


`void`	`DrawTextArray (xstringsequence_ptr strings, uifcPoints_ptr points)`


`void`	`FillArc (uifcArc_ptr arc)`


`void`	`FillArcArray (uifcArcs_ptr arcs)`


`void`	`FillEllipse (uifcRectangle_ptr rect)`


`void`	`FillEllipseArray (uifcRectangles_ptr rects)`


`void`	`FillGradientRectangle (uifcRectangle_ptr rect, uifcOrientation orientation, uifcColor_ptr color1, uifcColor_ptr color2)`


`void`	`FillPolygon (uifcPoints_ptr points)`


`void`	`FillRectangle (uifcRectangle_ptr rect)`


`void`	`FillRectangleArray (uifcRectangles_ptr rects)`


`uifcArcDirection`	`GetArcDirection ()`


`uifcArcFillMode`	`GetArcFillMode ()`


`uifcPoint_ptr`	`GetCursorPosition ()`


`xstring`	`GetDragCursorImage ()`


`xstring`	`GetDragItemName ()`


`xstring`	`GetDragNotValidCursorImage ()`


`uifcColor_ptr`	`GetDrawingBackgroundColor ()`


`uifcColor_ptr`	`GetDrawingColor ()`


`xstringsequence_ptr`	`GetDrawingImageArray ()`


`uifcDrawingMode`	`GetDrawingMode ()`


`uifcFontClass`	`GetFontClass ()`


`xstring`	`GetFontName ()`


`xreal`	`GetFontSize ()`


`uifcFontStyle`	`GetFontStyle ()`


`uifcDimension_ptr`	`GetFrameMinimumSize ()`


`uifcPoint_ptr`	`GetFrameOrigin ()`


`uifcRectangle_ptr`	`GetFrameRectangle ()`


`uifcDimension_ptr`	`GetFrameSize ()`


`xint`	`GetHeight ()`


`xstring`	`GetHelpText ()`


`uifcDimension_ptr`	`GetImageSize (xrstring image)`


`uifcKey_ptr`	`GetKeyPressed ()`


`uifcLineStyle`	`GetLineStyle ()`


`xint`	`GetLineWidth ()`


`xint`	`GetMinimumHeight ()`


`xint`	`GetMinimumWidth ()`


`xstring`	`GetMostRecentItemName ()`


`uifcPolygonFillMode`	`GetPolygonFillMode ()`


`uifcRectangle_ptr`	`GetRectangleOfMonitor ()`


`uifcPoint_ptr`	`GetScreenOrigin ()`


`uifcRectangle_ptr`	`GetScreenRectangle ()`


`xint`	`GetTextBaseline (xrstring str)`


`uifcRichText`	`GetTextFormat ()`


`uifcDimension_ptr`	`GetTextSize (xrstring str)`


`xint`	`GetWidth ()`


`xbool`	`HasBorder ()`


`xint`	`InsertChild (uifcComponent_ptr component)`


`xint`	`InsertPopupMenu (uifcComponent_ptr component)`


`xbool`	`IsDoubleBuffered ()`


`xbool`	`IsEnabled ()`


`xbool`	`IsValidDragSite ()`


`void`	`PushAction (uifcDrawingAreaAction action)`


`void`	`SetAllowKeyboardInput (xbool flag)`


`void`	`SetAllowWheelInput (xbool flag)`


`void`	`SetArcDirection (uifcArcDirection value)`


`void`	`SetArcFillMode (uifcArcFillMode value)`


`void`	`SetCanRedraw (xbool flag)`


`void`	`SetClipChildren (xbool flag)`


`void`	`SetDoubleBuffered (xbool flag)`


`void`	`SetDragCursorImage (xrstring value)`


`void`	`SetDragItemName (xrstring value)`


`void`	`SetDragNotValidCursorImage (xrstring value)`


`void`	`SetDrawingBackgroundColor (uifcColor_ptr color)`


`void`	`SetDrawingColor (uifcColor_ptr color)`


`void`	`SetDrawingImageArray (xstringsequence_ptr values)`


`void`	`SetDrawingMode (uifcDrawingMode value)`


`void`	`SetEnabled (xbool flag)`


`void`	`SetFontClass (uifcFontClass value)`


`void`	`SetFontName (xrstring value)`


`void`	`SetFontSize (xreal value)`


`void`	`SetFontStyle (uifcFontStyle value)`


`void`	`SetFrameOrigin (uifcPoint_ptr value)`


`void`	`SetFrameRectangle (uifcRectangle_ptr rect)`


`void`	`SetFrameSize (uifcDimension_ptr value)`


`void`	`SetHasBorder (xbool flag)`


`void`	`SetHeight (xint value)`


`void`	`SetHelpText (xrstring value)`


`void`	`SetKeyPressed (uifcKey_ptr key)`


`void`	`SetLineStyle (uifcLineStyle value)`


`void`	`SetLineWidth (xint value)`


`void`	`SetMinimumHeight (xint value)`


`void`	`SetMinimumWidth (xint value)`


`void`	`SetPolygonFillMode (uifcPolygonFillMode value)`


`void`	`SetTextFormat (uifcRichText value)`


`void`	`SetTrackMouse (xbool flag)`


`void`	`SetValidDragSite (xbool flag)`


`void`	`SetWidth (xint value)`


`void`	`StartTimer (xrstring timerName, xint duration)`


`void`	`StopTimer (xrstring timerName)`

Methods Inherited from Class uifcComponent:: GetDialog, GetComponent, CreateInParent, AddPopupMenu, IsVisible, SetVisible, GetComponentClass, GetComponentClassName, IsAlwaysAtFront, SetAlwaysAtFront, GetBackgroundColor, SetBackgroundColor, IsAttachedAtBottom, SetAttachedAtBottom, GetBottomOffset, SetBottomOffset, GetCursorImage, SetCursorImage, GetTextColor, SetTextColor, GetHelpTextAlignment, SetHelpTextAlignment, GetHelpTextWidth, SetHelpTextWidth, GetHelpTextOriginX, SetHelpTextOriginX, GetHelpTextOriginY, SetHelpTextOriginY, CanInheritPopupMenu, SetCanInheritPopupMenu, IsAttachedAtLeft, SetAttachedAtLeft, GetLeftOffset, SetLeftOffset, DoesReserveSpace, SetReserveSpace, GetParentName, GetPopupMenuName, SetPopupMenuName, CanPopupMenuWhenDisabled, SetCanPopupMenuWhenDisabled, IsAttachedAtRight, SetAttachedAtRight, GetRightOffset, SetRightOffset, IsAttachedAtTop, SetAttachedAtTop, GetTopOffset, SetTopOffset, IsValidDropSite, SetValidDropSite, GetValidDropTypeFlags, SetValidDropTypeFlags, GetChildNameArray, DoesAllowTrailRecording, SetAllowTrailRecording, CanReduceHeight, SetCanReduceHeight, CanReduceWidth, SetCanReduceWidth

Method Detail

void FillArc (uifcArc_ptr arc)

Draw the filled arc specified by the given uifcArc structure.

Parameters:

arc

Returns:

void DrawEllipse (uifcRectangle_ptr rect)

Draw the outline of the ellipse bounded by the given rectangle.

Parameters:

rect

Returns:

uifcPoint_ptr GetFrameOrigin ()

Determine the position of the component, in pixels, relative to its parent.

Returns:

void FillGradientRectangle (uifcRectangle_ptr rect, uifcOrientation orientation, uifcColor_ptr color1, uifcColor_ptr color2)

Draw the filled given rectangle as a gradient from color1 to color2 in the given orientation.

Parameters:

rect
orientation
color1
color2

Returns:

void CopyRectangle (uifcRectangle_ptr rect, uifcPoint_ptr point)

Copy the contents of the given rectangle to the given point.

Parameters:

rect
point

Returns:

void DrawPoint (uifcPoint_ptr point)

Draw the given point.

Parameters:

point

Returns:

void FillRectangleArray (uifcRectangles_ptr rects)

Draw the filled given rectangles.

Parameters:

rects

Returns:

void DrawLineArray (uifcPoints_ptr start_points, uifcPoints_ptr end_points)

Draw the given lines.

Parameters:

start_points
end_points

Returns:

void DrawArcArray (uifcArcs_ptr arcs)

Draw the arcs specified by the given uifcArc structures. Each arc is drawn as a section of an ellipse.

Parameters:

arcs

Returns:

void DrawArc (uifcArc_ptr arc)

Draw the arc specified by the given uifcArc structure. The arc is drawn as a section of an ellipse.

Parameters:

arc

Returns:

xint InsertPopupMenu (uifcComponent_ptr component)

Add a MenuPane to be displayed when the user presses the right mouse button over the component.

Parameters:

component

Returns:

void DrawRectangleArray (uifcRectangles_ptr rects)

Draw the outlines of the given rectangles.

Parameters:

rects

Returns:

void DrawPointArray (uifcPoints_ptr points)

Draw the given points.

Parameters:

points

Returns:

xint InsertChild (uifcComponent_ptr component)

Parameters:

component

Returns:

void FillArcArray (uifcArcs_ptr arcs)

Draw the filled arcs specified by the given uifcArc structures.

Parameters:

arcs

Returns:

xint GetTextBaseline (xrstring str)

Get the position in pixels of the baseline of the given text string.

Parameters:

str

Returns:

void DeleteChild (xrstring name)

Delete a component from the parent.

Parameters:

name

Returns:

uifcDimension_ptr GetFrameSize ()

Determine the size of the component, in pixels.

Returns:

uifcDimension_ptr GetTextSize (xrstring str)

Get the size in pixels of the given text string.

Parameters:

str

Returns:

uifcPoint_ptr GetCursorPosition ()

Get the cursor pointer position relative to the component.

Returns:

void DeletePopupMenu ()

Delete a MenuPane from the component.

Returns:

void DrawImage (xrstring image, uifcPoint_ptr position, uifcImageFlags flags)

Draw the given image at the given position according to the given flags. IMAGE_DISABLED - the image is to be drawn to reflect a greyed-out state IMAGE_SELECTED - the image is to be drawn to reflect a selected state

Parameters:

image
position
flags

Returns:

void DrawPolygon (uifcPoints_ptr points)

Draw a polygon from the given polygonal lines, joining the first and last points.

Parameters:

points

Returns:

uifcPoint_ptr GetScreenOrigin ()

Determine the screen position of the component, in pixels.

Returns:

void DrawImages (xstringsequence_ptr images, uifcRectangles_ptr rects, uifcRectangles_ptr content_rects, uifcImageFlags flags)

Draw the given images into the given rectangles, stretching as necessary, using content_rect to define sizing margins to control the stretching, according to the given flags. IMAGE_DISABLED - The image is to be drawn to reflect a greyed-out state IMAGE_SELECTED - The image is to be drawn to reflect a selected state

Parameters:

images
rects
content_rects
flags

Returns:

void DrawText (xrstring str, uifcPoint_ptr position)

Draw the given text string at the given position.

Parameters:

str
position

Returns:

void FillPolygon (uifcPoints_ptr points)

Draw the filled polygon from the given polygonal lines.

Parameters:

points

Returns:

void SetFrameSize (uifcDimension_ptr value)

Set the size of the component, in pixels. This operation is only supported when the component's parent is one of the following classes : DrawingArea NakedWindow PGLWindow

Parameters:

value

Returns:

uifcDimension_ptr GetImageSize (xrstring image)

Get the size in pixels of the given image.

Parameters:

image

Returns:

void FillEllipseArray (uifcRectangles_ptr rects)

Draw the filled ellipses bounded by the given rectangles.

Parameters:

rects

Returns:

void DrawMultipleImages (xstringsequence_ptr images, uifcPoints_ptr points, uifcImageFlags flags)

Draw the given images at the given positions according to the given flags. IMAGE_DISABLED - the images are to be drawn to reflect a greyed-out state IMAGE_SELECTED - the images are to be drawn to reflect a selected state

Parameters:

images
points
flags

Returns:

uifcRectangle_ptr GetFrameRectangle ()

Determine the size and position of the component, in pixels.

Returns:

void DrawTextArray (xstringsequence_ptr strings, uifcPoints_ptr points)

Draw the given text strings at the given positions.

Parameters:

strings
points

Returns:

void DrawEllipseArray (uifcRectangles_ptr rects)

Draw the outlines of the ellipses bounded by the given rectangles.

Parameters:

rects

Returns:

void FillRectangle (uifcRectangle_ptr rect)

Draw the filled given rectangle.

Parameters:

rect

Returns:

void SetFrameOrigin (uifcPoint_ptr value)

Set the screen position of the component, in pixels, relative to its parent. This operation is only supported when the component's parent is one of the following classes : DrawingArea NakedWindow PGLWindow

Parameters:

value

Returns:

void DrawPolyline (uifcPoints_ptr points)

Draw the given polygonal lines.

Parameters:

points

Returns:

uifcDimension_ptr GetFrameMinimumSize ()

Determine the minimum size of the component, in pixels.

Returns:

void DrawLine (uifcPoint_ptr start_point, uifcPoint_ptr end_point)

Draw the given line.

Parameters:

start_point
end_point

Returns:

uifcRectangle_ptr GetScreenRectangle ()

Determine the size and screen position of the component, in pixels.

Returns:

void DrawRectangle (uifcRectangle_ptr rect)

Draw the outline of the given rectangle.

Parameters:

rect

Returns:

void SetFrameRectangle (uifcRectangle_ptr rect)

Set the size and screen position of the component, in pixels. This operation is only supported when the component's parent is one of the following classes : DrawingArea NakedWindow PGLWindow

Parameters:

rect

Returns:

void FillEllipse (uifcRectangle_ptr rect)

Draw the filled ellipse bounded by the given rectangle.

Parameters:

rect

Returns:

void Clear ()

Clear the contents of the DrawingArea.

Returns:

uifcRectangle_ptr GetRectangleOfMonitor ()

Determine the rectangle of the screen upon which the majority of the given component is displayed.

Returns:

xbool DoesTrackMouse ()

Returns:: Flag indicating whether the DrawingArea generates a OnMouseMove() whenever the pointer is moved over the visible region of the component.

void SetTrackMouse (xbool flag)

Sets flag indicating whether the DrawingArea generates a OnMouseMove() whenever the pointer is moved over the visible region of the component.

Parameters:

flag

Returns:

xint GetLineWidth ()

Returns:: The current line drawing width of the DrawingArea in pixels.

void SetLineWidth (xint value)

Sets the current line drawing width of the DrawingArea in pixels.

Parameters:

value

Returns:

xint GetMinimumWidth ()

Returns:: The minimim width in pixels of the DrawingArea.

void SetMinimumWidth (xint value)

Sets the minimim width in pixels of the DrawingArea.

Parameters:

value

Returns:

xstring GetDragItemName ()

Returns:: The name of the item being dragged when the user starts a drag & drop operation by dragging within the component.
This is set by the application, usually in response to a OnLeftMouseDown() callback. DragBoundingRectangle attribute may also be modified to specify the bounding rectangle outside of which the pointer must be dragged in order for a drag operation to begin.

void SetDragItemName (xrstring value)

Sets the name of the item being dragged when the user starts a drag & drop operation by dragging within the component.
This is set by the application, usually in response to a OnLeftMouseDown() callback. DragBoundingRectangle attribute may also be modified to specify the bounding rectangle outside of which the pointer must be dragged in order for a drag operation to begin.

Parameters:

value

Returns:

xstring GetDragCursorImage ()

Returns:: The cursor to use when the user starts a drag & drop operation by dragging the component and the pointer is over a valid drop-site.

void SetDragCursorImage (xrstring value)

Sets the cursor to use when the user starts a drag & drop operation by dragging the component and the pointer is over a valid drop-site.

Parameters:

value

Returns:

xbool DoesAllowWheelInput ()

Returns:

The response of the component to mouse wheel input.

void SetAllowWheelInput (xbool flag)

Sets the response of the component to mouse wheel input.

Parameters:

flag

Returns:

xbool IsDoubleBuffered ()

Returns:: Flag indicating whether the DrawingArea is double-buffered.

void SetDoubleBuffered (xbool flag)

Sets flag indicating whether the DrawingArea is double-buffered.

Parameters:

flag

Returns:

uifcKey_ptr GetKeyPressed ()

Returns:: The key pressed which generated a OnKeyDown(). To indicate to the DrawingArea that the key should not be passed on to, for example, the mapkey buffer you should modify this attribute to KEY_NONE at the end of your OnKeyDown() callback.

void SetKeyPressed (uifcKey_ptr key)

Sets the key pressed which generated a OnKeyDown(). To indicate to the DrawingArea that the key should not be passed on to, for example, the mapkey buffer you should modify this attribute to KEY_NONE at the end of your OnKeyDown() callback.

Parameters:

key

Returns:

uifcArcFillMode GetArcFillMode ()

Returns:

The fill mode to be used when drawing Arcs in the DrawingArea.

ARC_FILL_MODE_PIE	Fill the arc bounded by two line segments joining the endpoints of the arc and its center point
ARC_FILL_MODE_CHORD	Fill the arc bounded by a single line segment that joins the two endpoints of the arc

void SetArcFillMode (uifcArcFillMode value)

Sets the fill mode to be used when drawing Arcs in the DrawingArea.

ARC_FILL_MODE_PIE	Fill the arc bounded by two line segments joining the endpoints of the arc and its center point
ARC_FILL_MODE_CHORD	Fill the arc bounded by a single line segment that joins the two endpoints of the arc

Parameters:

value

Returns:

uifcArcDirection GetArcDirection ()

Returns:

The direction to use when drawing Arcs in the DrawingArea.

ARC_DIRECTION_CLOCKWISE	Draw in a Clockwise direction between the two line segments in order to form the arc
ARC_DIRECTION_COUNTERCLOCKWISE	Draw in a Counterclockwise direction between the two line segments in order to form the arc

void SetArcDirection (uifcArcDirection value)

Sets the direction to use when drawing Arcs in the DrawingArea.

ARC_DIRECTION_CLOCKWISE	Draw in a Clockwise direction between the two line segments in order to form the arc
ARC_DIRECTION_COUNTERCLOCKWISE	Draw in a Counterclockwise direction between the two line segments in order to form the arc

Parameters:

value

Returns:

uifcRichText GetTextFormat ()

Returns:

The format of the display text of the component.

RICHTEXT_OFF	Plain text
RICHTEXT_ON	A very restricted subset of HTML
RICHTEXT_ON + <HTML>	HTML as supported by the HTMLWindow

The UI RichText format supports the following styles, controlled by their corresponding tokens:

Style	Switch on	Switch off
Bold	\b	\b0
Italic	\i	\i0
Underlined	\ul	\ulnone
~~Strike-through~~	\strike	\strike0
^Superscript	\super	\nosupersub
_Subscript	\sub	\nosupersub
Foreground Color	\cfRRGGBB	\cf0
Background Color	\cbRRGGBB	\cb0
Picture	\pictNAME	n/a

N.B. Each token must be followed immediately by another token or a whitespace character (e.g. space, newline).
The very restricted subset of HTML supports the following styles, controlled by their corresponding tokens:

Style	Switch on	Switch off
Bold	<b>	</b>
Italic	<i>	</i>
Underlined	<u>	</u>
~~Strike-through~~	<strike>	</strike>
^Superscript	<sup>	</sup>
_Subscript	<sub>	</sub>
Foreground Color	<font color=#RRGGBB>	</font>
Background Color	<span style="background:#RRGGBB">	</span>
Picture	<img src="NAME">	n/a

void SetTextFormat (uifcRichText value)

Sets the format of the display text of the component.

RICHTEXT_OFF	Plain text
RICHTEXT_ON	A very restricted subset of HTML
RICHTEXT_ON + <HTML>	HTML as supported by the HTMLWindow

The UI RichText format supports the following styles, controlled by their corresponding tokens:

Style	Switch on	Switch off
Bold	\b	\b0
Italic	\i	\i0
Underlined	\ul	\ulnone
~~Strike-through~~	\strike	\strike0
^Superscript	\super	\nosupersub
_Subscript	\sub	\nosupersub
Foreground Color	\cfRRGGBB	\cf0
Background Color	\cbRRGGBB	\cb0
Picture	\pictNAME	n/a

Style	Switch on	Switch off
Bold	<b>	</b>
Italic	<i>	</i>
Underlined	<u>	</u>
~~Strike-through~~	<strike>	</strike>
^Superscript	<sup>	</sup>
_Subscript	<sub>	</sub>
Foreground Color	<font color=#RRGGBB>	</font>
Background Color	<span style="background:#RRGGBB">	</span>
Picture	<img src="NAME">	n/a

Parameters:

value

Returns:

xstring GetDragNotValidCursorImage ()

Returns:: The cursor to use when the user starts a drag & drop operation by dragging the component and the pointer is over an invalid drop-site.

void SetDragNotValidCursorImage (xrstring value)

Sets the cursor to use when the user starts a drag & drop operation by dragging the component and the pointer is over an invalid drop-site.

Parameters:

value

Returns:

xbool DoesAllowKeyboardInput ()

Returns:: Flag indicating whether the component is capable of receiving keyboard input (xtrue), and hence is capable of receiving the keyboard input focus, or whether it responds only to mouse input (xfalse).

void SetAllowKeyboardInput (xbool flag)

Sets flag indicating whether the component is capable of receiving keyboard input (xtrue), and hence is capable of receiving the keyboard input focus, or whether it responds only to mouse input (xfalse).

Parameters:

flag

Returns:

xstring GetFontName ()

Returns:: The name of the font used to draw text in the component. This may also contain a comma-separated list of font names, in which case the closest match (or the first exact match, if available) will be used.

void SetFontName (xrstring value)

Sets the name of the font used to draw text in the component. This may also contain a comma-separated list of font names, in which case the closest match (or the first exact match, if available) will be used.

Parameters:

value

Returns:

xstringsequence_ptr GetDrawingImageArray ()

Returns:: The names of the images which will be drawn in the DrawingArea.
Each image may be a BIF (the .bif extension is optional) file or a JPG, PNG, PCX, GIF, BMP, ICO or CUR file.

void SetDrawingImageArray (xstringsequence_ptr values)

Sets the names of the images which will be drawn in the DrawingArea.
Each image may be a BIF (the .bif extension is optional) file or a JPG, PNG, PCX, GIF, BMP, ICO or CUR file.

Parameters:

values

Returns:

uifcFontClass GetFontClass ()

Returns:

The base font class to be used to draw text in the component.

FONT_CLASS_DEFAULT	The default font
FONT_CLASS_DESKTOP	The font used by the Window Manager for the text of desktop icons
FONT_CLASS_MENU	The font used by MenuBars and components within MenuPanes
FONT_CLASS_POPUPHELP	The font used by the popup helptext
FONT_CLASS_MESSAGE	The font used for messages in the UI Message Dialog
FONT_CLASS_TITLEBAR	The font used to draw the titlebar text of a Dialog
FONT_CLASS_FIXED	A system-specific fixed width font for the locale

void SetFontClass (uifcFontClass value)

Sets the base font class to be used to draw text in the component.

FONT_CLASS_DEFAULT	The default font
FONT_CLASS_DESKTOP	The font used by the Window Manager for the text of desktop icons
FONT_CLASS_MENU	The font used by MenuBars and components within MenuPanes
FONT_CLASS_POPUPHELP	The font used by the popup helptext
FONT_CLASS_MESSAGE	The font used for messages in the UI Message Dialog
FONT_CLASS_TITLEBAR	The font used to draw the titlebar text of a Dialog
FONT_CLASS_FIXED	A system-specific fixed width font for the locale

Parameters:

value

Returns:

uifcPolygonFillMode GetPolygonFillMode ()

Returns:

The fill mode to be used when drawing Polygons in the DrawingArea.

POLYGON_FILL_MODE_WINDING	Fills area between odd-numbered and even-numbered polygon sides on each scan line
POLYGON_FILL_MODE_ALTERNATE	Fills any region with a nonzero winding value

void SetPolygonFillMode (uifcPolygonFillMode value)

Sets the fill mode to be used when drawing Polygons in the DrawingArea.

POLYGON_FILL_MODE_WINDING	Fills area between odd-numbered and even-numbered polygon sides on each scan line
POLYGON_FILL_MODE_ALTERNATE	Fills any region with a nonzero winding value

Parameters:

value

Returns:

xbool IsValidDragSite ()

Returns:: Flag indicating whether the component can be dragged to start a drag & drop operation.

void SetValidDragSite (xbool flag)

Sets flag indicating whether the component can be dragged to start a drag & drop operation.

Parameters:

flag

Returns:

xint GetWidth ()

Returns:: The width in pixels of the DrawingArea.

void SetWidth (xint value)

Sets the width in pixels of the DrawingArea.

Parameters:

value

Returns:

xbool DoesClipChildren ()

Returns:: Flag indicating whether drawing operations within the DrawingArea are clipped so that they do not overlap any children contained within the DrawingArea.

void SetClipChildren (xbool flag)

Sets flag indicating whether drawing operations within the DrawingArea are clipped so that they do not overlap any children contained within the DrawingArea.

Parameters:

flag

Returns:

uifcDrawingMode GetDrawingMode ()

Returns:

The drawing mode of the DrawingArea.

DRAWING_MODE_COPY	Draw using the foreground drawing color
DRAWING_MODE_NOT	Draw, inverting the existing pixels of the component
DRAWING_MODE_AND	Draw using a combination of the foreground drawing color AND the existing pixels
DRAWING_MODE_OR	Draw using a combination of the foreground drawing color OR the existing pixels
DRAWING_MODE_XOR	Draw using a combination of the foreground drawing color XOR the existing pixels
DRAWING_MODE_COPY	Draw using the foreground drawing color

void SetDrawingMode (uifcDrawingMode value)

Sets the drawing mode of the DrawingArea.

DRAWING_MODE_COPY	Draw using the foreground drawing color
DRAWING_MODE_NOT	Draw, inverting the existing pixels of the component
DRAWING_MODE_AND	Draw using a combination of the foreground drawing color AND the existing pixels
DRAWING_MODE_OR	Draw using a combination of the foreground drawing color OR the existing pixels
DRAWING_MODE_XOR	Draw using a combination of the foreground drawing color XOR the existing pixels
DRAWING_MODE_COPY	Draw using the foreground drawing color

Parameters:

value

Returns:

xint GetMinimumHeight ()

Returns:: The minimum height in pixels of the DrawingArea.

void SetMinimumHeight (xint value)

Sets the minimum height in pixels of the DrawingArea.

Parameters:

value

Returns:

xreal GetFontSize ()

Returns:: The point-size of the font used to draw text in the component.

void SetFontSize (xreal value)

Sets the point-size of the font used to draw text in the component.

Parameters:

value

Returns:

xbool CanRedraw ()

Returns:: Flag indicating whether redraws are permitted in the DrawingArea.

void SetCanRedraw (xbool flag)

Sets flag indicating whether redraws are permitted in the DrawingArea.

Parameters:

flag

Returns:

xbool IsEnabled ()

Returns:: Flag indicating whether the component is disabled (xfalse) or sensitive to user input (xtrue).

void SetEnabled (xbool flag)

Sets flag indicating whether the component is disabled (xfalse) or sensitive to user input (xtrue).

Parameters:

flag

Returns:

xstring GetHelpText ()

Returns:: The popup help-text to be displayed whilst the pointer is over the component.
If the value begins with <HTML> then the help-text is treated as HTML, and rendered accordingly. It is often wise to use HTML help-text in conjunction with HelpTextWidth attribute, to define the maximum width of the popup help-text window.

void SetHelpText (xrstring value)

Sets the popup help-text to be displayed whilst the pointer is over the component.
If the value begins with <HTML> then the help-text is treated as HTML, and rendered accordingly. It is often wise to use HTML help-text in conjunction with HelpTextWidth attribute, to define the maximum width of the popup help-text window.

Parameters:

value

Returns:

uifcColor_ptr GetDrawingColor ()

Returns:: The foreground drawing color of the component as a uifcColor.

void SetDrawingColor (uifcColor_ptr color)

Sets the foreground drawing color of the component as a uifcColor.

Parameters:

color

Returns:

xstring GetMostRecentItemName ()

Returns:: The item which was beneath the pointer the last time the pointer was over the component.

uifcColor_ptr GetDrawingBackgroundColor ()

Returns:: The background drawing color of the component as a uifcColor.

void SetDrawingBackgroundColor (uifcColor_ptr color)

Sets the background drawing color of the component as a uifcColor.

Parameters:

color

Returns:

uifcFontStyle GetFontStyle ()

Returns:

A bitwise OR of the styles of the font used to draw text in the component.

FONT_STYLE_REGULAR	The font is regularly spaced, slanted and weighted
FONT_STYLE_CONDENSED	The font is condensed
FONT_STYLE_ITALIC	The font is italicised
FONT_STYLE_BOLD	The font is emboldened

void SetFontStyle (uifcFontStyle value)

Sets a bitwise OR of the styles of the font used to draw text in the component.

FONT_STYLE_REGULAR	The font is regularly spaced, slanted and weighted
FONT_STYLE_CONDENSED	The font is condensed
FONT_STYLE_ITALIC	The font is italicised
FONT_STYLE_BOLD	The font is emboldened

Parameters:

value

Returns:

xint GetHeight ()

Returns:: The height in pixels of the DrawingArea.

void SetHeight (xint value)

Sets the height in pixels of the DrawingArea.

Parameters:

value

Returns:

xbool HasBorder ()

Returns:: Flag indicating whether the DrawingArea has a decorated shadow border.

void SetHasBorder (xbool flag)

Sets flag indicating whether the DrawingArea has a decorated shadow border.

Parameters:

flag

Returns:

uifcLineStyle GetLineStyle ()

Returns:

The current line drawing style of the DrawingArea.

LINE_STYLE_SOLID	Draw solid lines in the foreground drawing color
LINE_STYLE_DOTTED	Draw dotted lines in the foreground and background drawing colors
LINE_STYLE_DASHED	Draw dashed lines in the foreground and background drawing colors

void SetLineStyle (uifcLineStyle value)

Sets the current line drawing style of the DrawingArea.

LINE_STYLE_SOLID	Draw solid lines in the foreground drawing color
LINE_STYLE_DOTTED	Draw dotted lines in the foreground and background drawing colors
LINE_STYLE_DASHED	Draw dashed lines in the foreground and background drawing colors

Parameters:

value

Returns:

void AddActionListener (uifcDrawingAreaListener_ptr listener)

Parameters:

listener

Returns:

void PushAction (uifcDrawingAreaAction action)

Parameters:

action

Returns:

void CreateTimer (uifcDrawingAreaTimer_ptr timer, xrstring timerName, xbool writeInTrail)

Parameters:

timer
timerName
writeInTrail

Returns:

void StartTimer (xrstring timerName, xint duration)

Parameters:

timerName
duration

Returns:

void StopTimer (xrstring timerName)

Parameters:

timerName

Returns: