diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
commit | ed5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch) | |
tree | 7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/embed/XInplaceObject.idl | |
parent | Initial commit. (diff) | |
download | libreoffice-upstream.tar.xz libreoffice-upstream.zip |
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | offapi/com/sun/star/embed/XInplaceObject.idl | 109 |
1 files changed, 109 insertions, 0 deletions
diff --git a/offapi/com/sun/star/embed/XInplaceObject.idl b/offapi/com/sun/star/embed/XInplaceObject.idl new file mode 100644 index 000000000..187605685 --- /dev/null +++ b/offapi/com/sun/star/embed/XInplaceObject.idl @@ -0,0 +1,109 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_embed_XInplaceObject_idl__ +#define __com_sun_star_embed_XInplaceObject_idl__ + +#include <com/sun/star/uno/XInterface.idl> +#include <com/sun/star/awt/Rectangle.idl> +#include <com/sun/star/awt/KeyEvent.idl> +#include <com/sun/star/embed/WrongStateException.idl> + + + + + module com { module sun { module star { module embed { + +/** represents common functionality for inplace embedded objects. + */ +published interface XInplaceObject: com::sun::star::uno::XInterface +{ + /** sets the visible part of the inplace object. + + <p> + Both rectangles are provided in object's parent window coordinates + in pixels. The intersection of rectangles specifies the visible part + of the object. In case the position window has a size that is + different from object's visual area size, the object should either + scale or deactivate. + </p> + + <p> + The method must activate object repainting. + </p> + + @param aPosRect + specifies a new position rectangle + + @param aClipRect + specifies a new clip rectangle + + @throws com::sun::star::embed::WrongStateException + the object is in invalid state + + @throws com::sun::star::uno::Exception + in case of other problems + */ + void setObjectRectangles( [in] ::com::sun::star::awt::Rectangle aPosRect, + [in] ::com::sun::star::awt::Rectangle aClipRect ) + raises( ::com::sun::star::embed::WrongStateException, + ::com::sun::star::uno::Exception ); + + /** enables or disables modeless dialogs of the object. + + <p> + In case container wants to show a modal dialog it should disable + modeless of embedded object dialogs with this call. Later the same + call can be used to enable it. + </p> + + @param bEnable + `TRUE` to enable object modeless + `FALSE` to disable it + + @throws com::sun::star::embed::WrongStateException + the object is in wrong state + + @throws com::sun::star::uno::Exception + in case of other problems + */ + void enableModeless( [in] boolean bEnable ) + raises( ::com::sun::star::embed::WrongStateException, + ::com::sun::star::uno::Exception ); + + /** provides accelerator table the container wants to use during inplace + editing. + + @return + an accelerator table from container + + @throws com::sun::star::embed::WrongStateException + the object is in unexpected state + */ + void translateAccelerators( + [in] sequence< ::com::sun::star::awt::KeyEvent > aKeys ) + raises( ::com::sun::star::embed::WrongStateException ); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |