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 :: frame ::

interface XFrames
Base Interfaces
XFrames
┗ ::com::sun::star::container::XIndexAccess
   ┗ ::com::sun::star::container::XElementAccess
::com::sun::star::container::XIndexAccess
(referenced interface's summary:)
provides access to the elements of a collection through an index.
Description
manages and creates frames.

Frames may contain other frames (by implementing an XFrames interface) and may be contained in other frames.

See also
XFrame, Frame
Developers Guide
OfficeDev - Frames - Linking Components and Windows
OfficeDev - Using the Desktop
Methods' Summary
append appends the specified Frame to the list of sub-frames.  
queryFrames provides access to the list of all currently existing frames inside this container and her sub frames  
remove removes the frame from its container.  
Methods' Details
append
void
append( [in] XFrame  xFrame );
Description
appends the specified Frame to the list of sub-frames.
Parameter xFrame
new frame for inserting into this container
queryFrames
sequence< XFrame >
queryFrames( [in] long  nSearchFlags );
Description
provides access to the list of all currently existing frames inside this container and her sub frames
Parameter nSearchFlags
use combinations of FrameSearchFlag to specify which frames should be found
Returns
all frames of this container and all available frames of the whole frame tree which match search parameter SearchFlags
remove
void
remove( [in] XFrame  xFrame );
Description
removes the frame from its container.

Note:

  • The method XComponent::dispose() is not called implicitly by this method.
  • The creator attribute of the frame must be reset by the caller of this method.

Parameter xFrame
frame which should be removed from this container
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.