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

LibreOffice LibreOffice 7.3 SDK API Reference

XModel2.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_XModel2_idl__
20#define __com_sun_star_frame_XModel2_idl__
21
22#include <com/sun/star/frame/XController2.idl>
23#include <com/sun/star/frame/XModel.idl>
24#include <com/sun/star/container/XEnumeration.idl>
25#include <com/sun/star/awt/XWindow.idl>
26#include <com/sun/star/lang/IllegalArgumentException.idl>
27#include <com/sun/star/util/InvalidStateException.idl>
28
29
30 module com { module sun { module star { module frame {
31
42 interface XModel2 : com::sun::star::frame::XModel
43{
57 com::sun::star::container::XEnumeration getControllers();
58
81 sequence< string > getAvailableViewControllerNames();
82
99 com::sun::star::frame::XController2 createDefaultViewController( [in] com::sun::star::frame::XFrame Frame )
100 raises (com::sun::star::lang::IllegalArgumentException,
101 com::sun::star::uno::Exception );
102
128 com::sun::star::frame::XController2 createViewController( [in] string ViewName ,
129 [in] sequence< com::sun::star::beans::PropertyValue > Arguments ,
130 [in] com::sun::star::frame::XFrame Frame )
131 raises (com::sun::star::lang::IllegalArgumentException,
132 com::sun::star::uno::Exception );
133
156 void setArgs([in] sequence< com::sun::star::beans::PropertyValue > Arguments)
157 raises(com::sun::star::lang::IllegalArgumentException,
158 com::sun::star::util::InvalidStateException);
159};
160
161
162}; }; }; };
163
164#endif
165
166/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
IllegalArgumentException.idl
InvalidStateException.idl
XController2.idl
XEnumeration.idl
XWindow.idl
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
com::sun::star::uno::Exception
the base of all UNO exceptions
Definition: Exception.idl:33
com::sun::star::util::InvalidStateException
is thrown when an object's state does not allow to call requested functionality.
Definition: InvalidStateException.idl:32
XModel.idl
com::sun::star::container::XEnumeration
provides functionality to enumerate the contents of a container.
Definition: XEnumeration.idl:55
com::sun::star::frame::XController2
extends the XController interface
Definition: XController2.idl:37
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::XModel2
extends interface XModel.
Definition: XModel2.idl:43
com::sun::star::frame::XModel2::getControllers
com::sun::star::container::XEnumeration getControllers()
provides list of all currently connected controller objects.
com::sun::star::frame::XModel2::createViewController
com::sun::star::frame::XController2 createViewController([in] string ViewName, [in] sequence< com::sun::star::beans::PropertyValue > Arguments, [in] com::sun::star::frame::XFrame Frame)
creates a new view instance classified by the specified name and arguments.
com::sun::star::frame::XModel2::createDefaultViewController
com::sun::star::frame::XController2 createDefaultViewController([in] com::sun::star::frame::XFrame Frame)
creates the default view instance for this model.
com::sun::star::frame::XModel2::getAvailableViewControllerNames
sequence< string > getAvailableViewControllerNames()
provides the available names of the factory to be used to create views.
com::sun::star::frame::XModel2::setArgs
void setArgs([in] sequence< com::sun::star::beans::PropertyValue > Arguments)
Sets com::sun::star::document::MediaDescriptor properties of the current model during runtime.
com::sun::star::frame::XModel
represents a component which is created from a URL and arguments.
Definition: XModel.idl:59
com
Definition: Ambiguous.idl:22
com::sun::star::frame::Frame
represents the environment for a desktop component
Definition: Frame.idl:41