interface XFramesSupplier in module com::sun::star::frame::

(Global Index)

Syntax

interface XFramesSupplier : com::sun::star::frame::XFrame ;

Method Summary

getFrames

getActiveFrame

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

Known Services Which Export this Interface

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

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

Method Details



getFrames

Syntax

com::sun::star::frame::XFrames getFrames ();

Returns

the collection of (sub-) frames which is represented by a FramesContainer .

getActiveFrame

Syntax

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

Syntax

void setActiveFrame (
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