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

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