files/fr/fuel/preferencebranch/index.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

---
title: PreferenceBranch
slug: FUEL/PreferenceBranch
tags:
  - FUEL
  - Interfaces
  - Référence_de_l'API_XPCOM
  - 'XPCOM:Références'
translation_of: Mozilla/Tech/Toolkit_API/extIPreferenceBranch
---
<p>

</p><p><br>
</p>
<h2 id="Synoptique" name="Synoptique">Synoptique</h2>
<table class="standard-table"> <tbody><tr>
<td> <code>boolean <a href="#has.28.29">has</a>(in <i>AString</i> <i>aName</i>)</code>
</td></tr>
<tr>
<td> <code>fuelIPreference <a href="#get.28.29">get</a>(in <i>AString</i> <i>aName</i>)</code>
</td></tr>
<tr>
<td> <code>nsIVariant <a href="#getValue.28.29">getValue</a>(in <i>AString</i> <i>aName</i>, in <i>nsIVariant</i> <i>aDefaultValue</i>)</code>
</td></tr>
<tr>
<td> <code>void <a href="#setValue.28.29">setValue</a>(in <i>AString</i> <i>aName</i>, in <i>nsIVariant</i> <i>aValue</i>)</code>
</td></tr>
<tr>
<td> <code>void <a href="#reset.28.29">reset</a>()</code>
</td></tr>
</tbody></table>
<h2 id="Attributs" name="Attributs">Attributs</h2>
<table class="standard-table"> <tbody><tr>
<td class="header">Attribut
</td><td class="header">Type
</td><td class="header">Description
</td></tr>
<tr>
<td><code>root</code>
</td><td><code>attribut <i>AString</i> en lecture seule</code>
</td><td>Le nom de la branche racine.
</td></tr>
<tr>
<td><code>all</code>
</td><td><code>attribut <i>nsIVariant</i> en lecture seule</code>
</td><td>Un tableau de <i>fuelIPreference</i> listant toutes les préférences de la branche.
</td></tr>
<tr>
<td><code>events</code>
</td><td><code>attribut <i>fuelIEvents</i> en lecture seule</code>
</td><td>Les objets <a href="fr/FUEL/Events">événements</a> pour les préférences. Accepte la valeur : <code>change</code>
</td></tr>
</tbody></table>
<h2 id="M.C3.A9thodes" name="M.C3.A9thodes">Méthodes</h2>
<h3 id="has.28.29" name="has.28.29">has()</h3>
<p>Vérifie l'existence d'une préférence.
</p>
<pre class="eval">boolean has(in <i>AString</i> <i>aName</i>)
</pre>
<h6 id="Param.C3.A8tres" name="Param.C3.A8tres">Paramètres</h6>
<dl><dt>&lt;tt&gt;aName&lt;/tt&gt;
</dt><dd>Le nom de la préférence
</dd></dl>
<h6 id="Valeur_retourn.C3.A9e" name="Valeur_retourn.C3.A9e">Valeur retournée</h6>
<p><code>true</code> si la préférence existe, <code>false</code> dans le cas contraire
</p>
<h3 id="get.28.29" name="get.28.29">get()</h3>
<p>Récupère un objet représentant une préférence.
</p>
<pre class="eval">fuelIPreference get(in <i>AString</i> <i>aName</i>)
</pre>
<h6 id="Param.C3.A8tres_2" name="Param.C3.A8tres_2">Paramètres</h6>
<dl><dt>&lt;tt&gt;aName&lt;/tt&gt;
</dt><dd>Le nom de la préférence
</dd></dl>
<h6 id="Valeur_retourn.C3.A9e_2" name="Valeur_retourn.C3.A9e_2">Valeur retournée</h6>
<p>Un objet <a href="fr/FUEL/Preference">préférence</a>, ou vide si la préférence n'existe pas
</p>
<h3 id="getValue.28.29" name="getValue.28.29">getValue()</h3>
<p>Récupère la valeur d'une préférence. Retourne une valeur par défaut si la préférence n'existe pas.
</p>
<pre class="eval">nsIVariant getValue(in <i>AString</i> <i>aName</i>, in <i>nsIVariant</i> <i>aDefaultValue</i>)
</pre>
<h6 id="Param.C3.A8tres_3" name="Param.C3.A8tres_3">Paramètres</h6>
<dl><dt>&lt;tt&gt;aName&lt;/tt&gt;
</dt><dd>Le nom de la préférence
</dd></dl>
<h6 id="Valeur_retourn.C3.A9e_3" name="Valeur_retourn.C3.A9e_3">Valeur retournée</h6>
<p>La valeur de la préférence ou la valeur par défaut donnée si la préférence n'existe pas.
</p>
<h3 id="setValue.28.29" name="setValue.28.29">setValue()</h3>
<p>Définit la valeur d'un élément de stockage avec le nom donné.
</p>
<pre class="eval">void setValue(in <i>AString</i> <i>aName</i>, in <i>nsIVariant</i> <i>aValue</i>)
</pre>
<h6 id="Param.C3.A8tres_4" name="Param.C3.A8tres_4">Paramètres</h6>
<dl><dt>&lt;tt&gt;aName&lt;/tt&gt;
</dt><dd>Le nom d'un élément
</dd></dl>
<h6 id="Valeur_retourn.C3.A9e_4" name="Valeur_retourn.C3.A9e_4">Valeur retournée</h6>
<h3 id="reset.28.29" name="reset.28.29">reset()</h3>
<p>Réinitialise toutes les préférences à leur valeur par défaut.
</p>
<pre class="eval">void reset()
</pre>
<h6 id="Param.C3.A8tres_5" name="Param.C3.A8tres_5">Paramètres</h6>
<h6 id="Valeur_retourn.C3.A9e_5" name="Valeur_retourn.C3.A9e_5">Valeur retournée</h6>
<h2 id="Voir_.C3.A9galement" name="Voir_.C3.A9galement">Voir également</h2>
<p><br>
</p>
<div class="noinclude">
</div>