1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef SD_TOOLS_CONFIGURATION_ACCESS_HXX 25*b1cdbd2cSJim Jagielski #define SD_TOOLS_CONFIGURATION_ACCESS_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include <rtl/ustring.hxx> 28*b1cdbd2cSJim Jagielski #include <com/sun/star/container/XNameAccess.hpp> 29*b1cdbd2cSJim Jagielski #include <com/sun/star/container/XHierarchicalNameAccess.hpp> 30*b1cdbd2cSJim Jagielski #include <com/sun/star/uno/XComponentContext.hpp> 31*b1cdbd2cSJim Jagielski #include <com/sun/star/lang/XMultiServiceFactory.hpp> 32*b1cdbd2cSJim Jagielski #include <vector> 33*b1cdbd2cSJim Jagielski #include <boost/function.hpp> 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski namespace css = ::com::sun::star; 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski namespace sd { namespace tools { 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski /** This class gives access to the configuration. Create an object of this 40*b1cdbd2cSJim Jagielski class for one node of the configuration. This will be the root node. 41*b1cdbd2cSJim Jagielski Its children are then accessible through the new ConfigurationAccess 42*b1cdbd2cSJim Jagielski object. 43*b1cdbd2cSJim Jagielski */ 44*b1cdbd2cSJim Jagielski class ConfigurationAccess 45*b1cdbd2cSJim Jagielski { 46*b1cdbd2cSJim Jagielski public: 47*b1cdbd2cSJim Jagielski enum WriteMode { READ_WRITE, READ_ONLY }; 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski /** Create a new object to access the configuration entries below the 50*b1cdbd2cSJim Jagielski given root. 51*b1cdbd2cSJim Jagielski @param rsRootName 52*b1cdbd2cSJim Jagielski Name of the root. 53*b1cdbd2cSJim Jagielski @param eMode 54*b1cdbd2cSJim Jagielski This flag specifies whether to give read-write or read-only 55*b1cdbd2cSJim Jagielski access. 56*b1cdbd2cSJim Jagielski */ 57*b1cdbd2cSJim Jagielski ConfigurationAccess( 58*b1cdbd2cSJim Jagielski const ::rtl::OUString& rsRootName, 59*b1cdbd2cSJim Jagielski const WriteMode eMode); 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski ConfigurationAccess( 62*b1cdbd2cSJim Jagielski const css::uno::Reference<css::uno::XComponentContext>& rxContext, 63*b1cdbd2cSJim Jagielski const ::rtl::OUString& rsRootName, 64*b1cdbd2cSJim Jagielski const WriteMode eMode); 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski /** Return a configuration node below the root of the called object. 67*b1cdbd2cSJim Jagielski @param rsPathToNode 68*b1cdbd2cSJim Jagielski The relative path from the root (as given the constructor) to 69*b1cdbd2cSJim Jagielski the node. 70*b1cdbd2cSJim Jagielski @return 71*b1cdbd2cSJim Jagielski The type of the returned node varies with the requested node. 72*b1cdbd2cSJim Jagielski It is empty when the node was not found. 73*b1cdbd2cSJim Jagielski */ 74*b1cdbd2cSJim Jagielski css::uno::Any GetConfigurationNode ( 75*b1cdbd2cSJim Jagielski const ::rtl::OUString& rsPathToNode); 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski /** Return a configuration node below the given node. 78*b1cdbd2cSJim Jagielski @param rxNode 79*b1cdbd2cSJim Jagielski The node that acts as root to the given relative path. 80*b1cdbd2cSJim Jagielski @param rsPathToNode 81*b1cdbd2cSJim Jagielski The relative path from the given node to the requested node. 82*b1cdbd2cSJim Jagielski @return 83*b1cdbd2cSJim Jagielski The type of the returned node varies with the requested node. 84*b1cdbd2cSJim Jagielski It is empty when the node was not found. 85*b1cdbd2cSJim Jagielski */ 86*b1cdbd2cSJim Jagielski static css::uno::Any GetConfigurationNode ( 87*b1cdbd2cSJim Jagielski const css::uno::Reference<css::container::XHierarchicalNameAccess>& rxNode, 88*b1cdbd2cSJim Jagielski const ::rtl::OUString& rsPathToNode); 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski /** Write any changes that have been made back to the configuration. 91*b1cdbd2cSJim Jagielski This call is ignored when the called ConfigurationAccess object was 92*b1cdbd2cSJim Jagielski not create with read-write mode. 93*b1cdbd2cSJim Jagielski */ 94*b1cdbd2cSJim Jagielski void CommitChanges (void); 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski /** This functor is typically called for every item in a set. Its two 97*b1cdbd2cSJim Jagielski parameters are the name of key item (often of no further interest) 98*b1cdbd2cSJim Jagielski and the value of the item. 99*b1cdbd2cSJim Jagielski */ 100*b1cdbd2cSJim Jagielski typedef ::boost::function<void( 101*b1cdbd2cSJim Jagielski const ::rtl::OUString&, 102*b1cdbd2cSJim Jagielski const std::vector<css::uno::Any>&) > Functor; 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski /** Execute a functor for all elements of the given container. 105*b1cdbd2cSJim Jagielski @param rxContainer 106*b1cdbd2cSJim Jagielski The container is a XNameAccess to a list of the configuration. 107*b1cdbd2cSJim Jagielski This can be a node returned by GetConfigurationNode(). 108*b1cdbd2cSJim Jagielski @param rArguments 109*b1cdbd2cSJim Jagielski The functor is called with arguments that are children of each 110*b1cdbd2cSJim Jagielski element of the container. The set of children is specified this 111*b1cdbd2cSJim Jagielski list. 112*b1cdbd2cSJim Jagielski @param rFunctor 113*b1cdbd2cSJim Jagielski The functor to be executed for some or all of the elements in 114*b1cdbd2cSJim Jagielski the given container. 115*b1cdbd2cSJim Jagielski */ 116*b1cdbd2cSJim Jagielski static void ForAll ( 117*b1cdbd2cSJim Jagielski const css::uno::Reference<css::container::XNameAccess>& rxContainer, 118*b1cdbd2cSJim Jagielski const ::std::vector<rtl::OUString>& rArguments, 119*b1cdbd2cSJim Jagielski const Functor& rFunctor); 120*b1cdbd2cSJim Jagielski 121*b1cdbd2cSJim Jagielski /** Fill a list with the string contents of all sub-elements in the given container. 122*b1cdbd2cSJim Jagielski @param rxContainer 123*b1cdbd2cSJim Jagielski The container is a XNameAccess to a list of the configuration. 124*b1cdbd2cSJim Jagielski This can be a node returned by GetConfigurationNode(). 125*b1cdbd2cSJim Jagielski @param rsArgument 126*b1cdbd2cSJim Jagielski This specifies which string children of the elements in the 127*b1cdbd2cSJim Jagielski container are to be inserted into the list. The specified child 128*b1cdbd2cSJim Jagielski has to be of type string. 129*b1cdbd2cSJim Jagielski @param rList 130*b1cdbd2cSJim Jagielski The list to be filled. 131*b1cdbd2cSJim Jagielski */ 132*b1cdbd2cSJim Jagielski static void FillList( 133*b1cdbd2cSJim Jagielski const css::uno::Reference<css::container::XNameAccess>& rxContainer, 134*b1cdbd2cSJim Jagielski const ::rtl::OUString& rsArgument, 135*b1cdbd2cSJim Jagielski ::std::vector<rtl::OUString>& rList); 136*b1cdbd2cSJim Jagielski 137*b1cdbd2cSJim Jagielski private: 138*b1cdbd2cSJim Jagielski css::uno::Reference<css::uno::XInterface> mxRoot; 139*b1cdbd2cSJim Jagielski 140*b1cdbd2cSJim Jagielski void Initialize ( 141*b1cdbd2cSJim Jagielski const css::uno::Reference<css::lang::XMultiServiceFactory>& rxProvider, 142*b1cdbd2cSJim Jagielski const ::rtl::OUString& rsRootName, 143*b1cdbd2cSJim Jagielski const WriteMode eMode); 144*b1cdbd2cSJim Jagielski }; 145*b1cdbd2cSJim Jagielski 146*b1cdbd2cSJim Jagielski } } // end of namespace sd::tools 147*b1cdbd2cSJim Jagielski 148*b1cdbd2cSJim Jagielski #endif 149