LibreOffice: com/sun/star/frame/XDesktop.idl Source File

LibreOffice LibreOffice 7.3 SDK API Reference

XDesktop.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19#ifndef __com_sun_star_frame_XDesktop_idl__
20#define __com_sun_star_frame_XDesktop_idl__
21
22#include <com/sun/star/uno/XInterface.idl>
23#include <com/sun/star/frame/XTerminateListener.idl>
24#include <com/sun/star/container/XEnumerationAccess.idl>
25#include <com/sun/star/lang/XComponent.idl>
26#include <com/sun/star/frame/XFrame.idl>
27
28
29
30 module com { module sun { module star { module frame {
31
43published interface XDesktop: com::sun::star::uno::XInterface
44{
64 boolean terminate();
65
75 void addTerminateListener( [in] XTerminateListener Listener );
76
84 void removeTerminateListener( [in] XTerminateListener Listener );
85
103 com::sun::star::container::XEnumerationAccess getComponents();
104
118 com::sun::star::lang::XComponent getCurrentComponent();
119
128 XFrame getCurrentFrame();
129};
130
131
132}; }; }; };
133
134#endif
135
136/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
XComponent.idl
XEnumerationAccess.idl
XFrame.idl
XInterface.idl
XTerminateListener.idl
com::sun::star::container::XEnumerationAccess
used to enumerate objects in a container which contains objects.
Definition: XEnumerationAccess.idl:34
com::sun::star::frame::XDesktop
This is the main interface of a desktop service.
Definition: XDesktop.idl:44
com::sun::star::frame::XDesktop::removeTerminateListener
void removeTerminateListener([in] XTerminateListener Listener)
unregisters an event listener for termination events.
com::sun::star::frame::XDesktop::getComponents
com::sun::star::container::XEnumerationAccess getComponents()
provides read access to collection of all currently loaded components inside the frame tree
com::sun::star::frame::XDesktop::getCurrentComponent
com::sun::star::lang::XComponent getCurrentComponent()
provides read access to the component inside the tree which has the UI focus
com::sun::star::frame::XDesktop::getCurrentFrame
XFrame getCurrentFrame()
provides read access to the frame which contains the current component
com::sun::star::frame::XDesktop::addTerminateListener
void addTerminateListener([in] XTerminateListener Listener)
registers an event listener to the desktop, which is called when the desktop is queried to terminate,...
com::sun::star::frame::XDesktop::terminate
boolean terminate()
tries to terminate the desktop.
com::sun::star::frame::XFrame
a frame object can be considered to be an "anchor" object where a component can be attached to.
Definition: XFrame.idl:44
com::sun::star::frame::XTerminateListener
has to be provided if an object wants to receive an event when the master environment (e....
Definition: XTerminateListener.idl:38
com::sun::star::lang::XComponent
allows to explicitly free resources and break cyclic references.
Definition: XComponent.idl:43
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:48
com
Definition: Accessible.idl:22