forked from amazingfate/loongoffice
944eb99027
Doxygen does not know type element and will recognize strings that contain capital letter (all API types do) automatically as type. This patch removes 15k doxygen warnings. git ls-files | grep \\.idl | xargs sed -i "s,<type>\([^<]\+\)</type>,\1," Change-Id: I45c07cf0b115d5fb5353f4aa9719839615ea1150
152 lines
5.1 KiB
Plaintext
152 lines
5.1 KiB
Plaintext
/* -*- 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_XVisualObject_idl__
|
|
#define __com_sun_star_embed_XVisualObject_idl__
|
|
|
|
#include <com/sun/star/uno/XInterface.idl>
|
|
#include <com/sun/star/awt/Size.idl>
|
|
#include <com/sun/star/embed/VisualRepresentation.idl>
|
|
#include <com/sun/star/embed/WrongStateException.idl>
|
|
#include <com/sun/star/lang/IllegalArgumentException.idl>
|
|
|
|
|
|
|
|
module com { module sun { module star { module embed {
|
|
|
|
/** represents common visualization functionality for embedded objects.
|
|
*/
|
|
published interface XVisualObject: ::com::sun::star::uno::XInterface
|
|
{
|
|
/** sets the size of object's visual area.
|
|
|
|
<p>
|
|
The size must be provided in logical units according to map mode the
|
|
object communicates in.
|
|
</p>
|
|
|
|
<p>
|
|
If an object is inplace- or ui-active the method must not initiate
|
|
repainting itself.
|
|
</p>
|
|
|
|
@param nAspect
|
|
the aspect specifying the form of object representation.
|
|
Can take values from Aspects constant set.
|
|
|
|
@param aSize
|
|
the new size of the visual area
|
|
|
|
@throws ::com::sun::star::lang::IllegalArgumentException
|
|
one of arguments is illegal
|
|
|
|
@throws ::com::sun::star::embed::WrongStateException
|
|
the object is in wrong state
|
|
|
|
@throws ::com::sun::star::uno::Exception
|
|
the object failed to resize
|
|
*/
|
|
void setVisualAreaSize( [in] hyper nAspect,
|
|
[in] ::com::sun::star::awt::Size aSize )
|
|
raises( ::com::sun::star::lang::IllegalArgumentException,
|
|
::com::sun::star::embed::WrongStateException,
|
|
::com::sun::star::uno::Exception );
|
|
|
|
/** gets the size of object's visual area.
|
|
|
|
<p>
|
|
The size must be provided in logical units according to map mode the
|
|
object communicates in.
|
|
</p>
|
|
|
|
@param nAspect
|
|
the aspect specifying the form of object representation.
|
|
Can take values from Aspects constant set.
|
|
|
|
@return
|
|
the size of visual area
|
|
|
|
@throws ::com::sun::star::lang::IllegalArgumentException
|
|
one of arguments is illegal
|
|
|
|
@throws ::com::sun::star::embed::WrongStateException
|
|
the object is in wrong state
|
|
*/
|
|
::com::sun::star::awt::Size getVisualAreaSize( [in] hyper nAspect )
|
|
raises( ::com::sun::star::lang::IllegalArgumentException,
|
|
::com::sun::star::embed::WrongStateException,
|
|
::com::sun::star::uno::Exception );
|
|
|
|
/** retrieves visual representation of the object in preferable format.
|
|
|
|
<p>
|
|
If the object persistence entry contains cached visual representation
|
|
then it can be retrieved by using this method even in loaded state.
|
|
</p>
|
|
|
|
@param nAspect
|
|
the aspect the representation is requested for.
|
|
Can take values from Aspects constant set.
|
|
|
|
@return
|
|
the visual representation of the object in the default format and
|
|
the format
|
|
|
|
@throws ::com::sun::star::lang::IllegalArgumentException
|
|
one of arguments is illegal
|
|
|
|
@throws ::com::sun::star::embed::WrongStateException
|
|
the object is in wrong state
|
|
|
|
@throws ::com::sun::star::uno::Exception
|
|
in case of problems
|
|
|
|
*/
|
|
VisualRepresentation getPreferredVisualRepresentation( [in] hyper nAspect )
|
|
raises( ::com::sun::star::lang::IllegalArgumentException,
|
|
::com::sun::star::embed::WrongStateException,
|
|
::com::sun::star::uno::Exception );
|
|
|
|
|
|
/** retrieves map mode the object communicates in.
|
|
|
|
@param nAspect
|
|
the aspect the map mode is requested for.
|
|
Can take values from Aspects constant set.
|
|
|
|
@return
|
|
the map mode the object communicates in, it can take values from
|
|
EmbedMapUnits constant
|
|
|
|
@throws ::com::sun::star::embed::WrongStateException
|
|
the object is in wrong state
|
|
|
|
@throws ::com::sun::star::uno::Exception
|
|
in case of problems
|
|
*/
|
|
long getMapUnit( [in] hyper nAspect )
|
|
raises( ::com::sun::star::uno::Exception );
|
|
};
|
|
|
|
|
|
}; }; }; };
|
|
|
|
#endif
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|