1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_frame_XFramesSupplier_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_frame_XFramesSupplier_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_frame_XFrame_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/frame/XFrame.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski//============================================================================= 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielski module com { module sun { module star { module frame { 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski published interface XFrames; 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski//============================================================================= 37*b1cdbd2cSJim Jagielski/** provides access to sub frames of current one 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski @see XFrames 40*b1cdbd2cSJim Jagielski */ 41*b1cdbd2cSJim Jagielskipublished interface XFramesSupplier: XFrame 42*b1cdbd2cSJim Jagielski{ 43*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 44*b1cdbd2cSJim Jagielski /** provides access to this container and to all other <type>XFramesSupplier</type> 45*b1cdbd2cSJim Jagielski which are available from this node of frame tree 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski @returns 48*b1cdbd2cSJim Jagielski the collection of frames which is represented by 49*b1cdbd2cSJim Jagielski a <type>FramesContainer</type>. 50*b1cdbd2cSJim Jagielski */ 51*b1cdbd2cSJim Jagielski XFrames getFrames(); 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 54*b1cdbd2cSJim Jagielski /** gets the current active frame of this container 55*b1cdbd2cSJim Jagielski (not of any other available supplier) 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski <p> 58*b1cdbd2cSJim Jagielski This may be the frame itself. The active frame is defined as 59*b1cdbd2cSJim Jagielski the frame which contains (recursively) the window with the focus. 60*b1cdbd2cSJim Jagielski If no window within the frame contains the focus, this method 61*b1cdbd2cSJim Jagielski returns the last frame which had the focus. If no containing 62*b1cdbd2cSJim Jagielski window ever had the focus, the first frame within this frame is 63*b1cdbd2cSJim Jagielski returned. 64*b1cdbd2cSJim Jagielski </p> 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski @returns 67*b1cdbd2cSJim Jagielski the <type>Frame</type> which is active within this frame. 68*b1cdbd2cSJim Jagielski */ 69*b1cdbd2cSJim Jagielski XFrame getActiveFrame(); 70*b1cdbd2cSJim Jagielski 71*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 72*b1cdbd2cSJim Jagielski /** is called on activation of a direct sub-frame. 73*b1cdbd2cSJim Jagielski 74*b1cdbd2cSJim Jagielski <p> 75*b1cdbd2cSJim Jagielski This method is only allowed to be called by a sub-frame according to 76*b1cdbd2cSJim Jagielski <member>XFrame::activate()</member> or <member>XFramesSupplier::setActiveFrame()</member>. 77*b1cdbd2cSJim Jagielski After this call <member>XFramesSupplier::getActiveFrame()</member> will return the 78*b1cdbd2cSJim Jagielski frame specified by <var>Frame</var>. 79*b1cdbd2cSJim Jagielski </p> 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski <p> 82*b1cdbd2cSJim Jagielski In general this method first calls the method <member>XFramesSupplier::setActiveFrame()</member> 83*b1cdbd2cSJim Jagielski at the creator frame with <var>this</var> as the current argument. Then it broadcasts 84*b1cdbd2cSJim Jagielski the <type>FrameActionEvent</type> <const>FrameAction::FRAME_ACTIVATED</const>. 85*b1cdbd2cSJim Jagielski </p> 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski <p> 88*b1cdbd2cSJim Jagielski Note: Given parameter <var>Frame</var> must already exist inside the container 89*b1cdbd2cSJim Jagielski (e.g., inserted by using <member>XFrames::append()</member>) 90*b1cdbd2cSJim Jagielski </p> 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski @param Frame 93*b1cdbd2cSJim Jagielski the new active child frame inside this container 94*b1cdbd2cSJim Jagielski */ 95*b1cdbd2cSJim Jagielski void setActiveFrame( [in] XFrame Frame ); 96*b1cdbd2cSJim Jagielski}; 97*b1cdbd2cSJim Jagielski 98*b1cdbd2cSJim Jagielski//============================================================================= 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski}; }; }; }; 101*b1cdbd2cSJim Jagielski 102*b1cdbd2cSJim Jagielski#endif 103