diff options
Diffstat (limited to 'offapi/com/sun/star/office/XAnnotation.idl')
-rw-r--r-- | offapi/com/sun/star/office/XAnnotation.idl | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/offapi/com/sun/star/office/XAnnotation.idl b/offapi/com/sun/star/office/XAnnotation.idl new file mode 100644 index 000000000..d305743f2 --- /dev/null +++ b/offapi/com/sun/star/office/XAnnotation.idl @@ -0,0 +1,76 @@ +/* -*- 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_office_XAnnotation_idl__ +#define __com_sun_star_office_XAnnotation_idl__ + +#include <com/sun/star/beans/XPropertySet.idl> +#include <com/sun/star/beans/XMultiPropertySet.idl> +#include <com/sun/star/util/DateTime.idl> +#include <com/sun/star/text/XText.idl> +#include <com/sun/star/geometry/RealPoint2D.idl> +#include <com/sun/star/geometry/RealSize2D.idl> +#include <com/sun/star/lang/XComponent.idl> + + +module com { module sun { module star { module office { + + +/** This interface gives access to an annotation inside a document. + */ +interface XAnnotation +{ + /** All attributes are also available as properties. */ + interface ::com::sun::star::beans::XPropertySet; + + /** manages the lifetime of this annotation, should only be used + by the owner of the annotation which should be the document itself. */ + interface ::com::sun::star::lang::XComponent; + + /** a reference to the document content this annotation is anchored to. */ + [attribute, readonly] any Anchor; + + /** this is an optional position that gives the user interface a hint where + the annotation should be rendered. This could be an offset to the + annotations anchor. */ + [attribute] ::com::sun::star::geometry::RealPoint2D Position; + + /** this is an optional size that gives the user interface a hint how + large the annotation should be rendered. */ + [attribute] ::com::sun::star::geometry::RealSize2D Size; + + /** stores the full name of the author who created this annotation. */ + [attribute] string Author; + + /** stores the initials of the author who created this annotation. */ + [attribute] string Initials; + + /** stores the date and time this annotation was last edited. */ + [attribute] ::com::sun::star::util::DateTime DateTime; + + /** gives access to the annotations text. */ + [attribute, readonly] ::com::sun::star::text::XText TextRange; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |