summaryrefslogtreecommitdiffstats
path: root/udkapi/com/sun/star/util
diff options
context:
space:
mode:
Diffstat (limited to 'udkapi/com/sun/star/util')
-rw-r--r--udkapi/com/sun/star/util/BootstrapMacroExpander.idl53
-rw-r--r--udkapi/com/sun/star/util/MacroExpander.idl50
-rw-r--r--udkapi/com/sun/star/util/XMacroExpander.idl54
-rw-r--r--udkapi/com/sun/star/util/XVeto.idl51
-rw-r--r--udkapi/com/sun/star/util/theMacroExpander.idl44
5 files changed, 252 insertions, 0 deletions
diff --git a/udkapi/com/sun/star/util/BootstrapMacroExpander.idl b/udkapi/com/sun/star/util/BootstrapMacroExpander.idl
new file mode 100644
index 000000000..55fffdcef
--- /dev/null
+++ b/udkapi/com/sun/star/util/BootstrapMacroExpander.idl
@@ -0,0 +1,53 @@
+/* -*- 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_util_BootstrapMacroExpander_idl__
+#define __com_sun_star_util_BootstrapMacroExpander_idl__
+
+#include <com/sun/star/util/MacroExpander.idl>
+#include <com/sun/star/lang/XInitialization.idl>
+
+
+
+module com { module sun { module star { module util {
+
+
+/** Macro expander expanding using rtl bootstrap notation.
+
+ For details, have a look at
+ http://udk.openoffice.org/common/man/concept/micro_deployment.html#misc
+
+ The service can be instantiated via arguments giving an ini/rc file url.
+ Otherwise it will read from a uno.ini/unorc file next to the cppuhelper
+ library.
+
+ @see theMacroExpander
+
+ @since OOo 1.1.2
+*/
+published service BootstrapMacroExpander
+{
+ service MacroExpander;
+ [optional] interface com::sun::star::lang::XInitialization;
+};
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/udkapi/com/sun/star/util/MacroExpander.idl b/udkapi/com/sun/star/util/MacroExpander.idl
new file mode 100644
index 000000000..5c49d9265
--- /dev/null
+++ b/udkapi/com/sun/star/util/MacroExpander.idl
@@ -0,0 +1,50 @@
+/* -*- 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_util_MacroExpander_idl__
+#define __com_sun_star_util_MacroExpander_idl__
+
+#include <com/sun/star/lang/XComponent.idl>
+#include <com/sun/star/util/XMacroExpander.idl>
+
+
+module com { module sun { module star { module util {
+
+
+/** This meta service supports the XMacroExpander interface for expanding
+ arbitrary macro expressions, i.e. substitute macro names.
+ The purpose of this service is to separate the use of macrofied strings,
+ e.g. urls from the use of services.
+
+ @see BootstrapMacroExpander
+ @see theMacroExpander
+
+ @since OOo 1.1.2
+ @deprecated rather use the util::theMacroExpander singleton
+*/
+published service MacroExpander
+{
+ interface XMacroExpander;
+ [optional] interface com::sun::star::lang::XComponent;
+};
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/udkapi/com/sun/star/util/XMacroExpander.idl b/udkapi/com/sun/star/util/XMacroExpander.idl
new file mode 100644
index 000000000..3fdc59898
--- /dev/null
+++ b/udkapi/com/sun/star/util/XMacroExpander.idl
@@ -0,0 +1,54 @@
+/* -*- 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_util_XMacroExpander_idl__
+#define __com_sun_star_util_XMacroExpander_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+
+
+
+module com { module sun { module star { module util {
+
+
+/** Expands macro in expressions, i.e. substitutes macro names.
+
+ @since OOo 1.1.2
+*/
+published interface XMacroExpander : com::sun::star::uno::XInterface
+{
+ /** Expands macrofied expressions.
+
+ @param exp
+ macrofied expression
+ @return
+ demacrofied expression
+ @throws IllegalArgumentException
+ if a macro name is unknown, thus cannot be expanded
+ */
+ string expandMacros( [in] string exp )
+ raises (com::sun::star::lang::IllegalArgumentException);
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/udkapi/com/sun/star/util/XVeto.idl b/udkapi/com/sun/star/util/XVeto.idl
new file mode 100644
index 000000000..ece6a6990
--- /dev/null
+++ b/udkapi/com/sun/star/util/XVeto.idl
@@ -0,0 +1,51 @@
+/* -*- 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_util_XVeto_idl__
+#define __com_sun_star_util_XVeto_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+
+module com { module sun { module star { module util {
+
+
+/** provides information about a veto which has been raised against an operation
+ */
+interface XVeto
+{
+ /** describes the reason for the veto
+ */
+ [attribute, readonly] string Reason;
+
+ /** provides additional details about the veto.
+
+ <p>The concrete semantics of this attribute is to be defined
+ in the service implementing this interface.</p>
+ */
+ [attribute, readonly] any Details;
+};
+
+
+}; }; }; };
+
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/udkapi/com/sun/star/util/theMacroExpander.idl b/udkapi/com/sun/star/util/theMacroExpander.idl
new file mode 100644
index 000000000..c2de31268
--- /dev/null
+++ b/udkapi/com/sun/star/util/theMacroExpander.idl
@@ -0,0 +1,44 @@
+/* -*- 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_util_theMacroExpander_idl__
+#define __com_sun_star_util_theMacroExpander_idl__
+
+#include <com/sun/star/util/XMacroExpander.idl>
+
+module com { module sun { module star { module util {
+
+/** A service that has to deal with macrofied strings will preprocess those
+ strings using the macro expander singleton.
+ The macro expander singleton is deployed with the application.
+
+ This feature is currently used macrofying loader urls with macros defined
+ in uno.ini/unorc bootstrap files. The component loader uses the macro
+ expander singleton to expand those macros. This is a flexible way
+ preprocessing loader urls.
+
+ @see MacroExpander
+*/
+published singleton theMacroExpander : XMacroExpander;
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */