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

LibreOffice LibreOffice 24.8 SDK API Reference

Loading...
Searching...
No Matches
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
20
21
22 module com { module sun { module star { module frame {
23
35published interface XDesktop: com::sun::star::uno::XInterface
36{
56 boolean terminate();
57
67 void addTerminateListener( [in] XTerminateListener Listener );
68
76 void removeTerminateListener( [in] XTerminateListener Listener );
77
95 com::sun::star::container::XEnumerationAccess getComponents();
96
110 com::sun::star::lang::XComponent getCurrentComponent();
111
120 XFrame getCurrentFrame();
121};
122
123
124}; }; }; };
125
126/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::container::XEnumerationAccess
used to enumerate objects in a container which contains objects.
Definition XEnumerationAccess.idl:28
com::sun::star::frame::XDesktop
This is the main interface of a desktop service.
Definition XDesktop.idl:36
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:39
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:32
com::sun::star::lang::XComponent
allows to explicitly free resources and break cyclic references.
Definition XComponent.idl:39
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition XInterface.idl:46
com
Definition Ambiguous.idl:20