Line data Source code
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 : #ifndef INCLUDED_FORMS_SOURCE_INC_FEATUREDISPATCHER_HXX
21 : #define INCLUDED_FORMS_SOURCE_INC_FEATUREDISPATCHER_HXX
22 :
23 : #include <rtl/ustring.hxx>
24 :
25 :
26 : namespace frm
27 : {
28 :
29 :
30 :
31 : //= IFeatureDispatcher
32 :
33 0 : class IFeatureDispatcher
34 : {
35 : public:
36 : /** dispatches a feature
37 :
38 : @param _nFeatureId
39 : the id of the feature to dispatch
40 : */
41 : virtual void dispatch( sal_Int16 _nFeatureId ) const = 0;
42 :
43 : /** dispatches a feature, with an additional named parameter
44 :
45 : @param _nFeatureId
46 : the id of the feature to dispatch
47 :
48 : @param _pParamAsciiName
49 : the Ascii name of the parameter of the dispatch call
50 :
51 : @param _rParamValue
52 : the value of the parameter of the dispatch call
53 : */
54 : virtual void dispatchWithArgument(
55 : sal_Int16 _nFeatureId,
56 : const sal_Char* _pParamName,
57 : const ::com::sun::star::uno::Any& _rParamValue
58 : ) const = 0;
59 :
60 : /** checks whether a given feature is enabled
61 : */
62 : virtual bool isEnabled( sal_Int16 _nFeatureId ) const = 0;
63 :
64 : /** returns the boolean state of a feature
65 :
66 : Certain features may support more status information than only the enabled/disabled
67 : state. The type of such additional information is fixed relative to a given feature, but
68 : may differ between different features.
69 :
70 : This method allows retrieving status information about features which have an additional
71 : boolean information associated with it.
72 : */
73 : virtual bool getBooleanState( sal_Int16 _nFeatureId ) const = 0;
74 :
75 : /** returns the string state of a feature
76 :
77 : Certain features may support more status information than only the enabled/disabled
78 : state. The type of such additional information is fixed relative to a given feature, but
79 : may differ between different features.
80 :
81 : This method allows retrieving status information about features which have an additional
82 : string information associated with it.
83 : */
84 : virtual OUString getStringState( sal_Int16 _nFeatureId ) const = 0;
85 :
86 : /** returns the integer state of a feature
87 :
88 : Certain features may support more status information than only the enabled/disabled
89 : state. The type of such additional information is fixed relative to a given feature, but
90 : may differ between different features.
91 :
92 : This method allows retrieving status information about features which have an additional
93 : integer information associated with it.
94 : */
95 : virtual sal_Int32 getIntegerState( sal_Int16 _nFeatureId ) const = 0;
96 :
97 : protected:
98 0 : ~IFeatureDispatcher() {}
99 : };
100 :
101 :
102 : } // namespace frm
103 :
104 :
105 : #endif // INCLUDED_FORMS_SOURCE_INC_FEATUREDISPATCHER_HXX
106 :
107 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
