Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: frame ::

interface XFramesSupplier

Base Interface
com::sun::star::frame::XFrame



Known Services which Export this Interface

com::sun::star::frame::DesktopTask specifies a separate task within a desktop environment.
com::sun::star::frame::Frame represents the environment for a desktop component.

Methods' Summary

getFrames
getActiveFrame
setActiveFrame is called on activation of a direct sub-frame.

Methods' Details

getFrames
 
com::sun::star::frame::XFrames
getFrames();
Returns
the collection of (sub-) frames which is represented by a FramesContainer .
getActiveFrame
 
com::sun::star::frame::XFrame
getActiveFrame();
Returns
the sub- Frame which is active within this frame.

This may be the frame itself. The active frame is defined as the frame which contains (recursively) the window with the focus. If no window within the frame contains the focus, this method returns the last frame which had the focus. If no containing window ever had the focus, the first frame within this frame is returned.

setActiveFrame
 
void
setActiveFrame(
[ in ] com::sun::star::frame::XFrame xFrame );

Description
is called on activation of a direct sub-frame.

This method is only allowed to be called by a sub-frame according to or . After this call will return the frame specified by xFrame .

In general this method first calls the method at the creator frame with this as the current argument. Then it broadcasts the FrameActionEvent FrameAction::FRAME_ACTIVATED .


Top of Page