← Back to branch summary

~ubuntu-branches/ubuntu/precise/kompozer/precise

« back to all changes in this revision

Viewing changes to mozilla/xpcom/ds/nsIPersistentProperties2.idl

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Yarusso
  • Date: 2007-08-27 01:11:03 UTC
  • Revision ID: james.westby@ubuntu.com-20070827011103-2jgf4s6532gqu2ka
Tags: upstream-0.7.10
Import upstream version 0.7.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
mozilla/xpcom/ds/nsIPersistentProperties2.idl
 
1
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 
2
/* ***** BEGIN LICENSE BLOCK *****
 
3
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 
4
 *
 
5
 * The contents of this file are subject to the Netscape Public License
 
6
 * Version 1.1 (the "License"); you may not use this file except in
 
7
 * compliance with the License. You may obtain a copy of the License at
 
8
 * http://www.mozilla.org/NPL/
 
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.org 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
 *
 
24
 * Alternatively, the contents of this file may be used under the terms of
 
25
 * either the GNU General Public License Version 2 or later (the "GPL"), or 
 
26
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 
27
 * in which case the provisions of the GPL or the LGPL are applicable instead
 
28
 * of those above. If you wish to allow use of your version of this file only
 
29
 * under the terms of either the GPL or the LGPL, and not to allow others to
 
30
 * use your version of this file under the terms of the NPL, indicate your
 
31
 * decision by deleting the provisions above and replace them with the notice
 
32
 * and other provisions required by the GPL or the LGPL. If you do not delete
 
33
 * the provisions above, a recipient may use your version of this file under
 
34
 * the terms of any one of the NPL, the GPL or the LGPL.
 
35
 *
 
36
 * ***** END LICENSE BLOCK ***** */
 
37
 
 
38
#include "nsISupports.idl"
 
39
#include "nsIProperties.idl"
 
40
#include "nsISimpleEnumerator.idl"
 
41
 
 
42
interface nsIInputStream;
 
43
interface nsIOutputStream;
 
44
 
 
45
[scriptable, uuid(283EE646-1AEF-11D4-98B3-00C04fA0CE9A)]
 
46
interface nsIPropertyElement : nsISupports {
 
47
  attribute AUTF8String key;
 
48
  attribute AString value;
 
49
};
 
50
 
 
51
[scriptable, uuid(1A180F60-93B2-11d2-9B8B-00805F8A16D9)]
 
52
interface nsIPersistentProperties : nsIProperties
 
53
{
 
54
  /**
 
55
   * load a set of name/value pairs from the input stream
 
56
   * names and values should be in UTF8
 
57
   */
 
58
  void load(in nsIInputStream input);
 
59
 
 
60
  /**
 
61
   * output the values to the stream - results will be in UTF8
 
62
   */
 
63
  void save(in nsIOutputStream output, in AUTF8String header);
 
64
 
 
65
  /**
 
66
   * call subclass() to make future calls to load() set the properties
 
67
   * in this "superclass" instead
 
68
   */
 
69
  void subclass(in nsIPersistentProperties superclass);
 
70
 
 
71
  /**
 
72
   * get an enumeration of nsIPropertyElement objects,
 
73
   * which are read-only (i.e. setting properties on the element will
 
74
   * not make changes back into the source nsIPersistentProperties
 
75
   */
 
76
  nsISimpleEnumerator enumerate();
 
77
 
 
78
  /**
 
79
   * shortcut to nsIProperty's get() which retrieves a string value
 
80
   * directly (and thus faster)
 
81
   */
 
82
  AString getStringProperty(in AUTF8String key);
 
83
 
 
84
  /**
 
85
   * shortcut to nsIProperty's set() which sets a string value
 
86
   * directly (and thus faster)
 
87
   */
 
88
  AString setStringProperty(in AUTF8String key, in AString value);
 
89
};
 
90
 
 
91
 
 
92
%{C++
 
93
 
 
94
//{283EE645-1AEF-11D4-98B3-00C04fA0CE9A}
 
95
#define NS_IPROPERTYELEMENT_CID \
 
96
{       0x283ee645, 0x1aef, 0x11d4, \
 
97
  { 0x98, 0xb3, 0x0, 0xc0, 0x4f, 0xa0, 0xce, 0x9a } }
 
98
 
 
99
#define NS_IPERSISTENTPROPERTIES_CID \
 
100
{ 0x2245e573, 0x9464, 0x11d2, \
 
101
  { 0x9b, 0x8b, 0x0, 0x80, 0x5f, 0x8a, 0x16, 0xd9 } }
 
102
 
 
103
#define NS_PERSISTENTPROPERTIES_CONTRACTID "@mozilla.org/persistent-properties;1"
 
104
#define NS_PERSISTENTPROPERTIES_CLASSNAME "Persistent Properties"
 
105
 
 
106
%}
 
107