summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/script/DocumentDialogLibraryContainer.idl
blob: 3ee68bf4ba4ae6c9b76614ead4464831a0961f90 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
/* -*- 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_script_DocumentDialogLibraryContainer_idl__
#define __com_sun_star_script_DocumentDialogLibraryContainer_idl__

#include <com/sun/star/script/XStorageBasedLibraryContainer.idl>
#include <com/sun/star/document/XStorageBasedDocument.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>



module com { module sun { module star { module script {


/** defines a container of dialog libraries, which is to be made
    persistent in a sub storage of a document storage.

    @since OOo 2.3
 */
service DocumentDialogLibraryContainer : XStorageBasedLibraryContainer
{
    /** creates an instance of the <code>DocumentDialogLibraryContainer</code>, belonging to a document

        <p>The current storage of the document will be set as initial root storage
        (see XPersistentLibraryContainer::RootStorage) of the container.</p>

        <p>Usually, you will only create a <code>DocumentDialogLibraryContainer</code> within
        the implementation of the document to which the container should belong.</p>

        @param Document
            The document to which the container should belong to. Must not be
            `NULL`.

        @throws ::com::sun::star::lang::IllegalArgumentException
            if <code>Document</code> does not denote a valid
            com::sun::star::document::OfficeDocument.
    */
    create( [in] ::com::sun::star::document::XStorageBasedDocument Document )
        raises( ::com::sun::star::lang::IllegalArgumentException );

    createWithURL( [in] string URL );
};


}; }; }; };


#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */