English:

The Free and Open Productivity Suite
New: Apache OpenOffice 4.1.0 released!

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star ::

module drawing
Description
Drawing and shape specific interfaces.

Nested Modules
framework The drawing framework is responsible for managing the resources used by the UI of the drawing applications.
Services
AccessibleDrawDocumentView The AccessibleDrawDocumentView service is implemented by views of Draw and Impress documents.
AccessibleGraphControl The service describes the accessible graph controls that are used in the image map of the Draw and Impress applications and the contour dialog of the Writer application.
AccessibleGraphicShape The AccessibleGraphicShape service is implemented by the graphic object shapes shapes com.sun.star.drawing.GraphicObjectShape and com.sun.star.presentation.GraphicObjectShape.
AccessibleImageBullet The accessible view of an image bullet.
AccessibleOLEShape The AccessibleOLEShape service is implemented by OLE shapes.
AccessibleShape The AccessibleShape service is implemented by UNO shapes to provide accessibility information that describe the shapes' features. A UNO shape is any object that implements the XShape interface.
AccessibleSlideView The AccessibleSlideView service is implemented by slide views of Impress documents.
AccessibleSlideViewObject The AccessibleSlideViewObject service is implemented by the slides of the slide view of Impress documents.
AppletShape This Shape encapsulates an applet.
Background this service provides the properties to describe a background filling for a drawing page. It can be obtained by the ::com::sun::star::lang::XMultiServiceFactory of a document and be set on draw pages that support a filled background.
BitmapTable this is a container for URLs to bitmaps.
CaptionShape The CaptionShape represents a rectangular drawing shape with an additional set of lines. It can be used as a description for a fixed point inside a drawing.
ClosedBezierShape This service is for a closed bezier shape.
ConnectorProperties This is a set of properties to describe the style for rendering connector.
ConnectorShape This service is for a ConnectorShape, a specialized Shape, which can be connected to other Shapes or GluePoints.
ControlShape This service is for a Shape which contains a control.
CustomShape This service is for a CustomShape
CustomShapeEngine This service is for a CustomShape
DashTable this is a container for LineDashs
Defaults This is a set of properties to access the defaults of a drawing document
DocumentSettings describes properties that apply to the whole drawing document.
DrawPage This service specifies a page for the actual draw pages to contain the drawings.
DrawPages provides access to a container of DrawPages and makes it possible for you to manipulate them.
DrawingDocument specifies a document which consists of multiple pages with drawings.
DrawingDocumentDrawView This componend integrates a view to a DrawPages or MasterPage from a DrawingDocument.
DrawingDocumentFactory [ DEPRECATED ]
EllipseShape This service is for an ellipse or circle shape.
EnhancedCustomShapeExtrusion This service may be represented by a ::com::sun::star::beans::PropertyValue [].
EnhancedCustomShapeGeometry This service may be represented by a ::com::sun::star::beans::PropertyValue [].
EnhancedCustomShapeHandle This service may be represented by a ::com::sun::star::beans::PropertyValue [].
EnhancedCustomShapePath This service may be represented by a ::com::sun::star::beans::PropertyValue [].
EnhancedCustomShapeTextPath This service may be represented by a ::com::sun::star::beans::PropertyValue [].
FillProperties This is a set of properties to describe the style for rendering an area.
GenericDrawPage This abstract service is implemented by every page of a DrawingDocument.
GenericDrawingDocument specifies a document which consists of multiple pages with drawings.
GradientTable this is a container for ::com::sun::star::awt::Gradients
GraphicExportFilter a component that supports this service lets you export pages, shapes, or groups of shapes from a DrawingDocument to a file in one of the file formats supported by the component.
GraphicObjectShape This service is for a graphic shape.
GroupShape This service is for a group of Shapes.
HatchTable this is a container for Hatchs
Layer A layer is an entity inside a document which contains shapes.
LayerManager This service is provided by documents to support Layers.
LineProperties This is a set of properties to describe the style for rendering a Line.
LineShape This service is for a simple Shape with lines.
MarkerTable this is a container for PointSequences
MasterPage This service is a single master page inside a drawing document.
MasterPages provides access to a container of MasterPages and makes it possible for them to be manipulated.
MeasureProperties This service describes a MeasureShape.
MeasureShape This service is for a dimensioning shape.
OLE2Shape This service is for an ole shape.
OpenBezierShape This service is for an open bezier shape.
PageShape This service is for a page shape. A page shape displays a preview of another page. These shapes are used inside notes pages to preview the corresponding drawing page. Theyre also used in the handout page to preview the printing position and order of pages
PluginShape This Shape encapsulates a plugin.
PolyLineShape This service is for a polyline shape.
PolyPolygonBezierDescriptor This service describes a polypolygonbezier.
PolyPolygonBezierShape This service specifies a polypolygon bezier shape.
PolyPolygonDescriptor This service describes a polypolygon.
PolyPolygonShape This service is for a polygon shape.
RectangleShape This service is for a rectangle Shape.
RotationDescriptor [ DEPRECATED ]
This abstract service specifies the general characteristics of an optional rotation and shearing for a Shape. This service is depricated, instead please use the Transformation property of the service Shape.
ShadowProperties This is a set of properties to describe the style for rendering a shadow.
Shape This abstract service specifies the general characteristics of all Shapes.
ShapeCollection This service describes a generic container to manage collections of Shape. The Shape that are added to this collection are not owned by the collection. This service is used by the view f.e. to return a collection of Shape that are selected at the ui.
Shapes This service is for a generic collection of shapes.
SlideRenderer Create preview bitmaps for single slides.
SlideSorter A slide sorter shows previews for a set of slides, typically all slides in a document, and allows the selection, reordering, creation, and deletion of slides.
Text This abstract service specifies the general characteristics of an optional text inside a Shape.
TextProperties This is a set of properties to describe the style for rendering the text area inside a shape.
TextShape This service is for a text shape.
TransparencyGradientTable this is a container for ::com::sun::star::awt::Gradients
Interfaces
XConnectableShape [ DEPRECATED ]
XConnectorShape [ DEPRECATED ]
XControlShape is implemented by a ControlShape to access the controls model.
XCustomShapeEngine The XCustomShapeEngine
XCustomShapeHandle The XCustomShapeHandle
XDrawPage identifies an XShapes as a DrawPage.
XDrawPageDuplicator makes it possible to duplicate pages within the same document.
XDrawPageExpander [ DEPRECATED ]
is implemented by documents that can expand the contents of a summary on a DrawPage into a collection of DrawPages.
XDrawPageSummarizer [ DEPRECATED ]
is implemented by documents that can create summaries of their DrawPages.
XDrawPageSupplier [ DEPRECATED ]
represents something that provides a DrawPage.
XDrawPages gives access to a container of DrawPages or MasterPages.
XDrawPagesSupplier must be supported to provide access to a multi-page drawing-layer.
XDrawSubController View dependent part of the Draw and Impress controller.
XDrawView is implemented by views that display DrawPages or MasterPages.
XEnhancedCustomShapeDefaulter
XGluePointsSupplier must be supported to provide access to a container of GluePoint2.
XLayer identifies the object as a Layer.
XLayerManager This interface makes it possible to access and manage the Layers of a document.
XLayerSupplier gives access to a LayerManager.
XMasterPageTarget is implemented by objects that can be linked to a MasterPage.
XMasterPagesSupplier must be supported to provide access to the MasterPages of a multi-page drawing-layer.
XPresenterHelper This interface is a collection of functions that are necessary to implement larger parts of the presenter screen as extension. The methods of this interface give access to services that can, at the moment, only implemented in the Office core, not in an extension.
XSelectionFunction
XShape lets you do a basic transformation on a Shape and get its type.
XShapeAligner [ DEPRECATED ]
Objects implementing this interface can be used to align Shapes.
XShapeArranger [ DEPRECATED ]
Objects implementing this interface can be used to arrange Shapes.
XShapeBinder connects or breaks the lines of Shapes
XShapeCombiner specifies the combine/split functionality.
XShapeDescriptor [ DEPRECATED ]
offers some settings which are allowed even for objects which are not yet inserted into a draw page.
XShapeGroup [ DEPRECATED ]
is implemented by Shapes that contain other Shapes.
XShapeGrouper specifies the group/ungroup functionality.
XShapeMirror [ DEPRECATED ]
Objects implementing this interface can be used to mirror Shapes.
XShapes makes it possible to access, add, and remove the Shapes in a collection.
XSlidePreviewCache A cache of preview bitmaps for the slides of one Impress or Draw document in one size. There may be more than one cache for one document. These are internally connected and for missing previews one cache may take it from another cache and scale it to the desired size. When a preview is not present then it is created asynchronously. On creation all registered listeners are notified. Slides are referenced via their index in an XIndexAccess container in order to allow multiple references to a single slide (custom presentations).
XSlidePreviewCacheListener Listener for asynchronous preview creations. Called when a slide preview has been created that was previously requested via a call to XSlidePreviewCache::getSlidePreview(). The implementor may then call getSlidePreview() a second time to get the up-to-date version of the preview.
XSlideRenderer Create preview bitmaps for single slides.
XSlideSorterBase This interface exists only because services do not directly support multiple inheritance and attributes.
XUniversalShapeDescriptor [ DEPRECATED ]
Structs
BezierPoint [ DEPRECATED ]
This is a point on a bezier curve.
BoundVolume specifies a three-dimensional boundary volume with two positions.
CameraGeometry specifies a three-dimensional camera.
Direction3D specifies a 3-dimensional vector.
EnhancedCustomShapeAdjustmentValue specifies a single AdjustmentValue
EnhancedCustomShapeParameter specifies a single value which is used with EnhancedCustomShapes
EnhancedCustomShapeParameterPair specifies the coordinates used with EnhancedCustomShapes
EnhancedCustomShapeSegment
EnhancedCustomShapeTextFrame specifies the coordinates used with EnhancedCustomShapes
GluePoint [ DEPRECATED ]
A GluePoint could be attached to a shape or to a page.
GluePoint2 This struct defines the attributes of a glue point.
Hatch This struct defines the appearence of a hatch.
HomogenMatrix specifies a homogenous matrix by three homogenous lines
HomogenMatrix3 specifies a homogenous matrix by three homogenous lines
HomogenMatrix4 specifies a homogenous matrix by four homogenous lines.
HomogenMatrixLine specifies a single line for a HomogenMatrix.
HomogenMatrixLine3 specifies a single line for a HomogenMatrix3.
HomogenMatrixLine4 specifies a single line for a HomogenMatrix4.
LineDash A LineDash defines a non-continuous line.
PolyPolygonBezierCoords specifies the coordinates for a poly polygon bezier.
PolyPolygonShape3D specifies the coordinates of a 3-dimensional poly polygon.
Position3D specifies a 3-dimensional point.
Exceptions
GraphicFilterRequest represents a general error graphic filter exception. It can be used to transport the error code information. E.g. that can be usefull for interactions.
Enums
Alignment The Alignment enumeration is a general way to specify the alignment of an object or sub-object relative to another object.
Arrangement [ DEPRECATED ]
With this enumeration you can arrange the relative position of an object within the other objects.
BitmapMode The BitmapMode selects an algorithm for filling an area with a bitmap.
CircleKind This enumeration defines a circle.
ColorMode The ColorMode defines the output style of colors for a graphic.
ConnectionType the direction where the connection line leaves the connection point.
ConnectorType The ConnectorType specifies the appearance of a connector.
DashStyle This enumeration defines the style of a dash on a line.
DrawViewMode [ DEPRECATED ]
This enumeration specifies the viewmode of a view in a presentation document.
EnhancedCustomShapeTextPathMode
EscapeDirection This enumeration defines the escape direction a connector takes on a glue point.
FillStyle specifies how an area will be filled.
HatchStyle The HatchStyle defines the style of the lines in a hatch.
HorizontalDimensioning The HorizontalDimensioning specifies the horizontal position of the text of a dimensioning shape.
LayerType This enumeration specifies the type of a drawing layer.
LineCap The LineCap defines rendering of ends of thick lines
LineEndType [ DEPRECATED ]
The LineEndType specifies the appearance of the bullet at the end of a line.
LineJoint The LineJoint defines rendering of joints between thick lines
LineStyle specifies the appearance of the lines of a shape.
MeasureKind [ DEPRECATED ]
determines whether a measured shape is a standard measure or a radius measure.
MeasureTextHorzPos This enumeration defines the relative horizontal placement of the text inside a measure shape.
MeasureTextVertPos This enumeration defines the relative vertical placement of the text inside a measure shape.
MirrorAxis defines an axis for simple mirroring.
NormalsKind specifies in which way the standard normals for an object are produced.
PolygonFlags defines how a bezier curve goes through a point.
PolygonKind This enumeration defines the type of polygon.
ProjectionMode defines whether the 3D objects are to be drawn in perspective or parallel projection.
RectanglePoint specifies one of nine points in a rectangle.
ShadeMode The ShadeMode determines the quality of displaying the object.
SnapObjectType [ DEPRECATED ]
TextAdjust [ DEPRECATED ]
This enumeration specifies the position of a text inside a shape in relation to the shape.
TextAnimationDirection This enumeration defines the movement direction of a scrolltext.
TextAnimationKind This enumeration specifies the type of animation for a text.
TextFitToSizeType This enumeration specifies how the text within a shape relates to the size of the shape.
TextHorizontalAdjust This enumeration specifies the horizontal position of text inside a shape in relation to the shape.
TextVerticalAdjust This enumeration specifies the vertical position of text inside a shape in relation to the shape.
TextureKind [ DEPRECATED ]
These enumeration values specify how the texture is applied.
TextureKind2 These enumeration values specify how the texture is applied.
TextureMode The TextureMode defines in which way the texture color data replaces the object color data.
TextureProjectionMode defines how the texture is mapped to the object.
VerticalDimensioning specifies the vertical position of the text of a dimensioning shape.
Typedefs
CoordinateSequence
CoordinateSequenceSequence
DoubleSequence
DoubleSequenceSequence
FlagSequence
FlagSequenceSequence
PointSequence
PointSequenceSequence
Constant Groups
CanvasFeature
CaptionEscapeDirection this flags describe escape direction for the line of a CaptionShape.
CaptionType This constants specifies the geometry of the line of a CaptionShape.
EnhancedCustomShapeGluePointType defines which gluepoints are being offered by the EnhancedCustomShape
EnhancedCustomShapeParameterType defines how a EnhancedCustomShapeParameter has to be interpreted
EnhancedCustomShapeSegmentCommand
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Website Feedback | Contact Us | Donate | Thanks

Apache, the Apache feather logo, and OpenOffice 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.