Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: drawing :: framework ::

interface XPaneBorderPainter
Description
Paint the border around a rectangular region, typically a pane.

Calling objects have to be able to derive inner bounding boxs of the border from the outer ones and inner ones from outer ones. This conversion and the painting of the border involves three rectangles. The inner and outer bounding box of the border. This is a logical bounding box which the paint methods may paint over. The center box is the third rectangle. This is the actual border between outer and inner background color or bitmap and it is used for placing the bitmaps that are used paint the border. The inner sides and corners are places relative to this center box, i.e. when not further offsets are given then the upper left corner bitmap is painted with its lower right at the upper left of the center box.


Methods' Summary
addBorder Enlarge the given rectangle by the size of the specified part of the border. This method can be used to convert an inner bounding box into the center box or the outer bounding box.  
removeBorder Shring the given rectangle by the size of the specified part of the border. This method can be used to convert an outer bounding box into the center box or the inner bounding box.  
paintBorder Paint the border around a pane.  
paintBorderWithCallout Paint the border around a pane where the border includes a callout that is anchored at the given point. Most arguments have the same meaning as in the paintBorder.  
getCalloutOffset Return the offset of a callout anchor with respect to the outer border. This value is used when the callout is realized by a fixed bitmap in order to determine the size and/or location of the outer border for a given callout.  
Methods' Details
addBorder
::com::sun::star::awt::Rectangle
addBorder( [in] string  sPaneBorderStyleName,
[in] ::com::sun::star::awt::Rectangle  aRectangle,
[in] BorderType  eBorderType );

Description
Enlarge the given rectangle by the size of the specified part of the border. This method can be used to convert an inner bounding box into the center box or the outer bounding box.
Parameter sPaneBorderStyleName
The pane style defines the sizes of the border.
Parameter aRectangle
This rectangle will be converted into a larger one. This should be the center box or the inner bounding box of the border.
Parameter eBorderType
The part of the border to add to the given rectangle. Use INNER_BORDER to convert an inner bounding box into the center box or TOTAL_BORDER to convert it into the outer bounding box. OUTER_BORDER can be used to convert the center box into the outer bounding box.
removeBorder
::com::sun::star::awt::Rectangle
removeBorder( [in] string  sPaneBorderStyleName,
[in] ::com::sun::star::awt::Rectangle  aRectangle,
[in] BorderType  eBorderType );

Description
Shring the given rectangle by the size of the specified part of the border. This method can be used to convert an outer bounding box into the center box or the inner bounding box.
Parameter sPaneBorderStyleName
The pane style defines the sizes of the border.
Parameter aRectangle
This rectangle will be converted into a smaller one that lies inside it. It should be the center box or the outer bounding box of the border.
Parameter eBorderType
The part of the border to remove from the given rectangle. Use OUTER_BORDER to convert an outer bounding box into the center box or TOTAL_BORDER to convert it into the inner bounding box. INNER_BORDER can be used to convert the center box into the inner bounding box.
paintBorder
void
paintBorder( [in] string  sPaneBorderStyleName,
[in] ::com::sun::star::rendering::XCanvas  xCanvas,
[in] ::com::sun::star::awt::Rectangle  aOuterBorderRectangle,
[in] ::com::sun::star::awt::Rectangle  aRepaintArea,
[in] string  sTitle );

Description
Paint the border around a pane.
Parameter sPaneBorderStyleName
The pane style to use for painting the border.
Parameter xCanvas
The canvas onto which the border is painted.
Parameter aOuterBorderRectangle
The outer bounding box of the border. Use addBorder to convert the bounding box of a pane (the inner bounding box of the border) into this outer bounding box of the border.
Parameter aRepaintArea
The area in which the border has to be repainted. The clip rectangle.
Parameter sTitle
The pane title. Supply an empty string for panes without title. It is the responsibility of the caller to supply a title only for pane border styles that support a title.
paintBorderWithCallout
void
paintBorderWithCallout( [in] string  sPaneBorderStyleName,
[in] ::com::sun::star::rendering::XCanvas  xCanvas,
[in] ::com::sun::star::awt::Rectangle  aOuterBorderRectangle,
[in] ::com::sun::star::awt::Rectangle  aRepaintArea,
[in] string  sTitle,
[in] ::com::sun::star::awt::Point  aCalloutAnchor );

Description
Paint the border around a pane where the border includes a callout that is anchored at the given point. Most arguments have the same meaning as in the paintBorder.
Parameter aCalloutAnchor
The anchor point of the callout. It is usually located outside the border.
getCalloutOffset
::com::sun::star::awt::Point
getCalloutOffset( [in] string  sPaneBorderStyleName );

Description
Return the offset of a callout anchor with respect to the outer border. This value is used when the callout is realized by a fixed bitmap in order to determine the size and/or location of the outer border for a given callout.
Top of Page

Apache Software Foundation

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

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, 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.