PageRenderTime 16ms CodeModel.GetById 13ms RepoModel.GetById 0ms app.codeStats 0ms

/gecko_sdk/idl/nsIPrefLocalizedString.idl

http://firefox-mac-pdf.googlecode.com/
IDL | 104 lines | 20 code | 9 blank | 75 comment | 0 complexity | 3ad8070b3f2bc14100c3fc189318127a MD5 | raw file
  1. /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3. * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4. *
  5. * The contents of this file are subject to the Mozilla Public License Version
  6. * 1.1 (the "License"); you may not use this file except in compliance with
  7. * the License. You may obtain a copy of the License at
  8. * http://www.mozilla.org/MPL/
  9. *
  10. * Software distributed under the License is distributed on an "AS IS" basis,
  11. * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12. * for the specific language governing rights and limitations under the
  13. * License.
  14. *
  15. * The Original Code is Mozilla Communicator client code.
  16. *
  17. * The Initial Developer of the Original Code is
  18. * Netscape Communications Corporation.
  19. * Portions created by the Initial Developer are Copyright (C) 1998
  20. * the Initial Developer. All Rights Reserved.
  21. *
  22. * Contributor(s):
  23. * Alec Flett <alecf@netscape.com>
  24. * Brian Nesse <bnesse@netscape.com>
  25. *
  26. * Alternatively, the contents of this file may be used under the terms of
  27. * either the GNU General Public License Version 2 or later (the "GPL"), or
  28. * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29. * in which case the provisions of the GPL or the LGPL are applicable instead
  30. * of those above. If you wish to allow use of your version of this file only
  31. * under the terms of either the GPL or the LGPL, and not to allow others to
  32. * use your version of this file under the terms of the MPL, indicate your
  33. * decision by deleting the provisions above and replace them with the notice
  34. * and other provisions required by the GPL or the LGPL. If you do not delete
  35. * the provisions above, a recipient may use your version of this file under
  36. * the terms of any one of the MPL, the GPL or the LGPL.
  37. *
  38. * ***** END LICENSE BLOCK ***** */
  39. #include "nsISupports.idl"
  40. /**
  41. * The nsIPrefLocalizedString interface is simply a wrapper interface for
  42. * nsISupportsString so the preferences service can have a unique identifier
  43. * to distinguish between requests for normal wide strings (nsISupportsString)
  44. * and "localized" wide strings, which get their default values from properites
  45. * files.
  46. *
  47. * @see nsIPrefBranch
  48. * @see nsISupportsString
  49. *
  50. * @status FROZEN
  51. */
  52. [scriptable, uuid(ae419e24-1dd1-11b2-b39a-d3e5e7073802)]
  53. interface nsIPrefLocalizedString : nsISupports
  54. {
  55. /**
  56. * Provides access to string data stored in this property.
  57. *
  58. * @return NS_OK The operation succeeded.
  59. * @return Other An error occured.
  60. */
  61. attribute wstring data;
  62. /**
  63. * Used to retrieve the contents of this object into a wide string.
  64. *
  65. * @return wstring The string containing the data stored within this object.
  66. */
  67. wstring toString();
  68. /**
  69. * Used to set the contents of this object.
  70. *
  71. * @param length The length of the string. This value should not include
  72. * space for the null terminator, nor should it account for the
  73. * size of a character. It should only be the number of
  74. * characters for which there is space in the string.
  75. * @param data The string data to be stored.
  76. *
  77. * @note
  78. * This makes a copy of the string argument passed in.
  79. *
  80. * @return NS_OK The data was successfully stored.
  81. */
  82. void setDataWithLength(in unsigned long length,
  83. [size_is(length)] in wstring data);
  84. };
  85. %{C++
  86. #define NS_PREFLOCALIZEDSTRING_CID \
  87. { /* {064d9cee-1dd2-11b2-83e3-d25ab0193c26} */ \
  88. 0x064d9cee, \
  89. 0x1dd2, \
  90. 0x11b2, \
  91. { 0x83, 0xe3, 0xd2, 0x5a, 0xb0, 0x19, 0x3c, 0x26 } \
  92. }
  93. #define NS_PREFLOCALIZEDSTRING_CONTRACTID "@mozilla.org/pref-localizedstring;1"
  94. #define NS_PREFLOCALIZEDSTRING_CLASSNAME "Pref LocalizedString"
  95. %}