LibreOffice LibreOffice 25.8 SDK API Reference

Loading...
Searching...
No Matches
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
20
21
22 module com { module sun { module star { module frame {
23
41published interface XStorable: com::sun::star::uno::XInterface
42{
50 boolean hasLocation();
51
58 string getLocation();
59
67 boolean isReadonly();
68
80 void store()
81 raises( com::sun::star::io::IOException );
82
110 void storeAsURL(
111 [in] string sURL,
112 [in] sequence<com::sun::star::beans::PropertyValue> lArguments )
113 raises( com::sun::star::io::IOException );
114
139 void storeToURL(
140 [in] string sURL,
141 [in] sequence<com::sun::star::beans::PropertyValue> lArguments )
142 raises( com::sun::star::io::IOException );
143};
144
145
146}; }; }; };
147
148/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::frame::XStorable
offers a simple way to store a component to a URL.
Definition XStorable.idl:42
com::sun::star::frame::XStorable::storeAsURL
void storeAsURL([in] string sURL, [in] sequence< com::sun::star::beans::PropertyValue > lArguments)
stores the object's persistent data to a URL and makes this URL the new location of the object.
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::storeToURL
void storeToURL([in] string sURL, [in] sequence< com::sun::star::beans::PropertyValue > lArguments)
stores the object's persistent data to a URL and continues to be a representation of the old URL.
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:46
com::sun::star::beans
Java beans-like property access and introspection.
Definition Ambiguous.idl:20
com::sun::star::io
General input/output interfaces.
Definition AlreadyConnectedException.idl:22
com::sun::star
the module com::sun::star is the root module of the UNO API.
Definition Ambiguous.idl:20
com::sun
Definition Ambiguous.idl:20
com
Definition Ambiguous.idl:20