setup_native/source/win32/customactions/reg4msdoc/registrywnt.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef _REGISTRYWNT_HXX_
  30 #define _REGISTRYWNT_HXX_
  31
  32 #include "registry.hxx"
  33
  34 //---------------------------------------
  35 // constants
  36 //---------------------------------------
  37
  38 class RegistryKeyImplWinNT : public RegistryKeyImpl
  39 {
  40 public:
  41
  42     //############################################
  43     // Queries
  44     //############################################
  45
  46     /** The number of sub values of the key at hand
  47
  48         @precond IsOpen = true
  49
  50         @throws
  51     */
  52     virtual size_t GetSubValueCount() const;
  53
  54     /** The number of sub-keys of the key at hand
  55
  56         @precond IsOpen = true
  57
  58         @throws
  59     */
  60     virtual size_t GetSubKeyCount() const;
  61
  62     virtual StringListPtr GetSubKeyNames() const;
  63
  64     virtual StringListPtr GetSubValueNames() const;
  65
  66     /** Get the specified registry value
  67
  68         @precond IsOpen = true
  69     */
  70     virtual RegistryValue GetValue(const std::wstring& Name) const;
  71
  72     /** Get the specified registry value, return the given
  73         default value if value not found
  74
  75         @precond IsOpen = true
  76     */
  77     virtual RegistryValue GetValue(const std::wstring& Name, const RegistryValue& Default) const;
  78
  79     //############################################
  80     // Commands
  81     //############################################
  82
  83     /** Open the registry key, has no effect if
  84         the key is already open
  85
  86         @precond IsOpen = false
  87
  88         @throws RegistryWriteAccessDenyException
  89                 RegistryAccessDenyException
  90     */
  91     virtual void Open(bool Writeable = true);
  92
  93     /** Open the specified sub-key of the registry key
  94         at hand
  95
  96         @precond IsOpen = true
  97                  HasSubKey(Name) = true
  98
  99         @throws RegistryIOException
 100                 RegistryKeyNotFoundException
 101                 RegistryAccessDeniedException
 102     */
 103     virtual RegistryKey OpenSubKey(const std::wstring& Name, bool Writeable = true);
 104
 105     /** Creates a new sub-key below the key at hand
 106
 107         @precond IsOpen = true
 108                  IsWriteable = true
 109
 110         @throws  RegistryIOException
 111                  RegistryWriteAccessDenyException
 112     */
 113     virtual RegistryKey CreateSubKey(const std::wstring& Name);
 114
 115     /** Deletes a sub-key below the key at hand, the
 116         key must not have sub-keys
 117
 118         @precond IsOpen = true
 119                  IsWriteable = true
 120
 121         @throws  RegistryIOException
 122                  RegistryWriteAccessDenyException
 123     */
 124     virtual void DeleteSubKey(const std::wstring& Name);
 125
 126     /** Deletes a sub-key below the key at hand with all
 127         its sub-keys
 128
 129         @precond IsOpen = true
 130                  IsWriteable = true;
 131
 132         @throws  RegistryIOException
 133                  RegistryWriteAccessDenyException
 134     */
 135     virtual void DeleteSubKeyTree(const std::wstring& Name);
 136
 137     /** Delete the specified value
 138
 139         @precond IsOpen = true
 140                  IsWriteable = true
 141                  HasValue(Name) = true
 142
 143         @throws RegistryIOException
 144                 RegistryWriteAccessDeniedException
 145                 RegistryValueNotFoundException
 146     */
 147     virtual void DeleteValue(const std::wstring& Name);
 148
 149     /** Set the specified registry value
 150
 151         @precond IsOpen = true
 152                  IsWriteable = true
 153
 154         @throws  RegistryIOException
 155                  RegistryWriteAccessDenyException
 156     */
 157     virtual void SetValue(const RegistryValue& Value);
 158
 159     //############################################
 160     // Creation
 161     //
 162     // only possible through WindowsRegistry class
 163     //############################################
 164
 165 protected:
 166     /** Create instance and open the specified Registry key
 167
 168         @throws  RegistryWriteAccessDenyException
 169                  RegistryAccessDenyException
 170                  RegistryKeyNotFoundException
 171     */
 172     RegistryKeyImplWinNT(HKEY RootKey, const std::wstring& KeyName);
 173
 174     /** Create instance and open the specified Registry key
 175
 176         @throws  RegistryWriteAccessDenyException
 177                  RegistryAccessDenyException
 178                  RegistryKeyNotFoundException
 179     */
 180     RegistryKeyImplWinNT(HKEY RootKey);
 181
 182     /** Create an instances of the specified Registry key,
 183     the key is assumed to be already opened.
 184     */
 185     RegistryKeyImplWinNT(HKEY RootKey, HKEY SubKey, const std::wstring& KeyName, bool Writeable = true);
 186
 187 private:
 188
 189     LONG ImplDeleteSubKeyTree(HKEY RootKey, const std::wstring& Name);
 190
 191 //prevent copy and assignment
 192 private:
 193     RegistryKeyImplWinNT(const RegistryKeyImplWinNT&);
 194     RegistryKeyImplWinNT& operator=(const RegistryKeyImplWinNT&);
 195
 196 //######################################
 197 // Friend declarations
 198 //######################################
 199
 200 friend class WindowsRegistry;
 201 };
 202
 203 #endif
 204
 205 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */