summaryrefslogtreecommitdiff
path: root/offapi
diff options
context:
space:
mode:
authorMatúš Kukan <matus.kukan@gmail.com>2012-09-20 12:52:49 +0200
committerMatúš Kukan <matus.kukan@gmail.com>2012-09-20 12:59:50 +0200
commit6751cf5017fca96e6bef8ef2c316f676055eefb6 (patch)
treecb99f6632ffaaee864cc46fa840f0b18facc8a3b /offapi
parent21359dc87000c65665e49652d1c255e679817787 (diff)
Revert "remove remnants of ProductRegistration"
This reverts commit 1f77f1ac177521698ee7c978f218127cb5840046 and b590d87b380389371eca94ffb0e6f47f86d1c917. Do this again when we will know how to get rid of published service in offapi/type_reference/types.rdb.
Diffstat (limited to 'offapi')
-rw-r--r--offapi/UnoApi_offapi.mk1
-rw-r--r--offapi/com/sun/star/setup/ProductRegistration.idl82
2 files changed, 83 insertions, 0 deletions
diff --git a/offapi/UnoApi_offapi.mk b/offapi/UnoApi_offapi.mk
index 047a2ec68ca4..b053b9bd346e 100644
--- a/offapi/UnoApi_offapi.mk
+++ b/offapi/UnoApi_offapi.mk
@@ -1051,6 +1051,7 @@ $(eval $(call gb_UnoApi_add_idlfiles_noheader,offapi,offapi/com/sun/star/sdbcx,\
ViewDescriptor \
))
$(eval $(call gb_UnoApi_add_idlfiles_noheader,offapi,offapi/com/sun/star/setup,\
+ ProductRegistration \
Setup \
))
$(eval $(call gb_UnoApi_add_idlfiles_noheader,offapi,offapi/com/sun/star/sheet,\
diff --git a/offapi/com/sun/star/setup/ProductRegistration.idl b/offapi/com/sun/star/setup/ProductRegistration.idl
new file mode 100644
index 000000000000..3dbdf572f6e2
--- /dev/null
+++ b/offapi/com/sun/star/setup/ProductRegistration.idl
@@ -0,0 +1,82 @@
+/* -*- 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_setup_ProductRegistration_idl__
+#define __com_sun_star_setup_ProductRegistration_idl__
+
+#include <com/sun/star/task/JobExecutor.idl>
+#include <com/sun/star/task/XJob.idl>
+
+module com { module sun { module star { module setup {
+
+/** provides a mechanism for registering the product.
+
+ <p>Two main functionalities are covered by this service:
+ <ul><il><em>Triggering Online Registration</em><br/>
+ If, by any user interface of your choice, the user tells she wants to register
+ their product copy, ProductRegistration is the service of your choice.
+ </il><br/>
+ <il><em>Executing Registration Requests</em><br/>
+ ProductRegistration allows to remind your users to register, using a dialog with various
+ choices.
+ </il>
+ </ul></p>
+
+ @since OOo 1.1.2
+*/
+published service ProductRegistration
+{
+ /** allows to trigger certain events.
+
+ <p>The string argument of <method scope="com::sun::star::task">XJobExecutor::trigger</method> is
+ used to determine the type of the event. Currently supported events are:<br/>
+ <ul><li><b>RegistrationRequired</b><br/>
+ Determines that the registration is required to be executed.<br/>
+ This is usually triggered by some user interaction, for instance upon choosing a menu item
+ called <em>Registration</em>.</p>
+ </li>
+ </ul>
+ </p>
+ */
+ service com::sun::star::task::JobExecutor;
+
+ /** allows the registration request to be scheduled automatically.
+
+ <p>There are processes which allow to schedule events and jobs, for instance there
+ can be configuration settings scheduling which operations are to be executed upon an program
+ startup. Such processes usually require the jobs to be executed to support the
+ <type scope="com::sun::star::task">XJob</type> interface.</p>
+
+ <p>That's why this service supports the <type scope="com::sun::star::task">XJob</type>, too.<br/>
+ Calling the <method scope="com::sun::star::task">XJob::execute</method> method results in displaying a
+ dialog which asks the user to register. This is done once per session, means you need to restart the
+ process which called this.</p>
+
+ <p>At the moment, there is no specification about how to use the arguments given in the
+ <method scope="com::sun::star::task">XJob::execute</method> method, but this may change in future versions of the service
+ descriptions, so to keep your implementation compatible, you should not use these arguments.</p>
+ */
+ interface com::sun::star::task::XJob;
+};
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */