Interface XVolatileBitmap

Devguide

+ + + + + + + +

Attributes' Summary

Attributes' Details

+ + + + + + + + + + + + +

interface XVolatileBitmap

Base Hierarchy

XBitmap
+ |
+ +-XVolatileBitmap

+ + + + + + + + +

Methods' Summary
isValid	Query whether this volatile bitmap still has valid content. As + the video RAM allocated to this bitmap can be reclaimed at any + time, a return value of true here does not imply that the next + draw operation with this bitmap will succeed. Instead, the + exception VolatileContentDestroyed will be thrown. +

boolean
+isValid();

Description: Query whether this volatile bitmap still has valid content. As + the video RAM allocated to this bitmap can be reclaimed at any + time, a return value of true here does not imply that the next + draw operation with this bitmap will succeed. Instead, the + exception VolatileContentDestroyed will be thrown. +

+ + +

+ +

+ Apache "OpenOffice.org" is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. + Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and + decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is + not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has + yet to be fully endorsed by the ASF.

+ Contact Us | + Terms of Use +
Apache and the Apache feather logos are trademarks of The Apache Software Foundation. +
OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. +
Other names appearing on the site may be trademarks of their respective owners. +

+ + + Added: websites/staging/ooo-site/trunk/content/gsl/canvas/api/index-files/module-ix.html ============================================================================== --- websites/staging/ooo-site/trunk/content/gsl/canvas/api/index-files/module-ix.html (added) +++ websites/staging/ooo-site/trunk/content/gsl/canvas/api/index-files/module-ix.html Fri Nov 25 20:10:27 2011 @@ -0,0 +1,270 @@ + + + + + + +Module + + + + + + + + + +

+ +

+ + + + + + + + + + + + +

Module

Use

Devguide

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + +

Nested Modules

Services

Singletons

Exceptions

Typedefs

+ + + + + + + + + +

Global Module

Structs
AnimationAttributes
BezierPoint2D
EllipticalArc
FloatingPointBitmapLayout
IntegerBitmapLayout
Point2D
Rectangle2D
RenderState
Size2D
StringContext	Collection of string-related arguments used on all text + interfaces. A possibly much larger string than later rendered is + necessary here, because in several languages, glyph selection is + context dependent. +
StrokeAttributes
Texture
ViewState

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Enums
AnimationRepeat	These constants determine how the [0,1] parameter range of the + animation is driven through. +
CompositeOp
FillRule
PathCapType
PathJoinType
RenderingIntent
TextDirection
TextureMode

Constant Groups
RepaintResult

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/gsl/canvas/api/module-ix.html ============================================================================== --- websites/staging/ooo-site/trunk/content/gsl/canvas/api/module-ix.html (added) +++ websites/staging/ooo-site/trunk/content/gsl/canvas/api/module-ix.html Fri Nov 25 20:10:27 2011 @@ -0,0 +1,106 @@ + + + + + + +Module star + + + + + + + + +

+ +

+ + + +

+ + + + + + + + + + +

Module

Use

Devguide

+ + + + + + + + + + + + +

Nested Modules

Services

Singletons

Interfaces

Structs

Exceptions

Enums

Typedefs

Constant Groups

+ + + + + + + + + +

:: com :: sun ::

module star

+ + + + + + + + + + +

Nested Modules
geometry
rendering

+ +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/AnimationAttributes-xref.html ============================================================================== --- websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/AnimationAttributes-xref.html (added) +++ websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/AnimationAttributes-xref.html Fri Nov 25 20:10:27 2011 @@ -0,0 +1,104 @@ + + + + + + +Uses of Struct AnimationAttributes-xref + + + + + + + + +

+ +

+ + + +

+ + + + + + + + + + +

Use

Devguide

+ + + + + + + +

uses of struct AnimationAttributes

back to struct AnimationAttributes
+
+ +Derived Structs
+ +Synonym Typedefs
+ +Uses as Return Type
+ +Uses as Parameter
+ +Uses as Data Type
+ +References in Developers Guide
+ +

XAnimation::getAnimationAttributes()
+

Uses as Return Type

+ + + + + + + + + + + + + + + + +

+ +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/AnimationAttributes.html ============================================================================== --- websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/AnimationAttributes.html (added) +++ websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/AnimationAttributes.html Fri Nov 25 20:10:27 2011 @@ -0,0 +1,185 @@ + + + + + + +Struct AnimationAttributes + + + + + + + + +

+ +

+ + + +

+ + + + + + + + + + +

Devguide

+ + + + + +

+ + + + + + + + + + + + +

:: com :: sun :: star :: rendering ::

+ + + + +

unpublished

struct AnimationAttributes

Description: This structure contains attributes needed to run an animation. + +
Since: OOo 2.0.0

Elements' Summary
Duration	Preferred duration of the animation sequence in seconds.
RepeatMode	Repeat mode of the animation sequence.
UntransformedSize	Size of the untrasnformed animation sequence.

+ + + + + + + + + + + + + +

Elements' Details

Duration + + + + +

double Duration; + + Description + Preferred duration of the animation sequence in seconds. + +

RepeatMode + + + + +

byte RepeatMode; + + Description + Repeat mode of the animation sequence. + + +This value determines how the [0,1] parameter space of the animation +should be sweeped through. Permissible values are given in +AnimationRepeat . + + + See also + AnimationRepeat. + +

UntransformedSize + + + + +

::com::sun::star::geometry::RealSize2D UntransformedSize; + + Description + Size of the untrasnformed animation sequence. + + +This value specifies the size of the animation when rendered +with the identity view transform. This permits +e.g. XSprite implementations to cache rendered +animation content in finite-sized bitmaps. + + +

+ +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/AnimationRepeat.html ============================================================================== --- websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/AnimationRepeat.html (added) +++ websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/AnimationRepeat.html Fri Nov 25 20:10:27 2011 @@ -0,0 +1,215 @@ + + + + + + +Constants' Group AnimationRepeat + + + + + + + + +

+ +

+ + + +

+ + + + + + + + + + +

Use

Devguide

+ + + + + + + + + + + + + + + + + + + + +

+ + + + + +

Constants

Constants' Details

+ + + + + + + + + + +

:: com :: sun :: star :: rendering ::

+ + + + +

unpublished

constants group AnimationRepeat

Description

This are the possible repeat modes for animations.

+ +These constants determine how the [0,1] parameter range of the +animation is driven through, thus defining the possible repeat +modes.

+ +

Since

OOo 2.0.0

Constants
ONE_SHOT	The [0,1] parameter range is sweeped through exactly once.
ONE_SHOT_PINGPONG	The [0,1] parameter range is sweeped through exactly twice.
PINGPONG	The [0,1] parameter range is sweeped through infinitely.
REPEAT	The [0,1] parameter range is sweeped through infinitely.

+ + + + + + + + + + + + + + + + +

Constants' Details

ONE_SHOT + + + + +

const byte ONE_SHOT =0; + + Description + The [0,1] parameter range is sweeped through exactly once. + + +The [0,1] parameter range is sweeped through exactly once, +starting with 0 and ending with 1. + + +

ONE_SHOT_PINGPONG + + + + +

const byte ONE_SHOT_PINGPONG =1; + + Description + The [0,1] parameter range is sweeped through exactly twice. + + +The [0,1] parameter range is sweeped through exactly twice, +starting with 0, going to 1, and going back to 0. When +plotting the value over time, this yields a triangle curve. + + +

PINGPONG + + + + +

const byte PINGPONG =2; + + Description + The [0,1] parameter range is sweeped through infinitely. + + +The [0,1] parameter range is sweeped through infinitely, +starting with 0, going to 1, and going back to 0, and then +starting again. When plotting the value over time, this yields +a repeated triangle curve. + + +

REPEAT + + + + +

const byte REPEAT =3; + + Description + The [0,1] parameter range is sweeped through infinitely. + + +The [0,1] parameter range is sweeped through infinitely, +starting with 0, going to 1, and starting with 0 again. When +plotting the value over time, this yields a repeated saw-tooth +curve. + + +

+ +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/BitmapCanvas-xref.html ============================================================================== --- websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/BitmapCanvas-xref.html (added) +++ websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/BitmapCanvas-xref.html Fri Nov 25 20:10:27 2011 @@ -0,0 +1,89 @@ + + + + + + +Uses of Service BitmapCanvas-xref + + + + + + + + +

+ +

+ + + +

+ + + + + + + + + + +

Use

Devguide

+ + + + + + + +

uses of service BitmapCanvas

back to service BitmapCanvas
+
+ +Services which Include this Service
+ +Singletons which Instantiate this Service
+ +References in Developers Guide
+ +

+ + + + + + + + + + + + +

+ +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/BitmapCanvas.html ============================================================================== --- websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/BitmapCanvas.html (added) +++ websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/BitmapCanvas.html Fri Nov 25 20:10:27 2011 @@ -0,0 +1,125 @@ + + + + + + +Service BitmapCanvas + + + + + + + + +

+ +

+ + + +

+ + + + + + + + + + +

Devguide

+ + + + + + + +

Included Services

Exported Interfaces

Properties' Summary

Properties' Details

+ + + + + + + + + + +

:: com :: sun :: star :: rendering ::

+ + + + +

unpublished

service BitmapCanvas

Description: This service provides the interfaces for a BitmapCanvas +

Exported Interfaces
XBitmapCanvas	+ Description + Canvas interface, to issue rendering operations. + + +
XBitmap	+ Description + Bitmap interface, to directly manipulate the pixel. + + +

+
Top of Page

+ +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/Canvas-xref.html ============================================================================== --- websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/Canvas-xref.html (added) +++ websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/Canvas-xref.html Fri Nov 25 20:10:27 2011 @@ -0,0 +1,106 @@ + + + + + + +Uses of Service Canvas-xref + + + + + + + +

+ +

+ + + + + + + + + + + + +

Use

Devguide

+ + + + + + + +

uses of service Canvas

back to service Canvas
+
+ +Services which Include this Service
+ +Singletons which Instantiate this Service
+ +References in Developers Guide
+ +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/Canvas.html ============================================================================== --- websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/Canvas.html (added) +++ websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/Canvas.html Fri Nov 25 20:10:27 2011 @@ -0,0 +1,96 @@ + + + + + + +Service Canvas + + + + + + + + +

+ +

+ + + +

+ + + + + + + + + + +

Use

Devguide

+ + + + + +

Constructors' Summary

Constructors' Details

+ + + + + + + + + + + + +

:: com :: sun :: star :: rendering ::

service Canvas

Supported Interface: XCanvas

+
Top of Page

+ +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/CanvasFactory.html ============================================================================== --- websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/CanvasFactory.html (added) +++ websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/CanvasFactory.html Fri Nov 25 20:10:27 2011 @@ -0,0 +1,126 @@ + + + + + + +Service CanvasFactory + + + + + + + + +

+ +

+ + + +

+ + + + + + + + + + +

Use

Devguide

+ + + + + +

Constructors' Summary

Constructors' Details

+ + + + + + + + + + + + + +

:: com :: sun :: star :: rendering ::

+ + + + +

unpublished

service CanvasFactory

Supported Interface: ::com::sun::star::lang::XMultiComponentFactory

Description: The CanvasFactory is used to create the Canvas +objects, evaluating the user's configuration preferences from + +/org.openoffice.VCL/Settings/Canvas/PreferredServices . + +The latter specifies a string list of service names to use. + +; +Instantiating this service, you can use its +com::sun::star::lang::XMultiComponentFactory +interface to create Canvas objects, passing an empty string +as service specifier (default). +If you want to manually override the configured service list, you can pass +a service name to try first. +
+ +
Since: OOo 2.0.0

+
Top of Page

+ +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/Caret-xref.html ============================================================================== --- websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/Caret-xref.html (added) +++ websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/Caret-xref.html Fri Nov 25 20:10:27 2011 @@ -0,0 +1,104 @@ + + + + + + +Uses of Struct Caret-xref + + + + + + + + +

+ +

+ + + +

+ + + + + + + + + + +

Use

Devguide

+ + + + + + + +

uses of struct Caret

back to struct Caret
+
+ +Derived Structs
+ +Synonym Typedefs
+ +Uses as Return Type
+ +Uses as Parameter
+ +Uses as Data Type
+ +References in Developers Guide
+ +

XTextLayout::getCaret()
+

Uses as Return Type

+ + + + + + + + + + + + + + + + +

+ +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/Caret.html ============================================================================== --- websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/Caret.html (added) +++ websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/Caret.html Fri Nov 25 20:10:27 2011 @@ -0,0 +1,193 @@ + + + + + + +Struct Caret + + + + + + + + +

+ +

+ + + +

+ + + + + + + + + + +

Devguide

+ + + + + +

+ + + + + + + + + + + + +

:: com :: sun :: star :: rendering ::

+ + + + +

unpublished

struct Caret

Description

This structure contains the caret information.

+ +This structure is used from the XTextLayout interface +to transport information regarding a text caret.

+ +

Since

OOo 2.0.0

Elements' Summary
MainCaretIndex	This contains the main caret index.
SecondaryCaretIndex	This contains the secondary caret index.
CaretAngle	The angle of the caret.

+ + + + + + + + + + + + + +

Elements' Details

MainCaretIndex + + + + +

long MainCaretIndex; + + Description + This contains the main caret index. + + +The main caret index corresponds to the insert position when +inserting text in the layout's main text direction. + + +

SecondaryCaretIndex + + + + +

long SecondaryCaretIndex; + + Description + This contains the secondary caret index. + + +The secondary caret index, when different from the main caret +index, corresponds to the insert position when inserting text +at a direction change opposite to the layout's main text +direction. + + +

CaretAngle + + + + +

double CaretAngle; + + Description + The angle of the caret. + + +This member contains the rotation angle of the caret in +degrees, with 0 denoting an unrotated caret (the unrotated +caret orientation depends on the writing mode, horizontally or +vertically). The rotation angle is positive for +counter-clockwise rotations. + + +

+ +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/ColorComponent-xref.html ============================================================================== --- websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/ColorComponent-xref.html (added) +++ websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/ColorComponent-xref.html Fri Nov 25 20:10:27 2011 @@ -0,0 +1,93 @@ + + + + + + +Uses of Typedef ColorComponent-xref + + + + + + + + +

+ +

+ + + +

+ + + + + + + + + + +

Use

Devguide

+ + + + + + + +

uses of typedef ColorComponent

back to typedef ColorComponent
+
+ +Synonym Typedefs
+ +Uses as Return Type
+ +Uses as Parameter
+ +Uses as Data Type
+ +References in Developers Guide
+ +

+ +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/ColorComponent.html ============================================================================== --- websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/ColorComponent.html (added) +++ websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/ColorComponent.html Fri Nov 25 20:10:27 2011 @@ -0,0 +1,101 @@ + + + + + + +Typedef ColorComponent + + + + + + + + +

+ +

+ + + +

+ + + + + + + + + + +

Devguide

+ + + + + + + + + + + + + +

:: com :: sun :: star :: rendering ::

+ + + + +

unpublished

typedef ColorComponent

Defining Type: double

Description: Shorthand for the device-dependent color components, and easier to read

+ +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/ColorProfile-xref.html ============================================================================== --- websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/ColorProfile-xref.html (added) +++ websites/staging/ooo-site/trunk/content/gsl/canvas/api/rendering/ColorProfile-xref.html Fri Nov 25 20:10:27 2011 @@ -0,0 +1,104 @@ + + + + + + +Uses of Struct ColorProfile-xref + + + + + + + + +

+ +

+ + + +

+ + + + + + + + + + +

Use

Devguide

+ + + + + + + +

uses of struct ColorProfile

back to struct ColorProfile
+
+ +Derived Structs
+ +Synonym Typedefs
+ +Uses as Return Type
+ +Uses as Parameter
+ +Uses as Data Type
+ +References in Developers Guide
+ +

XColorSpace::getICCProfile()
+

Uses as Return Type