Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

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

interface XPane
Base Interfaces
XPane
┗ XResource
XResource
(referenced interface's summary:)
Base interface that provides functionality shared by all resource types of the drawing framework.
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

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Software Foundation

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

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.