LibreOffice LibreOffice 25.8 SDK API Reference

XVisualObject.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 embed {
23
26published interface XVisualObject: ::com::sun::star::uno::XInterface
27{
56 void setVisualAreaSize( [in] hyper nAspect,
57 [in] ::com::sun::star::awt::Size aSize )
58 raises( ::com::sun::star::lang::IllegalArgumentException,
59 ::com::sun::star::embed::WrongStateException,
60 ::com::sun::star::uno::Exception );
61
82 ::com::sun::star::awt::Size getVisualAreaSize( [in] hyper nAspect )
83 raises( ::com::sun::star::lang::IllegalArgumentException,
84 ::com::sun::star::embed::WrongStateException,
85 ::com::sun::star::uno::Exception );
86
112 VisualRepresentation getPreferredVisualRepresentation( [in] hyper nAspect )
113 raises( ::com::sun::star::lang::IllegalArgumentException,
114 ::com::sun::star::embed::WrongStateException,
115 ::com::sun::star::uno::Exception );
116
117
134 long getMapUnit( [in] hyper nAspect )
135 raises( ::com::sun::star::uno::Exception );
136};
137
138
139}; }; }; };
140
141/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::embed::WrongStateException
This exception can be thrown in case the object's state does not allow to call requested functionalit...
Definition: WrongStateException.idl:29
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:27
com::sun::star::uno::Exception
the base of all UNO exceptions
Definition: Exception.idl:29
com::sun::star::embed::XVisualObject
represents common visualization functionality for embedded objects.
Definition: XVisualObject.idl:27
com::sun::star::embed::XVisualObject::getVisualAreaSize
::com::sun::star::awt::Size getVisualAreaSize([in] hyper nAspect)
gets the size of object's visual area.
com::sun::star::embed::XVisualObject::setVisualAreaSize
void setVisualAreaSize([in] hyper nAspect, [in] ::com::sun::star::awt::Size aSize)
sets the size of object's visual area.
com::sun::star::embed::XVisualObject::getMapUnit
long getMapUnit([in] hyper nAspect)
retrieves map mode the object communicates in.
com::sun::star::embed::XVisualObject::getPreferredVisualRepresentation
VisualRepresentation getPreferredVisualRepresentation([in] hyper nAspect)
retrieves visual representation of the object in preferable format.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com
Definition: Ambiguous.idl:20
com::sun::star::awt::Size
specifies the 2-dimensional size of an area using width and height.
Definition: Size.idl:28
com::sun::star::embed::VisualRepresentation
can contain a graphical representation in an arbitrary format.
Definition: VisualRepresentation.idl:27