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