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

LibreOffice LibreOffice 7.3 SDK API Reference

XUntitledNumbers.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_XUntitledNumbers_idl__
20#define __com_sun_star_frame_XUntitledNumbers_idl__
21
22#include <com/sun/star/uno/XInterface.idl>
23#include <com/sun/star/lang/IllegalArgumentException.idl>
24
25
26 module com { module sun { module star { module frame {
27
31 interface XUntitledNumbers : com::sun::star::uno::XInterface
32{
46 long leaseNumber ( [in] com::sun::star::uno::XInterface xComponent )
47 raises (com::sun::star::lang::IllegalArgumentException);
48
63 void releaseNumber ( [in] long nNumber )
64 raises (com::sun::star::lang::IllegalArgumentException);
65
75 void releaseNumberForComponent ( [in] com::sun::star::uno::XInterface xComponent )
76 raises (com::sun::star::lang::IllegalArgumentException);
77
87 string getUntitledPrefix ();
88};
89
90
91}; }; }; };
92
93#endif
94
95/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
IllegalArgumentException.idl
XInterface.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::frame::XUntitledNumbers
knows all currently used and all free numbers for using with untitled but counted objects.
Definition: XUntitledNumbers.idl:32
com::sun::star::frame::XUntitledNumbers::leaseNumber
long leaseNumber([in] com::sun::star::uno::XInterface xComponent)
callee has to lease a number before he can use it within in its own title.
com::sun::star::frame::XUntitledNumbers::releaseNumber
void releaseNumber([in] long nNumber)
has to be used to mark those numbers as "free for using".
com::sun::star::frame::XUntitledNumbers::getUntitledPrefix
string getUntitledPrefix()
returns the localized string value to be used for untitled objects in combination with the leased num...
com::sun::star::frame::XUntitledNumbers::releaseNumberForComponent
void releaseNumberForComponent([in] com::sun::star::uno::XInterface xComponent)
does the same then releaseNumber () but it searches the corresponding number for the specified compon...
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:48
com
Definition: Ambiguous.idl:22