(incubating) | The Free and Open Productivity Suite

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.

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

unpublished interface XPane
Base Interfaces
XPaneXResource

XResource
(referenced interface's summary:)
Base interface that provides functionality shared by all resource types of the drawing framework.
Usage Restrictions
not published
Description
A pane is an abstraction of a window and is one of the resources managed by the drawing framework.

Apart from the area that displays a view a pane may contain other parts like title, menu, closer button.

The URL prefix of panes is private:resource/floater


Methods' Summary
getWindow Return the ::com::sun::star::awt::XWindow of the pane that is used to display a view.  
getCanvas Return the com::sun::star::awt::XCanvas of the pane. The ::com::sun::star::rendering::XCanvas object is expected to be associated with the ::com::sun::star::awt::XWindow object returned by getWindow().  
Methods' Details
getWindow
::com::sun::star::awt::XWindow
getWindow();

Description
Return the ::com::sun::star::awt::XWindow of the pane that is used to display a view.
getCanvas
::com::sun::star::rendering::XCanvas
getCanvas();

Description
Return the com::sun::star::awt::XCanvas of the pane. The ::com::sun::star::rendering::XCanvas object is expected to be associated with the ::com::sun::star::awt::XWindow object returned by getWindow().
Returns
When the ::com::sun::star::rendering::XCanvas interface is not supported then an empty reference is returned.
Top of Page

Apache OpenOffice 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.

Copyright & License
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.