LibreOffice
LibreOffice 26.2 SDK API Reference
Toggle main menu visibility
Loading...
Searching...
No Matches
XController.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
module
com
{ module sun { module star { module frame {
22
23
published
interface
XFrame;
24
published
interface
XModel;
25
33
published
interface
XController
:
com::sun::star::lang::XComponent
34
{
40
void
attachFrame
( [in]
XFrame
Frame
);
41
52
boolean
attachModel
( [in]
XModel
Model );
53
65
boolean
suspend
( [in]
boolean
Suspend );
66
73
any
getViewData
();
74
81
void
restoreViewData
( [in] any Data );
82
88
XModel
getModel
();
89
95
XFrame
getFrame
();
96
};
97
98
99
}; }; }; };
100
101
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::frame::XController
With this interface, components viewed in a Frame can serve events (by supplying dispatches).
Definition
XController.idl:34
com::sun::star::frame::XController::attachFrame
void attachFrame([in] XFrame Frame)
is called to attach the controller with its managing frame.
com::sun::star::frame::XController::restoreViewData
void restoreViewData([in] any Data)
restores the view status using the data gotten from a previous call to XController::getViewData().
com::sun::star::frame::XController::getModel
XModel getModel()
provides access to currently attached model
com::sun::star::frame::XController::suspend
boolean suspend([in] boolean Suspend)
is called to prepare the controller for closing the view
com::sun::star::frame::XController::attachModel
boolean attachModel([in] XModel Model)
is called to attach the controller to a new model.
com::sun::star::frame::XController::getViewData
any getViewData()
provides access to current view status
com::sun::star::frame::XController::getFrame
XFrame getFrame()
provides access to owner frame of this controller
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::XModel
represents a component which is created from a URL and arguments.
Definition
XModel.idl:51
com::sun::star::lang::XComponent
allows to explicitly free resources and break cyclic references.
Definition
XComponent.idl:39
com
Definition
Ambiguous.idl:20
com::sun::star::frame::Frame
represents the environment for a desktop component
Definition
Frame.idl:36
com
sun
star
frame
XController.idl
Generated by
1.17.0