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

LibreOffice LibreOffice 7.3 SDK API Reference

XStorable.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_XStorable_idl__
20#define __com_sun_star_frame_XStorable_idl__
21
22#include <com/sun/star/uno/XInterface.idl>
23#include <com/sun/star/io/IOException.idl>
24#include <com/sun/star/beans/PropertyValue.idl>
25
26
27
28 module com { module sun { module star { module frame {
29
47published interface XStorable: com::sun::star::uno::XInterface
48{
56 boolean hasLocation();
57
64 string getLocation();
65
73 boolean isReadonly();
74
86 void store()
87 raises( com::sun::star::io::IOException );
88
116 void storeAsURL(
117 [in] string sURL,
118 [in] sequence<com::sun::star::beans::PropertyValue> lArguments )
119 raises( com::sun::star::io::IOException );
120
145 void storeToURL(
146 [in] string sURL,
147 [in] sequence<com::sun::star::beans::PropertyValue> lArguments )
148 raises( com::sun::star::io::IOException );
149};
150
151
152}; }; }; };
153
154#endif
155
156/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
IOException.idl
PropertyValue.idl
XInterface.idl
com::sun::star::frame::XStorable
offers a simple way to store a component to a URL.
Definition: XStorable.idl:48
com::sun::star::frame::XStorable::hasLocation
boolean hasLocation()
The object may know the location because it was loaded from there, or because it is stored there.
com::sun::star::frame::XStorable::isReadonly
boolean isReadonly()
It is not possible to call XStorable::store() successfully when the data store is read-only.
com::sun::star::frame::XStorable::getLocation
string getLocation()
After XStorable::storeAsURL() it returns the URL the object was stored to.
com::sun::star::frame::XStorable::store
void store()
stores the data to the URL from which it was loaded.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:48
com
Definition: Accessible.idl:22