LibreOffice Module oox (master) 1
Public Member Functions | Public Attributes | List of all members
oox::vml::ShapeTypeModel Struct Reference

The shape model structure contains all properties shared by all types of shapes. More...

#include <vmlshape.hxx>

Collaboration diagram for oox::vml::ShapeTypeModel:
[legend]

Public Member Functions

 ShapeTypeModel ()
 
void assignUsed (const ShapeTypeModel &rSource)
 

Public Attributes

OUString maShapeId
 Unique identifier of the shape. More...
 
OUString maLegacyId
 Plaintext identifier of the shape. More...
 
OUString maShapeName
 Name of the shape, if present. More...
 
std::optional< sal_Int32 > moShapeType
 Builtin shape type identifier. More...
 
std::optional< Int32PairmoCoordPos
 Top-left position of coordinate system for children scaling. More...
 
std::optional< Int32PairmoCoordSize
 Size of coordinate system for children scaling. More...
 
OUString maPosition
 Position type of the shape. More...
 
OUString maZIndex
 ZIndex of the shape. More...
 
OUString maLeft
 X position of the shape bounding box (number with unit). More...
 
OUString maTop
 Y position of the shape bounding box (number with unit). More...
 
OUString maWidth
 Width of the shape bounding box (number with unit). More...
 
OUString maHeight
 Height of the shape bounding box (number with unit). More...
 
OUString maMarginLeft
 X position of the shape bounding box to shape anchor (number with unit). More...
 
OUString maMarginTop
 Y position of the shape bounding box to shape anchor (number with unit). More...
 
OUString maPositionHorizontalRelative
 The X position is relative to this. More...
 
OUString maPositionVerticalRelative
 The Y position is relative to this. More...
 
OUString maPositionHorizontal
 The X position orientation (default: absolute). More...
 
OUString maPositionVertical
 The Y position orientation. More...
 
OUString maWidthPercent
 The width in percents of the WidthRelative. More...
 
OUString maHeightPercent
 The height in percents of the HeightRelative. More...
 
OUString maWidthRelative
 To what the width is relative. More...
 
OUString maHeightRelative
 To what the height is relative. More...
 
OUString maRotation
 Rotation of the shape, in degrees. More...
 
OUString maFlip
 Flip type of the shape (can be "x" or "y"). More...
 
bool mbAutoHeight
 If true, the height value is a minimum value (mostly used for textboxes) More...
 
bool mbVisible
 Visible or Hidden. More...
 
OUString maWrapStyle
 Wrapping mode for text. More...
 
OUString maArcsize
 round rectangles arc size More...
 
OUString maEditAs
 Edit As type (e.g. "canvas" etc) More...
 
OUString maAdjustments
 Shape adjustment values. More...
 
StrokeModel maStrokeModel
 Border line formatting. More...
 
FillModel maFillModel
 Shape fill formatting. More...
 
ShadowModel maShadowModel
 Shape shadow formatting. More...
 
TextpathModel maTextpathModel
 Shape textpath formatting. More...
 
std::optional< OUString > moGraphicPath
 Path to a graphic for this shape. More...
 
std::optional< OUString > moGraphicTitle
 Title of the graphic. More...
 
std::optional< OUString > moWrapAnchorX
 The base object from which our horizontal positioning should be calculated. More...
 
std::optional< OUString > moWrapAnchorY
 The base object from which our vertical positioning should be calculated. More...
 
std::optional< OUString > moWrapType
 How to wrap the text around the object. More...
 
std::optional< OUString > moWrapSide
 On which side to wrap the text around the object. More...
 
OUString maVTextAnchor
 How the text inside the shape is anchored vertically. More...
 
OUString maWrapDistanceLeft
 Distance from the left side of the shape to the text that wraps around it. More...
 
OUString maWrapDistanceRight
 Distance from the right side of the shape to the text that wraps around it. More...
 
OUString maWrapDistanceTop
 Distance from the top of the shape to the text that wraps around it. More...
 
OUString maWrapDistanceBottom
 Distance from the bottom of the shape to the text that wraps around it. More...
 
std::optional< OUString > moCropBottom
 Specifies the how much to crop the image from the bottom up as a fraction of picture size. More...
 
std::optional< OUString > moCropLeft
 Specifies how much to crop the image from the left in as a fraction of picture size. More...
 
std::optional< OUString > moCropRight
 Specifies how much to crop the image from the right in as a fraction of picture size. More...
 
std::optional< OUString > moCropTop
 Specifies how much to crop the image from the top down as a fraction of picture size. More...
 
OUString maLayoutFlowAlt
 Specifies the alternate layout flow for text in textboxes. More...
 
sal_Int32 mnGain = 0x10000
 An adjustment for the intensity of all colors, i.e. contrast, on a 0..0x10000 scale. More...
 
sal_Int16 mnBlacklevel = 0
 The image brightness, on a 0..0x10000 scale. More...
 

Detailed Description

The shape model structure contains all properties shared by all types of shapes.

Definition at line 60 of file vmlshape.hxx.

Constructor & Destructor Documentation

◆ ShapeTypeModel()

oox::vml::ShapeTypeModel::ShapeTypeModel ( )
explicit

Definition at line 132 of file vmlshape.cxx.

References mbVisible.

Member Function Documentation

◆ assignUsed()

void oox::vml::ShapeTypeModel::assignUsed ( const ShapeTypeModel rSource)

Member Data Documentation

◆ maAdjustments

OUString oox::vml::ShapeTypeModel::maAdjustments

Shape adjustment values.

Definition at line 92 of file vmlshape.hxx.

Referenced by oox::vml::SimpleShape::implConvertAndInsert(), and oox::vml::ShapeTypeContext::ShapeTypeContext().

◆ maArcsize

OUString oox::vml::ShapeTypeModel::maArcsize

round rectangles arc size

Definition at line 90 of file vmlshape.hxx.

Referenced by oox::vml::RectangleShape::implConvertAndInsert(), and oox::vml::ShapeTypeContext::ShapeTypeContext().

◆ maEditAs

OUString oox::vml::ShapeTypeModel::maEditAs

Edit As type (e.g. "canvas" etc)

Definition at line 91 of file vmlshape.hxx.

Referenced by oox::vml::GroupShape::implConvertAndInsert(), and oox::vml::ShapeTypeContext::ShapeTypeContext().

◆ maFillModel

FillModel oox::vml::ShapeTypeModel::maFillModel

◆ maFlip

OUString oox::vml::ShapeTypeModel::maFlip

Flip type of the shape (can be "x" or "y").

Definition at line 86 of file vmlshape.hxx.

Referenced by oox::vml::SimpleShape::implConvertAndInsert(), and oox::vml::ShapeTypeContext::setStyle().

◆ maHeight

OUString oox::vml::ShapeTypeModel::maHeight

Height of the shape bounding box (number with unit).

Definition at line 74 of file vmlshape.hxx.

Referenced by oox::vml::ShapeType::getAbsRectangle(), oox::vml::ShapeType::getRelRectangle(), oox::vml::ShapeContext::setPoints(), and oox::vml::ShapeTypeContext::setStyle().

◆ maHeightPercent

OUString oox::vml::ShapeTypeModel::maHeightPercent

The height in percents of the HeightRelative.

Definition at line 82 of file vmlshape.hxx.

Referenced by oox::vml::SimpleShape::implConvertAndInsert(), and oox::vml::ShapeTypeContext::setStyle().

◆ maHeightRelative

OUString oox::vml::ShapeTypeModel::maHeightRelative

To what the height is relative.

Definition at line 84 of file vmlshape.hxx.

Referenced by oox::vml::SimpleShape::implConvertAndInsert(), and oox::vml::ShapeTypeContext::setStyle().

◆ maLayoutFlowAlt

OUString oox::vml::ShapeTypeModel::maLayoutFlowAlt

Specifies the alternate layout flow for text in textboxes.

Definition at line 114 of file vmlshape.hxx.

Referenced by oox::vml::SimpleShape::finalImplConvertAndInsert(), oox::vml::SimpleShape::implConvertAndInsert(), and oox::vml::TextBoxContext::TextBoxContext().

◆ maLeft

OUString oox::vml::ShapeTypeModel::maLeft

X position of the shape bounding box (number with unit).

Definition at line 71 of file vmlshape.hxx.

Referenced by oox::vml::ShapeType::getAbsRectangle(), oox::vml::ShapeType::getRelRectangle(), and oox::vml::ShapeTypeContext::setStyle().

◆ maLegacyId

OUString oox::vml::ShapeTypeModel::maLegacyId

Plaintext identifier of the shape.

Definition at line 63 of file vmlshape.hxx.

Referenced by oox::vml::ShapeBase::convertAndInsert(), and oox::vml::ShapeTypeContext::ShapeTypeContext().

◆ maMarginLeft

OUString oox::vml::ShapeTypeModel::maMarginLeft

X position of the shape bounding box to shape anchor (number with unit).

Definition at line 75 of file vmlshape.hxx.

Referenced by oox::vml::SimpleShape::finalImplConvertAndInsert(), oox::vml::ShapeType::getAbsRectangle(), and oox::vml::ShapeTypeContext::setStyle().

◆ maMarginTop

OUString oox::vml::ShapeTypeModel::maMarginTop

Y position of the shape bounding box to shape anchor (number with unit).

Definition at line 76 of file vmlshape.hxx.

Referenced by oox::vml::SimpleShape::finalImplConvertAndInsert(), oox::vml::ShapeType::getAbsRectangle(), oox::vml::lcl_setSurround(), and oox::vml::ShapeTypeContext::setStyle().

◆ maPosition

OUString oox::vml::ShapeTypeModel::maPosition

◆ maPositionHorizontal

OUString oox::vml::ShapeTypeModel::maPositionHorizontal

The X position orientation (default: absolute).

Definition at line 79 of file vmlshape.hxx.

Referenced by oox::vml::lcl_SetAnchorType(), oox::vml::ShapeTypeContext::setStyle(), and oox::vml::ShapeTypeContext::ShapeTypeContext().

◆ maPositionHorizontalRelative

OUString oox::vml::ShapeTypeModel::maPositionHorizontalRelative

The X position is relative to this.

Definition at line 77 of file vmlshape.hxx.

Referenced by oox::vml::lcl_SetAnchorType(), and oox::vml::ShapeTypeContext::setStyle().

◆ maPositionVertical

OUString oox::vml::ShapeTypeModel::maPositionVertical

The Y position orientation.

Definition at line 80 of file vmlshape.hxx.

Referenced by oox::vml::lcl_SetAnchorType(), and oox::vml::ShapeTypeContext::setStyle().

◆ maPositionVerticalRelative

OUString oox::vml::ShapeTypeModel::maPositionVerticalRelative

The Y position is relative to this.

Definition at line 78 of file vmlshape.hxx.

Referenced by oox::vml::lcl_SetAnchorType(), and oox::vml::ShapeTypeContext::setStyle().

◆ maRotation

OUString oox::vml::ShapeTypeModel::maRotation

◆ maShadowModel

ShadowModel oox::vml::ShapeTypeModel::maShadowModel

Shape shadow formatting.

Definition at line 96 of file vmlshape.hxx.

Referenced by oox::vml::ShapeBase::convertShapeProperties(), and oox::vml::ShapeTypeContext::onCreateContext().

◆ maShapeId

OUString oox::vml::ShapeTypeModel::maShapeId

Unique identifier of the shape.

Definition at line 62 of file vmlshape.hxx.

Referenced by oox::vml::ComplexShape::implConvertAndInsert(), and oox::vml::ShapeTypeContext::ShapeTypeContext().

◆ maShapeName

OUString oox::vml::ShapeTypeModel::maShapeName

Name of the shape, if present.

Definition at line 64 of file vmlshape.hxx.

Referenced by oox::vml::ShapeBase::getShapeName(), and oox::vml::ShapeTypeContext::ShapeTypeContext().

◆ maStrokeModel

StrokeModel oox::vml::ShapeTypeModel::maStrokeModel

◆ maTextpathModel

TextpathModel oox::vml::ShapeTypeModel::maTextpathModel

Shape textpath formatting.

Definition at line 97 of file vmlshape.hxx.

Referenced by oox::vml::ShapeBase::convertShapeProperties(), and oox::vml::ShapeTypeContext::onCreateContext().

◆ maTop

OUString oox::vml::ShapeTypeModel::maTop

Y position of the shape bounding box (number with unit).

Definition at line 72 of file vmlshape.hxx.

Referenced by oox::vml::ShapeType::getAbsRectangle(), oox::vml::ShapeType::getRelRectangle(), and oox::vml::ShapeTypeContext::setStyle().

◆ maVTextAnchor

OUString oox::vml::ShapeTypeModel::maVTextAnchor

How the text inside the shape is anchored vertically.

Definition at line 105 of file vmlshape.hxx.

Referenced by oox::vml::SimpleShape::implConvertAndInsert(), and oox::vml::ShapeTypeContext::setStyle().

◆ maWidth

OUString oox::vml::ShapeTypeModel::maWidth

Width of the shape bounding box (number with unit).

Definition at line 73 of file vmlshape.hxx.

Referenced by oox::vml::ShapeType::getAbsRectangle(), oox::vml::ShapeType::getRelRectangle(), oox::vml::ShapeContext::setPoints(), and oox::vml::ShapeTypeContext::setStyle().

◆ maWidthPercent

OUString oox::vml::ShapeTypeModel::maWidthPercent

The width in percents of the WidthRelative.

Definition at line 81 of file vmlshape.hxx.

Referenced by oox::vml::SimpleShape::implConvertAndInsert(), oox::vml::ShapeTypeContext::setStyle(), and oox::vml::ShapeTypeContext::ShapeTypeContext().

◆ maWidthRelative

OUString oox::vml::ShapeTypeModel::maWidthRelative

To what the width is relative.

Definition at line 83 of file vmlshape.hxx.

Referenced by oox::vml::SimpleShape::implConvertAndInsert(), and oox::vml::ShapeTypeContext::setStyle().

◆ maWrapDistanceBottom

OUString oox::vml::ShapeTypeModel::maWrapDistanceBottom

Distance from the bottom of the shape to the text that wraps around it.

Definition at line 109 of file vmlshape.hxx.

Referenced by oox::vml::SimpleShape::createPictureObject(), oox::vml::SimpleShape::implConvertAndInsert(), and oox::vml::ShapeTypeContext::setStyle().

◆ maWrapDistanceLeft

OUString oox::vml::ShapeTypeModel::maWrapDistanceLeft

Distance from the left side of the shape to the text that wraps around it.

Definition at line 106 of file vmlshape.hxx.

Referenced by oox::vml::SimpleShape::createPictureObject(), oox::vml::SimpleShape::implConvertAndInsert(), oox::vml::ShapeTypeContext::setStyle(), and oox::vml::ShapeTypeContext::ShapeTypeContext().

◆ maWrapDistanceRight

OUString oox::vml::ShapeTypeModel::maWrapDistanceRight

Distance from the right side of the shape to the text that wraps around it.

Definition at line 107 of file vmlshape.hxx.

Referenced by oox::vml::SimpleShape::createPictureObject(), oox::vml::SimpleShape::implConvertAndInsert(), oox::vml::ShapeTypeContext::setStyle(), and oox::vml::ShapeTypeContext::ShapeTypeContext().

◆ maWrapDistanceTop

OUString oox::vml::ShapeTypeModel::maWrapDistanceTop

Distance from the top of the shape to the text that wraps around it.

Definition at line 108 of file vmlshape.hxx.

Referenced by oox::vml::SimpleShape::createPictureObject(), oox::vml::SimpleShape::implConvertAndInsert(), and oox::vml::ShapeTypeContext::setStyle().

◆ maWrapStyle

OUString oox::vml::ShapeTypeModel::maWrapStyle

Wrapping mode for text.

Definition at line 89 of file vmlshape.hxx.

Referenced by oox::vml::SimpleShape::implConvertAndInsert(), and oox::vml::ShapeTypeContext::setStyle().

◆ maZIndex

OUString oox::vml::ShapeTypeModel::maZIndex

ZIndex of the shape.

Definition at line 70 of file vmlshape.hxx.

Referenced by oox::vml::ShapeBase::convertAndInsert(), and oox::vml::ShapeTypeContext::setStyle().

◆ mbAutoHeight

bool oox::vml::ShapeTypeModel::mbAutoHeight

If true, the height value is a minimum value (mostly used for textboxes)

Definition at line 87 of file vmlshape.hxx.

Referenced by oox::vml::SimpleShape::implConvertAndInsert(), oox::vml::ShapeTypeContext::setStyle(), and oox::vml::TextBoxContext::TextBoxContext().

◆ mbVisible

bool oox::vml::ShapeTypeModel::mbVisible

Visible or Hidden.

Definition at line 88 of file vmlshape.hxx.

Referenced by oox::vml::ShapeTypeContext::setStyle().

◆ mnBlacklevel

sal_Int16 oox::vml::ShapeTypeModel::mnBlacklevel = 0

The image brightness, on a 0..0x10000 scale.

Definition at line 120 of file vmlshape.hxx.

Referenced by oox::vml::SimpleShape::createPictureObject(), and oox::vml::ShapeTypeContext::onCreateContext().

◆ mnGain

sal_Int32 oox::vml::ShapeTypeModel::mnGain = 0x10000

An adjustment for the intensity of all colors, i.e. contrast, on a 0..0x10000 scale.

Definition at line 117 of file vmlshape.hxx.

Referenced by oox::vml::SimpleShape::createPictureObject(), and oox::vml::ShapeTypeContext::onCreateContext().

◆ moCoordPos

std::optional< Int32Pair > oox::vml::ShapeTypeModel::moCoordPos

Top-left position of coordinate system for children scaling.

Definition at line 67 of file vmlshape.hxx.

Referenced by assignUsed(), oox::vml::ShapeType::getCoordSystem(), and oox::vml::ShapeTypeContext::ShapeTypeContext().

◆ moCoordSize

std::optional< Int32Pair > oox::vml::ShapeTypeModel::moCoordSize

Size of coordinate system for children scaling.

Definition at line 68 of file vmlshape.hxx.

Referenced by assignUsed(), oox::vml::ShapeType::getCoordSystem(), oox::vml::ShapeContext::setPoints(), and oox::vml::ShapeTypeContext::ShapeTypeContext().

◆ moCropBottom

std::optional<OUString> oox::vml::ShapeTypeModel::moCropBottom

Specifies the how much to crop the image from the bottom up as a fraction of picture size.

Definition at line 110 of file vmlshape.hxx.

Referenced by oox::vml::SimpleShape::createPictureObject(), and oox::vml::ShapeTypeContext::onCreateContext().

◆ moCropLeft

std::optional<OUString> oox::vml::ShapeTypeModel::moCropLeft

Specifies how much to crop the image from the left in as a fraction of picture size.

Definition at line 111 of file vmlshape.hxx.

Referenced by oox::vml::SimpleShape::createPictureObject(), and oox::vml::ShapeTypeContext::onCreateContext().

◆ moCropRight

std::optional<OUString> oox::vml::ShapeTypeModel::moCropRight

Specifies how much to crop the image from the right in as a fraction of picture size.

Definition at line 112 of file vmlshape.hxx.

Referenced by oox::vml::SimpleShape::createPictureObject(), and oox::vml::ShapeTypeContext::onCreateContext().

◆ moCropTop

std::optional<OUString> oox::vml::ShapeTypeModel::moCropTop

Specifies how much to crop the image from the top down as a fraction of picture size.

Definition at line 113 of file vmlshape.hxx.

Referenced by oox::vml::SimpleShape::createPictureObject(), and oox::vml::ShapeTypeContext::onCreateContext().

◆ moGraphicPath

std::optional< OUString > oox::vml::ShapeTypeModel::moGraphicPath

◆ moGraphicTitle

std::optional< OUString > oox::vml::ShapeTypeModel::moGraphicTitle

Title of the graphic.

Definition at line 100 of file vmlshape.hxx.

Referenced by assignUsed(), and oox::vml::ShapeTypeContext::onCreateContext().

◆ moShapeType

std::optional< sal_Int32 > oox::vml::ShapeTypeModel::moShapeType

◆ moWrapAnchorX

std::optional< OUString > oox::vml::ShapeTypeModel::moWrapAnchorX

The base object from which our horizontal positioning should be calculated.

Definition at line 101 of file vmlshape.hxx.

Referenced by oox::vml::ShapeTypeContext::onCreateContext().

◆ moWrapAnchorY

std::optional< OUString > oox::vml::ShapeTypeModel::moWrapAnchorY

The base object from which our vertical positioning should be calculated.

Definition at line 102 of file vmlshape.hxx.

Referenced by oox::vml::ShapeTypeContext::onCreateContext().

◆ moWrapSide

std::optional< OUString > oox::vml::ShapeTypeModel::moWrapSide

On which side to wrap the text around the object.

Definition at line 104 of file vmlshape.hxx.

Referenced by oox::vml::lcl_setSurround(), and oox::vml::ShapeTypeContext::onCreateContext().

◆ moWrapType

std::optional< OUString > oox::vml::ShapeTypeModel::moWrapType

How to wrap the text around the object.

Definition at line 103 of file vmlshape.hxx.

Referenced by oox::vml::lcl_setSurround(), oox::vml::ShapeTypeContext::onCreateContext(), and oox::vml::ShapeTypeContext::ShapeTypeContext().


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