~n-muench/+junk/cssutils : revision 5

1

2

3

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

4

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

5

6

7

<head>

8

9

10

<title>Package cssutils.css — cssutils v0.9.7b4 documentation</title>

11

12

13

14

var DOCUMENTATION_OPTIONS = {

15

URL_ROOT: '../',

16

VERSION: '0.9.7b4',

17

COLLAPSE_INDEX: false,

18

FILE_SUFFIX: '.html',

19

HAS_SOURCE: true

20

};

21

</script>

22

23

24

25

26

27

28

</head>

29

<body>

30

31

<h3>Navigation</h3>

32

<ul>

33

34

<a href="../genindex.html" title="General Index"

35

accesskey="I">index</a></li>

36

37

<a href="../py-modindex.html" title="Python Module Index"

38

>modules</a> |</li>

39

40

<a href="stylesheets.html" title="Package cssutils.stylesheets"

41

accesskey="N">next</a> |</li>

42

43

<a href="serialize.html" title="serializing CSS"

44

accesskey="P">previous</a> |</li>

45

<li><a href="../index.html">cssutils v0.9.7b4 documentation</a> »</li>

46

</ul>

47

</div>

48

49

50

51

52

53

54

55

<h1>Package <tt class="docutils literal">cssutils.css</tt><a class="headerlink" href="#module-cssutils.css" title="Permalink to this headline">¶</a></h1>

56

Classes implementing <a class="reference external" href="http://www.w3.org/TR/DOM-Level-2-Style/css.html">DOM Level 2 CSS</a> and <a class="reference external" href="http://www.w3.org/TR/css3-namespace/">CSS Module: Namespaces (W3C Working Draft 28 August 2006)</a>

57

58

<h2><tt class="docutils literal">CSSStyleSheet</tt><a class="headerlink" href="#cssstylesheet" title="Permalink to this headline">¶</a></h2>

59

A CSSStyleSheet contains all rules. It consists of the different CSS rules like <a class="reference internal" href="#cssutils.css.CSSImportRule" title="cssutils.css.CSSImportRule"><tt class="xref py py-class docutils literal">CSSImportRule</tt></a>, <a class="reference internal" href="#cssutils.css.CSSStyleRule" title="cssutils.css.CSSStyleRule"><tt class="xref py py-class docutils literal">CSSStyleRule</tt></a> etc. It also defines the encoding of the style sheet used for serialization. The encoding might by set with an <a class="reference internal" href="#cssutils.css.CSSCharsetRule" title="cssutils.css.CSSCharsetRule"><tt class="xref py py-class docutils literal">CSSCharsetRule</tt></a> rule or simpler with the <a class="reference internal" href="#cssutils.css.CSSStyleSheet.encoding" title="cssutils.css.CSSStyleSheet.encoding"><tt class="xref py py-attr docutils literal">encoding</tt></a> attribute. The serialized sheet may be obtained from <a class="reference internal" href="#cssutils.css.CSSStyleSheet.cssText" title="cssutils.css.CSSStyleSheet.cssText"><tt class="xref py py-attr docutils literal">cssText</tt></a>. All rules are present in <tt class="xref py py-attr docutils literal">cssRules</tt>, a stylesheet iterates on its rules so this might be easier. Namespaces are available via <a class="reference internal" href="#cssutils.css.CSSStyleSheet.namespaces" title="cssutils.css.CSSStyleSheet.namespaces"><tt class="xref py py-attr docutils literal">namespaces</tt></a> (do not rely on prefixes, see <a class="reference external" href="http://www.w3.org/TR/REC-xml-names/">http://www.w3.org/TR/REC-xml-names/</a> how these work). Variables are available via <a class="reference internal" href="#cssutils.css.CSSStyleSheet.variables" title="cssutils.css.CSSStyleSheet.variables"><tt class="xref py py-attr docutils literal">variables</tt></a> which is a <a class="reference internal" href="#cssutils.css.CSSVariablesDeclaration" title="cssutils.css.CSSVariablesDeclaration"><tt class="xref py py-class docutils literal">CSSVariablesDeclaration</tt></a> and contains all available variables including the ones defined in imported style sheets. Changes to this object do NOT change the parent sheet!

60

61

62

class <tt class="descclassname">cssutils.css.</tt><tt class="descname">CSSStyleSheet</tt><big>(</big>href=None, media=None, title=u'', disabled=None, ownerNode=None, parentStyleSheet=None, readonly=False, ownerRule=None<big>)</big><a class="headerlink" href="#cssutils.css.CSSStyleSheet" title="Permalink to this definition">¶</a></dt>

63

<dd>CSSStyleSheet represents a CSS style sheet.

64

Format:

65

<div class="highlight-python"><pre>stylesheet

66

: [ CHARSET_SYM S* STRING S* ';' ]?

67

[S|CDO|CDC]* [ import [S|CDO|CDC]* ]*

68

[ namespace [S|CDO|CDC]* ]* # according to @namespace WD

69

[ [ ruleset | media | page ] [S|CDO|CDC]* ]*</pre>

70

</div>

71

72

<dt><tt class="docutils literal">cssRules</tt></dt>

73

<dd>All Rules in this style sheet, a <a class="reference internal" href="#cssutils.css.CSSRuleList" title="cssutils.css.CSSRuleList"><tt class="xref py py-class docutils literal">CSSRuleList</tt></a>.</dd>

74

</dl>

75

76

77

78

<dd>Add <cite>rule</cite> to style sheet at appropriate position.

79

Same as <tt class="docutils literal">insertRule(rule, inOrder=True)</tt>.

80

</dd></dl>

81

82

83

84

<tt class="descname">alternate</tt><a class="headerlink" href="#cssutils.css.CSSStyleSheet.alternate" title="Permalink to this definition">¶</a></dt>

85

<dd>Not used in cssutils yet.

86

</dd></dl>

87

88

89

90

<tt class="descname">cssText</tt><a class="headerlink" href="#cssutils.css.CSSStyleSheet.cssText" title="Permalink to this definition">¶</a></dt>

91

<dd>Textual representation of the stylesheet (a byte string).

92

</dd></dl>

93

94

95

96

<tt class="descname">deleteRule</tt><big>(</big>index<big>)</big><a class="headerlink" href="#cssutils.css.CSSStyleSheet.deleteRule" title="Permalink to this definition">¶</a></dt>

97

<dd>Delete rule at <cite>index</cite> from the style sheet.

98

99

100

101

102

<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

103

<li>index – The <cite>index</cite> of the rule to be removed from the StyleSheet’s rule

104

list. For an <cite>index</cite> < 0 no <a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.IndexSizeErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">IndexSizeErr</tt></a> is

105

raised but rules for normal Python lists are used. E.g.

106

<tt class="docutils literal">deleteRule(-1)</tt> removes the last rule in cssRules.

107

<cite>index</cite> may also be a CSSRule object which will then be removed

108

from the StyleSheet.

109

</li>

110

</ul>

111

</td>

112

</tr>

113

<tr class="field"><th class="field-name">Exceptions :</th><td class="field-body"><ul class="first last simple">

114

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.IndexSizeErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">IndexSizeErr</tt></a>:

115

Raised if the specified index does not correspond to a rule in

116

the style sheet’s rule list.</li>

117

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.NamespaceErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">NamespaceErr</tt></a>:

118

Raised if removing this rule would result in an invalid StyleSheet</li>

119

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.NoModificationAllowedErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">NoModificationAllowedErr</tt></a>:

120

Raised if this style sheet is readonly.</li>

121

</ul>

122

</td>

123

</tr>

124

</tbody>

125

</table>

126

</dd></dl>

127

128

129

130

<tt class="descname">encoding</tt><a class="headerlink" href="#cssutils.css.CSSStyleSheet.encoding" title="Permalink to this definition">¶</a></dt>

131

<dd>Encoding set in <a class="reference internal" href="#cssutils.css.CSSCharsetRule" title="cssutils.css.CSSCharsetRule"><tt class="xref py py-class docutils literal">CSSCharsetRule</tt></a> or if <tt class="xref docutils literal">None</tt>

132

resulting in default <tt class="docutils literal">utf-8</tt> encoding being used.

133

</dd></dl>

134

135

136

137

138

<dd>If the style sheet is a linked style sheet, the value of this attribute is its location. For inline style sheets, the value of this attribute is None. See the href attribute definition for the LINK element in HTML 4.0, and the href pseudo-attribute for the XML style sheet processing instruction.

139

</dd></dl>

140

141

142

143

<tt class="descname">insertRule</tt><big>(</big>rule, index=None, inOrder=False, _clean=True<big>)</big><a class="headerlink" href="#cssutils.css.CSSStyleSheet.insertRule" title="Permalink to this definition">¶</a></dt>

144

<dd>Used to insert a new rule into the style sheet. The new rule now

145

becomes part of the cascade.

146

147

148

149

150

<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

151

<li>rule – a parsable DOMString, in cssutils also a

152

<a class="reference internal" href="#cssutils.css.CSSRule" title="cssutils.css.CSSRule"><tt class="xref py py-class docutils literal">CSSRule</tt></a> or <a class="reference internal" href="#cssutils.css.CSSRuleList" title="cssutils.css.CSSRuleList"><tt class="xref py py-class docutils literal">CSSRuleList</tt></a></li>

153

<li>index – of the rule before the new rule will be inserted.

154

If the specified <cite>index</cite> is equal to the length of the

155

StyleSheet’s rule collection, the rule will be added to the end

156

of the style sheet.

157

If <cite>index</cite> is not given or <tt class="xref docutils literal">None</tt> rule will be appended to rule

158

list.</li>

159

<li>inOrder – if <tt class="xref docutils literal">True</tt> the rule will be put to a proper location while

160

ignoring <cite>index</cite> and without raising

161

<a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.HierarchyRequestErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">HierarchyRequestErr</tt></a>.

162

The resulting index is returned nevertheless.</li>

163

</ul>

164

</td>

165

</tr>

166

<tr class="field"><th class="field-name">Returns:</th><td class="field-body">The index within the style sheet’s rule collection

167

</td>

168

</tr>

169

<tr class="field"><th class="field-name">Exceptions :</th><td class="field-body"><ul class="first last simple">

170

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.HierarchyRequestErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">HierarchyRequestErr</tt></a>:

171

Raised if the rule cannot be inserted at the specified <cite>index</cite>

172

e.g. if an @import rule is inserted after a standard rule set

173

or other at-rule.</li>

174

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.IndexSizeErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">IndexSizeErr</tt></a>:

175

Raised if the specified <cite>index</cite> is not a valid insertion point.</li>

176

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.NoModificationAllowedErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">NoModificationAllowedErr</tt></a>:

177

Raised if this style sheet is readonly.</li>

178

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.SyntaxErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">SyntaxErr</tt></a>:

179

Raised if the specified rule has a syntax error and is

180

unparsable.</li>

181

</ul>

182

</td>

183

</tr>

184

</tbody>

185

</table>

186

</dd></dl>

187

188

189

190

<tt class="descname">namespaces</tt><a class="headerlink" href="#cssutils.css.CSSStyleSheet.namespaces" title="Permalink to this definition">¶</a></dt>

191

<dd>All Namespaces used in this CSSStyleSheet.

192

</dd></dl>

193

194

195

196

<tt class="descname">ownerNode</tt><a class="headerlink" href="#cssutils.css.CSSStyleSheet.ownerNode" title="Permalink to this definition">¶</a></dt>

197

<dd>Not used in cssutils yet.

198

</dd></dl>

199

200

201

202

<tt class="descname">ownerRule</tt><a class="headerlink" href="#cssutils.css.CSSStyleSheet.ownerRule" title="Permalink to this definition">¶</a></dt>

203

<dd>A ref to an @import rule if it is imported, else <tt class="xref docutils literal">None</tt>.

204

</dd></dl>

205

206

207

208

<tt class="descname">parentStyleSheet</tt><a class="headerlink" href="#cssutils.css.CSSStyleSheet.parentStyleSheet" title="Permalink to this definition">¶</a></dt>

209

<dd>For style sheet languages that support the concept of style sheet inclusion, this attribute represents the including style sheet, if one exists. If the style sheet is a top-level style sheet, or the style sheet language does not support inclusion, the value of this attribute is None.

210

</dd></dl>

211

212

213

214

215

<dd>Internal readonly attribute, DO NOT USE!

216

</dd></dl>

217

218

219

220

<tt class="descname">setSerializer</tt><big>(</big>*args, **kwargs<big>)</big><a class="headerlink" href="#cssutils.css.CSSStyleSheet.setSerializer" title="Permalink to this definition">¶</a></dt>

221

<dd>Set the cssutils global Serializer used for all output.

222

</dd></dl>

223

224

225

226

<tt class="descname">setSerializerPref</tt><big>(</big>*args, **kwargs<big>)</big><a class="headerlink" href="#cssutils.css.CSSStyleSheet.setSerializerPref" title="Permalink to this definition">¶</a></dt>

227

<dd>Set a Preference of CSSSerializer used for output.

228

See <a class="reference internal" href="serialize.html#cssutils.serialize.Preferences" title="cssutils.serialize.Preferences"><tt class="xref py py-class docutils literal">cssutils.serialize.Preferences</tt></a> for possible

229

preferences to be set.

230

</dd></dl>

231

232

233

234

235

<dd>This specifies the style sheet language for this style sheet. The style sheet language is specified as a content type (e.g. <tt class="docutils literal">text/css</tt>). The content type is often specified in the ownerNode. Also see the type attribute definition for the LINK element in HTML 4.0, and the type pseudo-attribute for the XML style sheet processing instruction. For CSS this is always <tt class="docutils literal">text/css</tt>.

236

</dd></dl>

237

238

239

240

<tt class="descname">variables</tt><a class="headerlink" href="#cssutils.css.CSSStyleSheet.variables" title="Permalink to this definition">¶</a></dt>

241

<dd>A <a class="reference internal" href="#cssutils.css.CSSVariablesDeclaration" title="cssutils.css.CSSVariablesDeclaration"><tt class="xref py py-class docutils literal">cssutils.css.CSSVariablesDeclaration</tt></a> containing all available variables in this CSSStyleSheet including the ones defined in imported sheets.

242

</dd></dl>

243

244

</dd></dl>

245

246

</div>

247

248

<h2>CSS rules<a class="headerlink" href="#css-rules" title="Permalink to this headline">¶</a></h2>

249

250

<h3><tt class="docutils literal">CSSRule</tt><a class="headerlink" href="#cssrule" title="Permalink to this headline">¶</a></h3>

251

252

253

class <tt class="descclassname">cssutils.css.</tt><tt class="descname">CSSRule</tt><big>(</big>parentRule=None, parentStyleSheet=None, readonly=False<big>)</big><a class="headerlink" href="#cssutils.css.CSSRule" title="Permalink to this definition">¶</a></dt>

254

<dd>Abstract base interface for any type of CSS statement. This includes

255

both rule sets and at-rules. An implementation is expected to preserve

256

all rules specified in a CSS style sheet, even if the rule is not

257

recognized by the parser. Unrecognized rules are represented using the

258

<tt class="xref py py-class docutils literal">CSSUnknownRule</tt> interface.

259

260

261

<tt class="descname">CHARSET_RULE</tt><a class="headerlink" href="#cssutils.css.CSSRule.CHARSET_RULE" title="Permalink to this definition">¶</a></dt>

262

<dd><a class="reference internal" href="#cssutils.css.CSSCharsetRule" title="cssutils.css.CSSCharsetRule"><tt class="xref py py-class docutils literal">cssutils.css.CSSCharsetRule</tt></a> (not used in CSSOM anymore)

263

</dd></dl>

264

265

266

267

<tt class="descname">COMMENT</tt><a class="headerlink" href="#cssutils.css.CSSRule.COMMENT" title="Permalink to this definition">¶</a></dt>

268

<dd><a class="reference internal" href="#cssutils.css.CSSComment" title="cssutils.css.CSSComment"><tt class="xref py py-class docutils literal">cssutils.css.CSSComment</tt></a> - not in the offical spec,

269

Value has changed in 0.9.7a3

270

</dd></dl>

271

272

273

274

275

<dd><a class="reference internal" href="#cssutils.css.CSSFontFaceRule" title="cssutils.css.CSSFontFaceRule"><tt class="xref py py-class docutils literal">cssutils.css.CSSFontFaceRule</tt></a>

276

</dd></dl>

277

278

279

280

<tt class="descname">IMPORT_RULE</tt><a class="headerlink" href="#cssutils.css.CSSRule.IMPORT_RULE" title="Permalink to this definition">¶</a></dt>

281

<dd><a class="reference internal" href="#cssutils.css.CSSImportRule" title="cssutils.css.CSSImportRule"><tt class="xref py py-class docutils literal">cssutils.css.CSSImportRule</tt></a>

282

</dd></dl>

283

284

285

286

<tt class="descname">MEDIA_RULE</tt><a class="headerlink" href="#cssutils.css.CSSRule.MEDIA_RULE" title="Permalink to this definition">¶</a></dt>

287

<dd><a class="reference internal" href="#cssutils.css.CSSMediaRule" title="cssutils.css.CSSMediaRule"><tt class="xref py py-class docutils literal">cssutils.css.CSSMediaRule</tt></a>

288

</dd></dl>

289

290

291

292

<tt class="descname">NAMESPACE_RULE</tt><a class="headerlink" href="#cssutils.css.CSSRule.NAMESPACE_RULE" title="Permalink to this definition">¶</a></dt>

293

<dd><a class="reference internal" href="#cssutils.css.CSSNamespaceRule" title="cssutils.css.CSSNamespaceRule"><tt class="xref py py-class docutils literal">cssutils.css.CSSNamespaceRule</tt></a>,

294

Value has changed in 0.9.7a3 due to a change in the CSSOM spec.

295

</dd></dl>

296

297

298

299

300

<dd><a class="reference internal" href="#cssutils.css.CSSPageRule" title="cssutils.css.CSSPageRule"><tt class="xref py py-class docutils literal">cssutils.css.CSSPageRule</tt></a>

301

</dd></dl>

302

303

304

305

<tt class="descname">STYLE_RULE</tt><a class="headerlink" href="#cssutils.css.CSSRule.STYLE_RULE" title="Permalink to this definition">¶</a></dt>

306

<dd><a class="reference internal" href="#cssutils.css.CSSStyleRule" title="cssutils.css.CSSStyleRule"><tt class="xref py py-class docutils literal">cssutils.css.CSSStyleRule</tt></a>

307

</dd></dl>

308

309

310

311

<tt class="descname">UNKNOWN_RULE</tt><a class="headerlink" href="#cssutils.css.CSSRule.UNKNOWN_RULE" title="Permalink to this definition">¶</a></dt>

312

<dd><tt class="xref py py-class docutils literal">cssutils.css.CSSUnknownRule</tt> (not used in CSSOM anymore)

313

</dd></dl>

314

315

316

317

<tt class="descname">VARIABLES_RULE</tt><a class="headerlink" href="#cssutils.css.CSSRule.VARIABLES_RULE" title="Permalink to this definition">¶</a></dt>

318

<dd><a class="reference internal" href="#cssutils.css.CSSVariablesRule" title="cssutils.css.CSSVariablesRule"><tt class="xref py py-class docutils literal">cssutils.css.CSSVariablesRule</tt></a> - experimental rule

319

not in the offical spec

320

</dd></dl>

321

322

323

324

<tt class="descname">atkeyword</tt><a class="headerlink" href="#cssutils.css.CSSRule.atkeyword" title="Permalink to this definition">¶</a></dt>

325

<dd>Literal keyword of an @rule (e.g. <tt class="docutils literal">@IMport</tt>).

326

</dd></dl>

327

328

329

330

<tt class="descname">cssText</tt><a class="headerlink" href="#cssutils.css.CSSRule.cssText" title="Permalink to this definition">¶</a></dt>

331

<dd>(DOM) The parsable textual representation of the rule. This reflects the current state of the rule and not its initial value.

332

</dd></dl>

333

334

335

336

<tt class="descname">parent</tt><a class="headerlink" href="#cssutils.css.CSSRule.parent" title="Permalink to this definition">¶</a></dt>

337

<dd>The Parent Node of this CSSRule or None.

338

</dd></dl>

339

340

341

342

<tt class="descname">parentRule</tt><a class="headerlink" href="#cssutils.css.CSSRule.parentRule" title="Permalink to this definition">¶</a></dt>

343

<dd>If this rule is contained inside another rule (e.g. a style rule inside an @media block), this is the containing rule. If this rule is not nested inside any other rules, this returns None.

344

</dd></dl>

345

346

347

348

<tt class="descname">parentStyleSheet</tt><a class="headerlink" href="#cssutils.css.CSSRule.parentStyleSheet" title="Permalink to this definition">¶</a></dt>

349

<dd>The style sheet that contains this rule.

350

</dd></dl>

351

352

353

354

355

<dd>Internal readonly attribute, DO NOT USE!

356

</dd></dl>

357

358

359

360

361

<dd>The type of this rule, as defined by a CSSRule type constant.

362

</dd></dl>

363

364

365

366

<tt class="descname">typeString</tt><a class="headerlink" href="#cssutils.css.CSSRule.typeString" title="Permalink to this definition">¶</a></dt>

367

<dd>Descriptive name of this rule’s type.

368

</dd></dl>

369

370

371

372

<tt class="descname">wellformed</tt><a class="headerlink" href="#cssutils.css.CSSRule.wellformed" title="Permalink to this definition">¶</a></dt>

373

<dd>If the rule is wellformed.

374

</dd></dl>

375

376

</dd></dl>

377

378

</div>

379

380

<h3><tt class="docutils literal">CSSRuleList</tt><a class="headerlink" href="#cssrulelist" title="Permalink to this headline">¶</a></h3>

381

382

383

class <tt class="descclassname">cssutils.css.</tt><tt class="descname">CSSRuleList</tt><big>(</big>*ignored<big>)</big><a class="headerlink" href="#cssutils.css.CSSRuleList" title="Permalink to this definition">¶</a></dt>

384

<dd>The CSSRuleList object represents an (ordered) list of statements.

385

The items in the CSSRuleList are accessible via an integral index,

386

starting from 0.

387

Subclasses a standard Python list so theoretically all standard list

388

methods are available. Setting methods like <tt class="docutils literal">__init__</tt>, <tt class="docutils literal">append</tt>,

389

<tt class="docutils literal">extend</tt> or <tt class="docutils literal">__setslice__</tt> are added later on instances of this

390

class if so desired.

391

E.g. CSSStyleSheet adds <tt class="docutils literal">append</tt> which is not available in a simple

392

instance of this class!

393

394

395

<tt class="descname">append</tt><big>(</big>*ignored<big>)</big><a class="headerlink" href="#cssutils.css.CSSRuleList.append" title="Permalink to this definition">¶</a></dt>

396

<dd>Implemented in class using a CSSRuleList only.

397

</dd></dl>

398

399

400

401

<tt class="descname">count</tt><a class="headerlink" href="#cssutils.css.CSSRuleList.count" title="Permalink to this definition">¶</a></dt>

402

<dd>L.count(value) -> integer – return number of occurrences of value

403

</dd></dl>

404

405

406

407

<tt class="descname">extend</tt><big>(</big>*ignored<big>)</big><a class="headerlink" href="#cssutils.css.CSSRuleList.extend" title="Permalink to this definition">¶</a></dt>

408

<dd>Implemented in class using a CSSRuleList only.

409

</dd></dl>

410

411

412

413

<tt class="descname">index</tt><a class="headerlink" href="#cssutils.css.CSSRuleList.index" title="Permalink to this definition">¶</a></dt>

414

<dd>L.index(value, [start, [stop]]) -> integer – return first index of value.

415

Raises ValueError if the value is not present.

416

</dd></dl>

417

418

419

420

<tt class="descname">insert</tt><a class="headerlink" href="#cssutils.css.CSSRuleList.insert" title="Permalink to this definition">¶</a></dt>

421

<dd>L.insert(index, object) – insert object before index

422

</dd></dl>

423

424

425

426

<tt class="descname">item</tt><big>(</big>index<big>)</big><a class="headerlink" href="#cssutils.css.CSSRuleList.item" title="Permalink to this definition">¶</a></dt>

427

<dd>(DOM) Retrieve a CSS rule by ordinal <cite>index</cite>. The order in this

428

collection represents the order of the rules in the CSS style

429

sheet. If index is greater than or equal to the number of rules in

430

the list, this returns None.

431

Returns CSSRule, the style rule at the index position in the

432

CSSRuleList, or None if that is not a valid index.

433

</dd></dl>

434

435

436

437

<tt class="descname">length</tt><a class="headerlink" href="#cssutils.css.CSSRuleList.length" title="Permalink to this definition">¶</a></dt>

438

<dd>(DOM) The number of CSSRules in the list.

439

</dd></dl>

440

441

442

443

444

<dd>L.pop([index]) -> item – remove and return item at index (default last).

445

Raises IndexError if list is empty or index is out of range.

446

</dd></dl>

447

448

449

450

<tt class="descname">remove</tt><a class="headerlink" href="#cssutils.css.CSSRuleList.remove" title="Permalink to this definition">¶</a></dt>

451

<dd>L.remove(value) – remove first occurrence of value.

452

Raises ValueError if the value is not present.

453

</dd></dl>

454

455

456

457

<tt class="descname">reverse</tt><a class="headerlink" href="#cssutils.css.CSSRuleList.reverse" title="Permalink to this definition">¶</a></dt>

458

<dd>L.reverse() – reverse IN PLACE

459

</dd></dl>

460

461

462

463

<tt class="descname">rulesOfType</tt><big>(</big>type<big>)</big><a class="headerlink" href="#cssutils.css.CSSRuleList.rulesOfType" title="Permalink to this definition">¶</a></dt>

464

<dd>Yield the rules which have the given <cite>type</cite> only, one of the

465

constants defined in <a class="reference internal" href="#cssutils.css.CSSRule" title="cssutils.css.CSSRule"><tt class="xref py py-class docutils literal">cssutils.css.CSSRule</tt></a>.

466

</dd></dl>

467

468

469

470

471

<dd>L.sort(cmp=None, key=None, reverse=False) – stable sort IN PLACE;

472

cmp(x, y) -> -1, 0, 1

473

</dd></dl>

474

475

</dd></dl>

476

477

</div>

478

479

<h3><tt class="docutils literal">CSSCharsetRule</tt><a class="headerlink" href="#csscharsetrule" title="Permalink to this headline">¶</a></h3>

480

481

482

class <tt class="descclassname">cssutils.css.</tt><tt class="descname">CSSCharsetRule</tt><big>(</big>encoding=None, parentRule=None, parentStyleSheet=None, readonly=False<big>)</big><a class="headerlink" href="#cssutils.css.CSSCharsetRule" title="Permalink to this definition">¶</a></dt>

483

<dd>The CSSCharsetRule interface represents an @charset rule in a CSS style

484

sheet. The value of the encoding attribute does not affect the encoding

485

of text data in the DOM objects; this encoding is always UTF-16

486

(also in Python?). After a stylesheet is loaded, the value of the

487

encoding attribute is the value found in the @charset rule. If there

488

was no @charset in the original document, then no CSSCharsetRule is

489

created. The value of the encoding attribute may also be used as a hint

490

for the encoding used on serialization of the style sheet.

491

The value of the @charset rule (and therefore of the CSSCharsetRule)

492

may not correspond to the encoding the document actually came in;

493

character encoding information e.g. in an HTTP header, has priority

494

(see CSS document representation) but this is not reflected in the

495

CSSCharsetRule.

496

This rule is not really needed anymore as setting

497

<a class="reference internal" href="#cssutils.css.CSSStyleSheet.encoding" title="cssutils.css.CSSStyleSheet.encoding"><tt class="xref py py-attr docutils literal">CSSStyleSheet.encoding</tt></a> is much easier.

498

Format:

499

<div class="highlight-python"><pre>charsetrule:

500

CHARSET_SYM S* STRING S* ';'</pre>

501

</div>

502

BUT: Only valid format is (single space, double quotes!):

503

<div class="highlight-python"><pre>@charset "ENCODING";</pre>

504

</div>

505

506

507

<tt class="descname">atkeyword</tt><a class="headerlink" href="#cssutils.css.CSSCharsetRule.atkeyword" title="Permalink to this definition">¶</a></dt>

508

<dd>Literal keyword of an @rule (e.g. <tt class="docutils literal">@IMport</tt>).

509

</dd></dl>

510

511

512

513

<tt class="descname">cssText</tt><a class="headerlink" href="#cssutils.css.CSSCharsetRule.cssText" title="Permalink to this definition">¶</a></dt>

514

<dd>(DOM) The parsable textual representation.

515

</dd></dl>

516

517

518

519

<tt class="descname">encoding</tt><a class="headerlink" href="#cssutils.css.CSSCharsetRule.encoding" title="Permalink to this definition">¶</a></dt>

520

<dd>(DOM)The encoding information used in this @charset rule.

521

</dd></dl>

522

523

524

525

<tt class="descname">parent</tt><a class="headerlink" href="#cssutils.css.CSSCharsetRule.parent" title="Permalink to this definition">¶</a></dt>

526

<dd>The Parent Node of this CSSRule or None.

527

</dd></dl>

528

529

530

531

<tt class="descname">parentRule</tt><a class="headerlink" href="#cssutils.css.CSSCharsetRule.parentRule" title="Permalink to this definition">¶</a></dt>

532

<dd>If this rule is contained inside another rule (e.g. a style rule inside an @media block), this is the containing rule. If this rule is not nested inside any other rules, this returns None.

533

</dd></dl>

534

535

536

537

<tt class="descname">parentStyleSheet</tt><a class="headerlink" href="#cssutils.css.CSSCharsetRule.parentStyleSheet" title="Permalink to this definition">¶</a></dt>

538

<dd>The style sheet that contains this rule.

539

</dd></dl>

540

541

542

543

544

<dd>Internal readonly attribute, DO NOT USE!

545

</dd></dl>

546

547

548

549

550

<dd>The type of this rule, as defined by a CSSRule type constant.

551

</dd></dl>

552

553

554

555

<tt class="descname">typeString</tt><a class="headerlink" href="#cssutils.css.CSSCharsetRule.typeString" title="Permalink to this definition">¶</a></dt>

556

<dd>Descriptive name of this rule’s type.

557

</dd></dl>

558

559

</dd></dl>

560

561

</div>

562

563

<h3><tt class="docutils literal">CSSFontFaceRule</tt><a class="headerlink" href="#cssfontfacerule" title="Permalink to this headline">¶</a></h3>

564

565

566

class <tt class="descclassname">cssutils.css.</tt><tt class="descname">CSSFontFaceRule</tt><big>(</big>style=None, parentRule=None, parentStyleSheet=None, readonly=False<big>)</big><a class="headerlink" href="#cssutils.css.CSSFontFaceRule" title="Permalink to this definition">¶</a></dt>

567

<dd>The CSSFontFaceRule interface represents a @font-face rule in a CSS

568

style sheet. The @font-face rule is used to hold a set of font

569

descriptions.

570

Format:

571

<div class="highlight-python"><pre>font_face

572

: FONT_FACE_SYM S*

573

'{' S* declaration [ ';' S* declaration ]* '}' S*

574

;</pre>

575

</div>

576

cssutils uses a <a class="reference internal" href="#cssutils.css.CSSStyleDeclaration" title="cssutils.css.CSSStyleDeclaration"><tt class="xref py py-class docutils literal">CSSStyleDeclaration</tt></a> to

577

represent the font descriptions. For validation a specific profile

578

is used though were some properties have other valid values than

579

when used in e.g. a <a class="reference internal" href="#cssutils.css.CSSStyleRule" title="cssutils.css.CSSStyleRule"><tt class="xref py py-class docutils literal">CSSStyleRule</tt></a>.

580

581

582

<tt class="descname">atkeyword</tt><a class="headerlink" href="#cssutils.css.CSSFontFaceRule.atkeyword" title="Permalink to this definition">¶</a></dt>

583

<dd>Literal keyword of an @rule (e.g. <tt class="docutils literal">@IMport</tt>).

584

</dd></dl>

585

586

587

588

<tt class="descname">cssText</tt><a class="headerlink" href="#cssutils.css.CSSFontFaceRule.cssText" title="Permalink to this definition">¶</a></dt>

589

<dd>(DOM) The parsable textual representation of this rule.

590

</dd></dl>

591

592

593

594

<tt class="descname">parent</tt><a class="headerlink" href="#cssutils.css.CSSFontFaceRule.parent" title="Permalink to this definition">¶</a></dt>

595

<dd>The Parent Node of this CSSRule or None.

596

</dd></dl>

597

598

599

600

<tt class="descname">parentRule</tt><a class="headerlink" href="#cssutils.css.CSSFontFaceRule.parentRule" title="Permalink to this definition">¶</a></dt>

601

<dd>If this rule is contained inside another rule (e.g. a style rule inside an @media block), this is the containing rule. If this rule is not nested inside any other rules, this returns None.

602

</dd></dl>

603

604

605

606

<tt class="descname">parentStyleSheet</tt><a class="headerlink" href="#cssutils.css.CSSFontFaceRule.parentStyleSheet" title="Permalink to this definition">¶</a></dt>

607

<dd>The style sheet that contains this rule.

608

</dd></dl>

609

610

611

612

613

<dd>Internal readonly attribute, DO NOT USE!

614

</dd></dl>

615

616

617

618

<tt class="descname">style</tt><a class="headerlink" href="#cssutils.css.CSSFontFaceRule.style" title="Permalink to this definition">¶</a></dt>

619

<dd>(DOM) The declaration-block of this rule set, a <a class="reference internal" href="#cssutils.css.CSSStyleDeclaration" title="cssutils.css.CSSStyleDeclaration"><tt class="xref py py-class docutils literal">CSSStyleDeclaration</tt></a>.

620

</dd></dl>

621

622

623

624

625

<dd>The type of this rule, as defined by a CSSRule type constant.

626

</dd></dl>

627

628

629

630

<tt class="descname">typeString</tt><a class="headerlink" href="#cssutils.css.CSSFontFaceRule.typeString" title="Permalink to this definition">¶</a></dt>

631

<dd>Descriptive name of this rule’s type.

632

</dd></dl>

633

634

635

636

<tt class="descname">valid</tt><a class="headerlink" href="#cssutils.css.CSSFontFaceRule.valid" title="Permalink to this definition">¶</a></dt>

637

<dd>CSSFontFace is valid if properties <cite>font-family</cite> and <cite>src</cite> are set and all properties are valid.

638

</dd></dl>

639

640

</dd></dl>

641

642

</div>

643

644

<h3><tt class="docutils literal">CSSImportRule</tt><a class="headerlink" href="#cssimportrule" title="Permalink to this headline">¶</a></h3>

645

646

647

class <tt class="descclassname">cssutils.css.</tt><tt class="descname">CSSImportRule</tt><big>(</big>href=None, mediaText=None, name=None, parentRule=None, parentStyleSheet=None, readonly=False<big>)</big><a class="headerlink" href="#cssutils.css.CSSImportRule" title="Permalink to this definition">¶</a></dt>

648

<dd>Represents an @import rule within a CSS style sheet. The @import rule

649

is used to import style rules from other style sheets.

650

Format:

651

<div class="highlight-python"><pre>import

652

: IMPORT_SYM S*

653

[STRING|URI] S* [ medium [ COMMA S* medium]* ]? S* STRING? S* ';' S*

654

;</pre>

655

</div>

656

657

658

<tt class="descname">atkeyword</tt><a class="headerlink" href="#cssutils.css.CSSImportRule.atkeyword" title="Permalink to this definition">¶</a></dt>

659

<dd>Literal keyword of an @rule (e.g. <tt class="docutils literal">@IMport</tt>).

660

</dd></dl>

661

662

663

664

<tt class="descname">cssText</tt><a class="headerlink" href="#cssutils.css.CSSImportRule.cssText" title="Permalink to this definition">¶</a></dt>

665

<dd>(DOM) The parsable textual representation of this rule.

666

</dd></dl>

667

668

669

670

671

<dd>Location of the style sheet to be imported.

672

</dd></dl>

673

674

675

676

<tt class="descname">media</tt><a class="headerlink" href="#cssutils.css.CSSImportRule.media" title="Permalink to this definition">¶</a></dt>

677

<dd>(DOM) A list of media types for this rule of type <a class="reference internal" href="stylesheets.html#cssutils.stylesheets.MediaList" title="cssutils.stylesheets.MediaList"><tt class="xref py py-class docutils literal">MediaList</tt></a>.

678

</dd></dl>

679

680

681

682

683

<dd>An optional name for the imported sheet.

684

</dd></dl>

685

686

687

688

<tt class="descname">parent</tt><a class="headerlink" href="#cssutils.css.CSSImportRule.parent" title="Permalink to this definition">¶</a></dt>

689

<dd>The Parent Node of this CSSRule or None.

690

</dd></dl>

691

692

693

694

<tt class="descname">parentRule</tt><a class="headerlink" href="#cssutils.css.CSSImportRule.parentRule" title="Permalink to this definition">¶</a></dt>

695

<dd>If this rule is contained inside another rule (e.g. a style rule inside an @media block), this is the containing rule. If this rule is not nested inside any other rules, this returns None.

696

</dd></dl>

697

698

699

700

<tt class="descname">parentStyleSheet</tt><a class="headerlink" href="#cssutils.css.CSSImportRule.parentStyleSheet" title="Permalink to this definition">¶</a></dt>

701

<dd>The style sheet that contains this rule.

702

</dd></dl>

703

704

705

706

707

<dd>Internal readonly attribute, DO NOT USE!

708

</dd></dl>

709

710

711

712

<tt class="descname">styleSheet</tt><a class="headerlink" href="#cssutils.css.CSSImportRule.styleSheet" title="Permalink to this definition">¶</a></dt>

713

<dd>(readonly) The style sheet referred to by this rule.

714

</dd></dl>

715

716

717

718

719

<dd>The type of this rule, as defined by a CSSRule type constant.

720

</dd></dl>

721

722

723

724

<tt class="descname">typeString</tt><a class="headerlink" href="#cssutils.css.CSSImportRule.typeString" title="Permalink to this definition">¶</a></dt>

725

<dd>Descriptive name of this rule’s type.

726

</dd></dl>

727

728

729

730

<tt class="descname">wellformed</tt><a class="headerlink" href="#cssutils.css.CSSImportRule.wellformed" title="Permalink to this definition">¶</a></dt>

731

<dd>Depending on if media is used at all.

732

</dd></dl>

733

734

</dd></dl>

735

736

</div>

737

738

<h3><tt class="docutils literal">CSSMediaRule</tt><a class="headerlink" href="#cssmediarule" title="Permalink to this headline">¶</a></h3>

739

740

741

class <tt class="descclassname">cssutils.css.</tt><tt class="descname">CSSMediaRule</tt><big>(</big>mediaText='all', name=None, parentRule=None, parentStyleSheet=None, readonly=False<big>)</big><a class="headerlink" href="#cssutils.css.CSSMediaRule" title="Permalink to this definition">¶</a></dt>

742

<dd>Objects implementing the CSSMediaRule interface can be identified by the

743

MEDIA_RULE constant. On these objects the type attribute must return the

744

value of that constant.

745

Format:

746

<div class="highlight-python"><pre>: MEDIA_SYM S* medium [ COMMA S* medium ]*

747

748

STRING? # the name

749

750

LBRACE S* ruleset* '}' S*;</pre>

751

</div>

752

753

<dt><tt class="docutils literal">cssRules</tt></dt>

754

<dd>All Rules in this media rule, a <a class="reference internal" href="#cssutils.css.CSSRuleList" title="cssutils.css.CSSRuleList"><tt class="xref py py-class docutils literal">CSSRuleList</tt></a>.</dd>

755

</dl>

756

757

758

759

<dd>Add <cite>rule</cite> to end of this mediarule.

760

Same as <a class="reference internal" href="#cssutils.css.CSSMediaRule.insertRule" title="cssutils.css.CSSMediaRule.insertRule"><tt class="xref py py-meth docutils literal">insertRule()</tt></a>.

761

</dd></dl>

762

763

764

765

<tt class="descname">atkeyword</tt><a class="headerlink" href="#cssutils.css.CSSMediaRule.atkeyword" title="Permalink to this definition">¶</a></dt>

766

<dd>Literal keyword of an @rule (e.g. <tt class="docutils literal">@IMport</tt>).

767

</dd></dl>

768

769

770

771

<tt class="descname">cssText</tt><a class="headerlink" href="#cssutils.css.CSSMediaRule.cssText" title="Permalink to this definition">¶</a></dt>

772

<dd>(DOM) The parsable textual representation of this rule.

773

</dd></dl>

774

775

776

777

<tt class="descname">deleteRule</tt><big>(</big>index<big>)</big><a class="headerlink" href="#cssutils.css.CSSMediaRule.deleteRule" title="Permalink to this definition">¶</a></dt>

778

<dd>Delete the rule at <cite>index</cite> from the media block.

779

780

781

782

783

<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

784

<li>index – The <cite>index</cite> of the rule to be removed from the media block’s rule

785

list. For an <cite>index</cite> < 0 no <a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.IndexSizeErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">IndexSizeErr</tt></a> is

786

raised but rules for normal Python lists are used. E.g.

787

<tt class="docutils literal">deleteRule(-1)</tt> removes the last rule in cssRules.

788

<cite>index</cite> may also be a CSSRule object which will then be removed

789

from the media block.

790

</li>

791

</ul>

792

</td>

793

</tr>

794

<tr class="field"><th class="field-name">Exceptions :</th><td class="field-body"><ul class="first last simple">

795

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.IndexSizeErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">IndexSizeErr</tt></a>:

796

Raised if the specified index does not correspond to a rule in

797

the media rule list.</li>

798

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.NoModificationAllowedErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">NoModificationAllowedErr</tt></a>:

799

Raised if this media rule is readonly.</li>

800

</ul>

801

</td>

802

</tr>

803

</tbody>

804

</table>

805

</dd></dl>

806

807

808

809

<tt class="descname">insertRule</tt><big>(</big>rule, index=None<big>)</big><a class="headerlink" href="#cssutils.css.CSSMediaRule.insertRule" title="Permalink to this definition">¶</a></dt>

810

<dd>Insert <cite>rule</cite> into the media block.

811

812

813

814

815

<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

816

<li>rule – the parsable text representing the <cite>rule</cite> to be inserted. For rule

817

sets this contains both the selector and the style declaration.

818

For at-rules, this specifies both the at-identifier and the rule

819

content.

820

cssutils also allows rule to be a valid

821

<a class="reference internal" href="#cssutils.css.CSSRule" title="cssutils.css.CSSRule"><tt class="xref py py-class docutils literal">CSSRule</tt></a> object.

822

</li>

823

<li>index – before the specified <cite>rule</cite> will be inserted.

824

If the specified <cite>index</cite> is

825

equal to the length of the media blocks’s rule collection, the

826

rule will be added to the end of the media block.

827

If index is not given or None rule will be appended to rule

828

list.</li>

829

</ul>

830

</td>

831

</tr>

832

<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the index within the media block’s rule collection of the

833

newly inserted rule.

834

</td>

835

</tr>

836

<tr class="field"><th class="field-name">Exceptions :</th><td class="field-body"><ul class="first last simple">

837

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.HierarchyRequestErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">HierarchyRequestErr</tt></a>:

838

Raised if the <cite>rule</cite> cannot be inserted at the specified <cite>index</cite>,

839

e.g., if an @import rule is inserted after a standard rule set

840

or other at-rule.</li>

841

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.IndexSizeErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">IndexSizeErr</tt></a>:

842

Raised if the specified <cite>index</cite> is not a valid insertion point.</li>

843

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.NoModificationAllowedErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">NoModificationAllowedErr</tt></a>:

844

Raised if this media rule is readonly.</li>

845

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.SyntaxErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">SyntaxErr</tt></a>:

846

Raised if the specified <cite>rule</cite> has a syntax error and is

847

unparsable.</li>

848

</ul>

849

</td>

850

</tr>

851

</tbody>

852

</table>

853

</dd></dl>

854

855

856

857

<tt class="descname">media</tt><a class="headerlink" href="#cssutils.css.CSSMediaRule.media" title="Permalink to this definition">¶</a></dt>

858

<dd>(DOM) A list of media types for this rule of type <a class="reference internal" href="stylesheets.html#cssutils.stylesheets.MediaList" title="cssutils.stylesheets.MediaList"><tt class="xref py py-class docutils literal">MediaList</tt></a>.

859

</dd></dl>

860

861

862

863

864

<dd>An optional name for this media rule.

865

</dd></dl>

866

867

868

869

<tt class="descname">parent</tt><a class="headerlink" href="#cssutils.css.CSSMediaRule.parent" title="Permalink to this definition">¶</a></dt>

870

<dd>The Parent Node of this CSSRule or None.

871

</dd></dl>

872

873

874

875

<tt class="descname">parentRule</tt><a class="headerlink" href="#cssutils.css.CSSMediaRule.parentRule" title="Permalink to this definition">¶</a></dt>

876

<dd>If this rule is contained inside another rule (e.g. a style rule inside an @media block), this is the containing rule. If this rule is not nested inside any other rules, this returns None.

877

</dd></dl>

878

879

880

881

<tt class="descname">parentStyleSheet</tt><a class="headerlink" href="#cssutils.css.CSSMediaRule.parentStyleSheet" title="Permalink to this definition">¶</a></dt>

882

<dd>The style sheet that contains this rule.

883

</dd></dl>

884

885

886

887

888

<dd>Internal readonly attribute, DO NOT USE!

889

</dd></dl>

890

891

892

893

894

<dd>The type of this rule, as defined by a CSSRule type constant.

895

</dd></dl>

896

897

898

899

<tt class="descname">typeString</tt><a class="headerlink" href="#cssutils.css.CSSMediaRule.typeString" title="Permalink to this definition">¶</a></dt>

900

<dd>Descriptive name of this rule’s type.

901

</dd></dl>

902

903

</dd></dl>

904

905

</div>

906

907

<h3><tt class="docutils literal">CSSNamespaceRule</tt><a class="headerlink" href="#cssnamespacerule" title="Permalink to this headline">¶</a></h3>

908

909

910

class <tt class="descclassname">cssutils.css.</tt><tt class="descname">CSSNamespaceRule</tt><big>(</big>namespaceURI=None, prefix=None, cssText=None, parentRule=None, parentStyleSheet=None, readonly=False<big>)</big><a class="headerlink" href="#cssutils.css.CSSNamespaceRule" title="Permalink to this definition">¶</a></dt>

911

<dd>Represents an @namespace rule within a CSS style sheet.

912

The @namespace at-rule declares a namespace prefix and associates

913

it with a given namespace (a string). This namespace prefix can then be

914

used in namespace-qualified names such as those described in the

915

Selectors Module [SELECT] or the Values and Units module [CSS3VAL].

916

Dealing with these rules directly is not needed anymore, easier is

917

the use of <a class="reference internal" href="#cssutils.css.CSSStyleSheet.namespaces" title="cssutils.css.CSSStyleSheet.namespaces"><tt class="xref py py-attr docutils literal">cssutils.css.CSSStyleSheet.namespaces</tt></a>.

918

Format:

919

<div class="highlight-python"><pre>namespace

920

: NAMESPACE_SYM S* [namespace_prefix S*]? [STRING|URI] S* ';' S*

921

;

922

namespace_prefix

923

: IDENT

924

;</pre>

925

</div>

926

927

928

<tt class="descname">atkeyword</tt><a class="headerlink" href="#cssutils.css.CSSNamespaceRule.atkeyword" title="Permalink to this definition">¶</a></dt>

929

<dd>Literal keyword of an @rule (e.g. <tt class="docutils literal">@IMport</tt>).

930

</dd></dl>

931

932

933

934

<tt class="descname">cssText</tt><a class="headerlink" href="#cssutils.css.CSSNamespaceRule.cssText" title="Permalink to this definition">¶</a></dt>

935

<dd>(DOM) The parsable textual representation of this rule.

936

</dd></dl>

937

938

939

940

<tt class="descname">namespaceURI</tt><a class="headerlink" href="#cssutils.css.CSSNamespaceRule.namespaceURI" title="Permalink to this definition">¶</a></dt>

941

<dd>URI (handled as simple string) of the defined namespace.

942

</dd></dl>

943

944

945

946

<tt class="descname">parent</tt><a class="headerlink" href="#cssutils.css.CSSNamespaceRule.parent" title="Permalink to this definition">¶</a></dt>

947

<dd>The Parent Node of this CSSRule or None.

948

</dd></dl>

949

950

951

952

<tt class="descname">parentRule</tt><a class="headerlink" href="#cssutils.css.CSSNamespaceRule.parentRule" title="Permalink to this definition">¶</a></dt>

953

<dd>If this rule is contained inside another rule (e.g. a style rule inside an @media block), this is the containing rule. If this rule is not nested inside any other rules, this returns None.

954

</dd></dl>

955

956

957

958

<tt class="descname">parentStyleSheet</tt><a class="headerlink" href="#cssutils.css.CSSNamespaceRule.parentStyleSheet" title="Permalink to this definition">¶</a></dt>

959

<dd>The style sheet that contains this rule.

960

</dd></dl>

961

962

963

964

<tt class="descname">prefix</tt><a class="headerlink" href="#cssutils.css.CSSNamespaceRule.prefix" title="Permalink to this definition">¶</a></dt>

965

<dd>Prefix used for the defined namespace.

966

</dd></dl>

967

968

969

970

971

<dd>Internal readonly attribute, DO NOT USE!

972

</dd></dl>

973

974

975

976

977

<dd>The type of this rule, as defined by a CSSRule type constant.

978

</dd></dl>

979

980

981

982

<tt class="descname">typeString</tt><a class="headerlink" href="#cssutils.css.CSSNamespaceRule.typeString" title="Permalink to this definition">¶</a></dt>

983

<dd>Descriptive name of this rule’s type.

984

</dd></dl>

985

986

</dd></dl>

987

988

</div>

989

990

<h3><tt class="docutils literal">CSSPageRule</tt><a class="headerlink" href="#csspagerule" title="Permalink to this headline">¶</a></h3>

991

992

993

class <tt class="descclassname">cssutils.css.</tt><tt class="descname">CSSPageRule</tt><big>(</big>selectorText=None, style=None, parentRule=None, parentStyleSheet=None, readonly=False<big>)</big><a class="headerlink" href="#cssutils.css.CSSPageRule" title="Permalink to this definition">¶</a></dt>

994

<dd>The CSSPageRule interface represents a @page rule within a CSS style

995

sheet. The @page rule is used to specify the dimensions, orientation,

996

margins, etc. of a page box for paged media.

997

Format:

998

<div class="highlight-python"><pre>page

999

PAGE_SYM S* IDENT? pseudo_page? S*

1000

'{' S* declaration [ ';' S* declaration ]* '}' S*

1001

;

1002

pseudo_page

1003

':' [ "left" | "right" | "first" ]

1004

;</pre>

1005

</div>

1006

1007

1008

<tt class="descname">atkeyword</tt><a class="headerlink" href="#cssutils.css.CSSPageRule.atkeyword" title="Permalink to this definition">¶</a></dt>

1009

<dd>Literal keyword of an @rule (e.g. <tt class="docutils literal">@IMport</tt>).

1010

</dd></dl>

1011

1012

1013

1014

<tt class="descname">cssText</tt><a class="headerlink" href="#cssutils.css.CSSPageRule.cssText" title="Permalink to this definition">¶</a></dt>

1015

<dd>(DOM) The parsable textual representation of this rule.

1016

</dd></dl>

1017

1018

1019

1020

<tt class="descname">parent</tt><a class="headerlink" href="#cssutils.css.CSSPageRule.parent" title="Permalink to this definition">¶</a></dt>

1021

<dd>The Parent Node of this CSSRule or None.

1022

</dd></dl>

1023

1024

1025

1026

<tt class="descname">parentRule</tt><a class="headerlink" href="#cssutils.css.CSSPageRule.parentRule" title="Permalink to this definition">¶</a></dt>

1027

<dd>If this rule is contained inside another rule (e.g. a style rule inside an @media block), this is the containing rule. If this rule is not nested inside any other rules, this returns None.

1028

</dd></dl>

1029

1030

1031

1032

<tt class="descname">parentStyleSheet</tt><a class="headerlink" href="#cssutils.css.CSSPageRule.parentStyleSheet" title="Permalink to this definition">¶</a></dt>

1033

<dd>The style sheet that contains this rule.

1034

</dd></dl>

1035

1036

1037

1038

<tt class="descname">selectorText</tt><a class="headerlink" href="#cssutils.css.CSSPageRule.selectorText" title="Permalink to this definition">¶</a></dt>

1039

<dd>(DOM) The parsable textual representation of the page selector for the rule.

1040

</dd></dl>

1041

1042

1043

1044

1045

<dd>Internal readonly attribute, DO NOT USE!

1046

</dd></dl>

1047

1048

1049

1050

<tt class="descname">style</tt><a class="headerlink" href="#cssutils.css.CSSPageRule.style" title="Permalink to this definition">¶</a></dt>

1051

<dd>(DOM) The declaration-block of this rule set, a <a class="reference internal" href="#cssutils.css.CSSStyleDeclaration" title="cssutils.css.CSSStyleDeclaration"><tt class="xref py py-class docutils literal">CSSStyleDeclaration</tt></a>.

1052

</dd></dl>

1053

1054

1055

1056

1057

<dd>The type of this rule, as defined by a CSSRule type constant.

1058

</dd></dl>

1059

1060

1061

1062

<tt class="descname">typeString</tt><a class="headerlink" href="#cssutils.css.CSSPageRule.typeString" title="Permalink to this definition">¶</a></dt>

1063

<dd>Descriptive name of this rule’s type.

1064

</dd></dl>

1065

1066

</dd></dl>

1067

1068

</div>

1069

1070

<h3><tt class="docutils literal">CSSStyleRule</tt><a class="headerlink" href="#cssstylerule" title="Permalink to this headline">¶</a></h3>

1071

1072

1073

class <tt class="descclassname">cssutils.css.</tt><tt class="descname">CSSStyleRule</tt><big>(</big>selectorText=None, style=None, parentRule=None, parentStyleSheet=None, readonly=False<big>)</big><a class="headerlink" href="#cssutils.css.CSSStyleRule" title="Permalink to this definition">¶</a></dt>

1074

<dd>The CSSStyleRule object represents a ruleset specified (if any) in a CSS

1075

style sheet. It provides access to a declaration block as well as to the

1076

associated group of selectors.

1077

Format:

1078

<div class="highlight-python"><pre>: selector [ COMMA S* selector ]*

1079

LBRACE S* declaration [ ';' S* declaration ]* '}' S*

1080

;</pre>

1081

</div>

1082

1083

1084

<tt class="descname">atkeyword</tt><a class="headerlink" href="#cssutils.css.CSSStyleRule.atkeyword" title="Permalink to this definition">¶</a></dt>

1085

<dd>Literal keyword of an @rule (e.g. <tt class="docutils literal">@IMport</tt>).

1086

</dd></dl>

1087

1088

1089

1090

<tt class="descname">cssText</tt><a class="headerlink" href="#cssutils.css.CSSStyleRule.cssText" title="Permalink to this definition">¶</a></dt>

1091

<dd>(DOM) The parsable textual representation of this rule.

1092

</dd></dl>

1093

1094

1095

1096

<tt class="descname">parent</tt><a class="headerlink" href="#cssutils.css.CSSStyleRule.parent" title="Permalink to this definition">¶</a></dt>

1097

<dd>The Parent Node of this CSSRule or None.

1098

</dd></dl>

1099

1100

1101

1102

<tt class="descname">parentRule</tt><a class="headerlink" href="#cssutils.css.CSSStyleRule.parentRule" title="Permalink to this definition">¶</a></dt>

1103

<dd>If this rule is contained inside another rule (e.g. a style rule inside an @media block), this is the containing rule. If this rule is not nested inside any other rules, this returns None.

1104

</dd></dl>

1105

1106

1107

1108

<tt class="descname">parentStyleSheet</tt><a class="headerlink" href="#cssutils.css.CSSStyleRule.parentStyleSheet" title="Permalink to this definition">¶</a></dt>

1109

<dd>The style sheet that contains this rule.

1110

</dd></dl>

1111

1112

1113

1114

<tt class="descname">selectorList</tt><a class="headerlink" href="#cssutils.css.CSSStyleRule.selectorList" title="Permalink to this definition">¶</a></dt>

1115

<dd>The SelectorList of this rule.

1116

</dd></dl>

1117

1118

1119

1120

<tt class="descname">selectorText</tt><a class="headerlink" href="#cssutils.css.CSSStyleRule.selectorText" title="Permalink to this definition">¶</a></dt>

1121

<dd>(DOM) The textual representation of the selector for the rule set.

1122

</dd></dl>

1123

1124

1125

1126

1127

<dd>Internal readonly attribute, DO NOT USE!

1128

</dd></dl>

1129

1130

1131

1132

<tt class="descname">style</tt><a class="headerlink" href="#cssutils.css.CSSStyleRule.style" title="Permalink to this definition">¶</a></dt>

1133

<dd>(DOM) The declaration-block of this rule set.

1134

</dd></dl>

1135

1136

1137

1138

1139

<dd>The type of this rule, as defined by a CSSRule type constant.

1140

</dd></dl>

1141

1142

1143

1144

<tt class="descname">typeString</tt><a class="headerlink" href="#cssutils.css.CSSStyleRule.typeString" title="Permalink to this definition">¶</a></dt>

1145

<dd>Descriptive name of this rule’s type.

1146

</dd></dl>

1147

1148

</dd></dl>

1149

1150

</div>

1151

1152

<h3><tt class="docutils literal">CSSVariablesRule</tt><a class="headerlink" href="#cssvariablesrule" title="Permalink to this headline">¶</a></h3>

1153

1154

1155

class <tt class="descclassname">cssutils.css.</tt><tt class="descname">CSSVariablesRule</tt><big>(</big>mediaText=None, variables=None, parentRule=None, parentStyleSheet=None, readonly=False<big>)</big><a class="headerlink" href="#cssutils.css.CSSVariablesRule" title="Permalink to this definition">¶</a></dt>

1156

<dd>The CSSVariablesRule interface represents a @variables rule within a CSS

1157

style sheet. The @variables rule is used to specify variables.

1158

cssutils uses a <a class="reference internal" href="#cssutils.css.CSSVariablesDeclaration" title="cssutils.css.CSSVariablesDeclaration"><tt class="xref py py-class docutils literal">CSSVariablesDeclaration</tt></a> to

1159

represent the variables.

1160

Format:

1161

<div class="highlight-python"><pre>variables

1162

VARIABLES_SYM S* medium [ COMMA S* medium ]* LBRACE S*

1163

variableset* '}' S*

1164

;</pre>

1165

</div>

1166

for variableset see <a class="reference internal" href="#cssutils.css.CSSVariablesDeclaration" title="cssutils.css.CSSVariablesDeclaration"><tt class="xref py py-class docutils literal">cssutils.css.CSSVariablesDeclaration</tt></a>

1167

Media are not implemented. Reason is that cssutils is using CSS

1168

variables in a kind of preprocessing and therefor no media information

1169

is available at this stage. For now do not use media!

1170

Example:

1171

<div class="highlight-python"><pre>@variables {

1172

CorporateLogoBGColor: #fe8d12;

1173

}

1174

1175

div.logoContainer {

1176

background-color: var(CorporateLogoBGColor);

1177

}</pre>

1178

</div>

1179

1180

1181

<tt class="descname">atkeyword</tt><a class="headerlink" href="#cssutils.css.CSSVariablesRule.atkeyword" title="Permalink to this definition">¶</a></dt>

1182

<dd>Literal keyword of an @rule (e.g. <tt class="docutils literal">@IMport</tt>).

1183

</dd></dl>

1184

1185

1186

1187

<tt class="descname">cssText</tt><a class="headerlink" href="#cssutils.css.CSSVariablesRule.cssText" title="Permalink to this definition">¶</a></dt>

1188

<dd>(DOM) The parsable textual representation of this rule.

1189

</dd></dl>

1190

1191

1192

1193

<tt class="descname">media</tt><a class="headerlink" href="#cssutils.css.CSSVariablesRule.media" title="Permalink to this definition">¶</a></dt>

1194

<dd>NOT IMPLEMENTED! As cssutils resolves variables during serializing media information is lost.

1195

</dd></dl>

1196

1197

1198

1199

<tt class="descname">parent</tt><a class="headerlink" href="#cssutils.css.CSSVariablesRule.parent" title="Permalink to this definition">¶</a></dt>

1200

<dd>The Parent Node of this CSSRule or None.

1201

</dd></dl>

1202

1203

1204

1205

<tt class="descname">parentRule</tt><a class="headerlink" href="#cssutils.css.CSSVariablesRule.parentRule" title="Permalink to this definition">¶</a></dt>

1206

<dd>If this rule is contained inside another rule (e.g. a style rule inside an @media block), this is the containing rule. If this rule is not nested inside any other rules, this returns None.

1207

</dd></dl>

1208

1209

1210

1211

<tt class="descname">parentStyleSheet</tt><a class="headerlink" href="#cssutils.css.CSSVariablesRule.parentStyleSheet" title="Permalink to this definition">¶</a></dt>

1212

<dd>The style sheet that contains this rule.

1213

</dd></dl>

1214

1215

1216

1217

1218

<dd>Internal readonly attribute, DO NOT USE!

1219

</dd></dl>

1220

1221

1222

1223

1224

<dd>The type of this rule, as defined by a CSSRule type constant.

1225

</dd></dl>

1226

1227

1228

1229

<tt class="descname">typeString</tt><a class="headerlink" href="#cssutils.css.CSSVariablesRule.typeString" title="Permalink to this definition">¶</a></dt>

1230

<dd>Descriptive name of this rule’s type.

1231

</dd></dl>

1232

1233

1234

1235

<tt class="descname">valid</tt><a class="headerlink" href="#cssutils.css.CSSVariablesRule.valid" title="Permalink to this definition">¶</a></dt>

1236

<dd>NOT IMPLEMTED REALLY (TODO)

1237

</dd></dl>

1238

1239

1240

1241

<tt class="descname">variables</tt><a class="headerlink" href="#cssutils.css.CSSVariablesRule.variables" title="Permalink to this definition">¶</a></dt>

1242

<dd>(DOM) The variables of this rule set, a <a class="reference internal" href="#cssutils.css.CSSVariablesDeclaration" title="cssutils.css.CSSVariablesDeclaration"><tt class="xref py py-class docutils literal">cssutils.css.CSSVariablesDeclaration</tt></a>.

1243

</dd></dl>

1244

1245

</dd></dl>

1246

1247

</div>

1248

1249

<h3><tt class="docutils literal">CSSComment</tt><a class="headerlink" href="#csscomment" title="Permalink to this headline">¶</a></h3>

1250

1251

1252

class <tt class="descclassname">cssutils.css.</tt><tt class="descname">CSSComment</tt><big>(</big>cssText=None, parentRule=None, parentStyleSheet=None, readonly=False<big>)</big><a class="headerlink" href="#cssutils.css.CSSComment" title="Permalink to this definition">¶</a></dt>

1253

<dd>Represents a CSS comment (cssutils only).

1254

Format:

1255

1256

</div>

1257

1258

1259

<tt class="descname">atkeyword</tt><a class="headerlink" href="#cssutils.css.CSSComment.atkeyword" title="Permalink to this definition">¶</a></dt>

1260

<dd>Literal keyword of an @rule (e.g. <tt class="docutils literal">@IMport</tt>).

1261

</dd></dl>

1262

1263

1264

1265

<tt class="descname">cssText</tt><a class="headerlink" href="#cssutils.css.CSSComment.cssText" title="Permalink to this definition">¶</a></dt>

1266

<dd>The parsable textual representation of this rule.

1267

</dd></dl>

1268

1269

1270

1271

<tt class="descname">parent</tt><a class="headerlink" href="#cssutils.css.CSSComment.parent" title="Permalink to this definition">¶</a></dt>

1272

<dd>The Parent Node of this CSSRule or None.

1273

</dd></dl>

1274

1275

1276

1277

<tt class="descname">parentRule</tt><a class="headerlink" href="#cssutils.css.CSSComment.parentRule" title="Permalink to this definition">¶</a></dt>

1278

<dd>If this rule is contained inside another rule (e.g. a style rule inside an @media block), this is the containing rule. If this rule is not nested inside any other rules, this returns None.

1279

</dd></dl>

1280

1281

1282

1283

<tt class="descname">parentStyleSheet</tt><a class="headerlink" href="#cssutils.css.CSSComment.parentStyleSheet" title="Permalink to this definition">¶</a></dt>

1284

<dd>The style sheet that contains this rule.

1285

</dd></dl>

1286

1287

1288

1289

1290

<dd>Internal readonly attribute, DO NOT USE!

1291

</dd></dl>

1292

1293

1294

1295

1296

<dd>The type of this rule, as defined by a CSSRule type constant.

1297

</dd></dl>

1298

1299

1300

1301

<tt class="descname">typeString</tt><a class="headerlink" href="#cssutils.css.CSSComment.typeString" title="Permalink to this definition">¶</a></dt>

1302

<dd>Descriptive name of this rule’s type.

1303

</dd></dl>

1304

1305

</dd></dl>

1306

1307

</div>

1308

</div>

1309

1310

<h2>Selector related classes: <tt class="docutils literal">SelectorList</tt> and <tt class="docutils literal">Selector</tt><a class="headerlink" href="#selector-related-classes-selectorlist-and-selector" title="Permalink to this headline">¶</a></h2>

1311

1312

<h3><tt class="docutils literal">SelectorList</tt><a class="headerlink" href="#selectorlist" title="Permalink to this headline">¶</a></h3>

1313

1314

1315

class <tt class="descclassname">cssutils.css.</tt><tt class="descname">SelectorList</tt><big>(</big>selectorText=None, parentRule=None, readonly=False<big>)</big><a class="headerlink" href="#cssutils.css.SelectorList" title="Permalink to this definition">¶</a></dt>

1316

<dd>A list of <a class="reference internal" href="#cssutils.css.Selector" title="cssutils.css.Selector"><tt class="xref py py-class docutils literal">Selector</tt></a> objects

1317

of a <a class="reference internal" href="#cssutils.css.CSSStyleRule" title="cssutils.css.CSSStyleRule"><tt class="xref py py-class docutils literal">CSSStyleRule</tt></a>.

1318

1319

1320

<tt class="descname">append</tt><big>(</big>newSelector<big>)</big><a class="headerlink" href="#cssutils.css.SelectorList.append" title="Permalink to this definition">¶</a></dt>

1321

<dd>Same as <a class="reference internal" href="#cssutils.css.SelectorList.appendSelector" title="cssutils.css.SelectorList.appendSelector"><tt class="xref py py-meth docutils literal">appendSelector()</tt></a>.

1322

</dd></dl>

1323

1324

1325

1326

<tt class="descname">appendSelector</tt><big>(</big>newSelector<big>)</big><a class="headerlink" href="#cssutils.css.SelectorList.appendSelector" title="Permalink to this definition">¶</a></dt>

1327

<dd>Append <cite>newSelector</cite> to this list (a string will be converted to a

1328

<a class="reference internal" href="#cssutils.css.Selector" title="cssutils.css.Selector"><tt class="xref py py-class docutils literal">Selector</tt></a>).

1329

1330

1331

1332

1333

<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

1334

<li>newSelector – comma-separated list of selectors (as a single string) or a tuple of

1335

<cite>(newSelector, dict-of-namespaces)</cite></li>

1336

</ul>

1337

</td>

1338

</tr>

1339

<tr class="field"><th class="field-name">Returns:</th><td class="field-body">New <a class="reference internal" href="#cssutils.css.Selector" title="cssutils.css.Selector"><tt class="xref py py-class docutils literal">Selector</tt></a> or <tt class="xref docutils literal">None</tt> if

1340

<cite>newSelector</cite> is not wellformed.

1341

</td>

1342

</tr>

1343

<tr class="field"><th class="field-name">Exceptions :</th><td class="field-body"><ul class="first last simple">

1344

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.NamespaceErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">NamespaceErr</tt></a>:

1345

Raised if the specified selector uses an unknown namespace

1346

prefix.</li>

1347

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.SyntaxErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">SyntaxErr</tt></a>:

1348

Raised if the specified CSS string value has a syntax error

1349

and is unparsable.</li>

1350

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.NoModificationAllowedErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">NoModificationAllowedErr</tt></a>:

1351

Raised if this rule is readonly.</li>

1352

</ul>

1353

</td>

1354

</tr>

1355

</tbody>

1356

</table>

1357

</dd></dl>

1358

1359

1360

1361

<tt class="descname">length</tt><a class="headerlink" href="#cssutils.css.SelectorList.length" title="Permalink to this definition">¶</a></dt>

1362

<dd>The number of <a class="reference internal" href="#cssutils.css.Selector" title="cssutils.css.Selector"><tt class="xref py py-class docutils literal">Selector</tt></a> objects in the list.

1363

</dd></dl>

1364

1365

1366

1367

<tt class="descname">parentRule</tt><a class="headerlink" href="#cssutils.css.SelectorList.parentRule" title="Permalink to this definition">¶</a></dt>

1368

<dd>(DOM) The CSS rule that contains this SelectorList or <tt class="xref docutils literal">None</tt> if this SelectorList is not attached to a CSSRule.

1369

</dd></dl>

1370

1371

1372

1373

<tt class="descname">selectorText</tt><a class="headerlink" href="#cssutils.css.SelectorList.selectorText" title="Permalink to this definition">¶</a></dt>

1374

<dd>(cssutils) The textual representation of the selector for a rule set.

1375

</dd></dl>

1376

1377

</dd></dl>

1378

1379

</div>

1380

1381

<h3><tt class="docutils literal">Selector</tt><a class="headerlink" href="#selector" title="Permalink to this headline">¶</a></h3>

1382

1383

1384

class <tt class="descclassname">cssutils.css.</tt><tt class="descname">Selector</tt><big>(</big>selectorText=None, parent=None, readonly=False<big>)</big><a class="headerlink" href="#cssutils.css.Selector" title="Permalink to this definition">¶</a></dt>

1385

<dd>(cssutils) a single selector in a <a class="reference internal" href="#cssutils.css.SelectorList" title="cssutils.css.SelectorList"><tt class="xref py py-class docutils literal">SelectorList</tt></a>

1386

of a <a class="reference internal" href="#cssutils.css.CSSStyleRule" title="cssutils.css.CSSStyleRule"><tt class="xref py py-class docutils literal">CSSStyleRule</tt></a>.

1387

Format:

1388

<div class="highlight-python"><pre># implemented in SelectorList

1389

selectors_group

1390

: selector [ COMMA S* selector ]*

1391

;

1392

1393

selector

1394

: simple_selector_sequence [ combinator simple_selector_sequence ]*

1395

;

1396

1397

combinator

1398

/* combinators can be surrounded by white space */

1399

: PLUS S* | GREATER S* | TILDE S* | S+

1400

;

1401

1402

simple_selector_sequence

1403

: [ type_selector | universal ]

1404

[ HASH | class | attrib | pseudo | negation ]*

1405

1406

;

1407

1408

type_selector

1409

: [ namespace_prefix ]? element_name

1410

;

1411

1412

namespace_prefix

1413

: [ IDENT | '*' ]? '|'

1414

;

1415

1416

element_name

1417

: IDENT

1418

;

1419

1420

universal

1421

: [ namespace_prefix ]? '*'

1422

;

1423

1424

class

1425

: '.' IDENT

1426

;

1427

1428

attrib

1429

: '[' S* [ namespace_prefix ]? IDENT S*

1430

[ [ PREFIXMATCH |

1431

SUFFIXMATCH |

1432

SUBSTRINGMATCH |

1433

'=' |

1434

INCLUDES |

1435

DASHMATCH ] S* [ IDENT | STRING ] S*

1436

]? ']'

1437

;

1438

1439

pseudo

1440

/* '::' starts a pseudo-element, ':' a pseudo-class */

1441

/* Exceptions: :first-line, :first-letter, :before and :after. */

1442

/* Note that pseudo-elements are restricted to one per selector and */

1443

/* occur only in the last simple_selector_sequence. */

1444

: ':' ':'? [ IDENT | functional_pseudo ]

1445

;

1446

1447

functional_pseudo

1448

: FUNCTION S* expression ')'

1449

;

1450

1451

expression

1452

/* In CSS3, the expressions are identifiers, strings, */

1453

/* or of the form "an+b" */

1454

1455

;

1456

1457

negation

1458

: NOT S* negation_arg S* ')'

1459

;

1460

1461

negation_arg

1462

1463

;</pre>

1464

</div>

1465

1466

1467

<tt class="descname">element</tt><a class="headerlink" href="#cssutils.css.Selector.element" title="Permalink to this definition">¶</a></dt>

1468

<dd>Effective element target of this selector.

1469

</dd></dl>

1470

1471

1472

1473

<tt class="descname">parent</tt><a class="headerlink" href="#cssutils.css.Selector.parent" title="Permalink to this definition">¶</a></dt>

1474

<dd>(DOM) The SelectorList that contains this Selector or None if this Selector is not attached to a SelectorList.

1475

</dd></dl>

1476

1477

1478

1479

<tt class="descname">parentList</tt><a class="headerlink" href="#cssutils.css.Selector.parentList" title="Permalink to this definition">¶</a></dt>

1480

<dd>DEPRECATED, see property parent instead

1481

</dd></dl>

1482

1483

1484

1485

<tt class="descname">selectorText</tt><a class="headerlink" href="#cssutils.css.Selector.selectorText" title="Permalink to this definition">¶</a></dt>

1486

<dd>(DOM) The parsable textual representation of the selector.

1487

</dd></dl>

1488

1489

1490

1491

1492

<dd>Internal readonly attribute, DO NOT USE!

1493

</dd></dl>

1494

1495

1496

1497

<tt class="descname">specificity</tt><a class="headerlink" href="#cssutils.css.Selector.specificity" title="Permalink to this definition">¶</a></dt>

1498

<dd>Specificity of this selector (READONLY).

1499

Tuple of (a, b, c, d) where:

1500

1501

1502

<dd>presence of style in document, always 0 if not used on a

1503

document</dd>

1504

1505

<dd>number of ID selectors</dd>

1506

1507

<dd>number of .class selectors</dd>

1508

1509

<dd>number of Element (type) selectors</dd>

1510

</dl>

1511

</dd></dl>

1512

1513

</dd></dl>

1514

1515

</div>

1516

</div>

1517

1518

<h2>Style related classes: <tt class="docutils literal">CSSStyleDeclaration</tt>, <tt class="docutils literal">Property</tt>, <tt class="docutils literal">CSSValue</tt> etc<a class="headerlink" href="#style-related-classes-cssstyledeclaration-property-cssvalue-etc" title="Permalink to this headline">¶</a></h2>

1519

1520

<h3><tt class="docutils literal">CSSVariablesDeclaration</tt><a class="headerlink" href="#cssvariablesdeclaration" title="Permalink to this headline">¶</a></h3>

1521

1522

1523

class <tt class="descclassname">cssutils.css.</tt><tt class="descname">CSSVariablesDeclaration</tt><big>(</big>cssText=u'', parentRule=None, readonly=False<big>)</big><a class="headerlink" href="#cssutils.css.CSSVariablesDeclaration" title="Permalink to this definition">¶</a></dt>

1524

<dd>The CSSVariablesDeclaration interface represents a single block of

1525

variable declarations.

1526

1527

1528

<tt class="descname">cssText</tt><a class="headerlink" href="#cssutils.css.CSSVariablesDeclaration.cssText" title="Permalink to this definition">¶</a></dt>

1529

<dd>(DOM) A parsable textual representation of the declaration block excluding the surrounding curly braces.

1530

</dd></dl>

1531

1532

1533

1534

<tt class="descname">getVariableValue</tt><big>(</big>variableName<big>)</big><a class="headerlink" href="#cssutils.css.CSSVariablesDeclaration.getVariableValue" title="Permalink to this definition">¶</a></dt>

1535

<dd>Used to retrieve the value of a variable if it has been explicitly

1536

set within this variable declaration block.

1537

1538

1539

1540

1541

<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

1542

<li>variableName – The name of the variable.</li>

1543

</ul>

1544

</td>

1545

</tr>

1546

<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the variable if it has been explicitly set in this

1547

variable declaration block. Returns the empty string if the

1548

variable has not been set.

1549

</td>

1550

</tr>

1551

</tbody>

1552

</table>

1553

</dd></dl>

1554

1555

1556

1557

<tt class="descname">item</tt><big>(</big>index<big>)</big><a class="headerlink" href="#cssutils.css.CSSVariablesDeclaration.item" title="Permalink to this definition">¶</a></dt>

1558

<dd>Used to retrieve the variables that have been explicitly set in

1559

this variable declaration block. The order of the variables

1560

retrieved using this method does not have to be the order in which

1561

they were set. This method can be used to iterate over all variables

1562

in this variable declaration block.

1563

1564

1565

1566

1567

<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

1568

<li>index – of the variable name to retrieve, negative values behave like

1569

negative indexes on Python lists, so -1 is the last element</li>

1570

</ul>

1571

</td>

1572

</tr>

1573

<tr class="field"><th class="field-name">Returns:</th><td class="field-body">The name of the variable at this ordinal position. The empty

1574

string if no variable exists at this position.

1575

</td>

1576

</tr>

1577

</tbody>

1578

</table>

1579

</dd></dl>

1580

1581

1582

1583

1584

<dd>Analoguous to standard dict returns variable names which are set in

1585

this declaration.

1586

</dd></dl>

1587

1588

1589

1590

<tt class="descname">length</tt><a class="headerlink" href="#cssutils.css.CSSVariablesDeclaration.length" title="Permalink to this definition">¶</a></dt>

1591

<dd>The number of variables that have been explicitly set in this variable declaration block. The range of valid indices is 0 to length-1 inclusive.

1592

</dd></dl>

1593

1594

1595

1596

<tt class="descname">parentRule</tt><a class="headerlink" href="#cssutils.css.CSSVariablesDeclaration.parentRule" title="Permalink to this definition">¶</a></dt>

1597

<dd>(DOM) The CSS rule that contains this declaration block or None if this block is not attached to a CSSRule.

1598

</dd></dl>

1599

1600

1601

1602

<tt class="descname">removeVariable</tt><big>(</big>variableName<big>)</big><a class="headerlink" href="#cssutils.css.CSSVariablesDeclaration.removeVariable" title="Permalink to this definition">¶</a></dt>

1603

<dd>Used to remove a variable if it has been explicitly set within this

1604

variable declaration block.

1605

1606

1607

1608

1609

<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

1610

<li>variableName – The name of the variable.</li>

1611

</ul>

1612

</td>

1613

</tr>

1614

<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the variable if it has been explicitly set for this

1615

variable declaration block. Returns the empty string if the

1616

variable has not been set.

1617

</td>

1618

</tr>

1619

<tr class="field"><th class="field-name">Exceptions :</th><td class="field-body"><ul class="first last simple">

1620

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.NoModificationAllowedErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">NoModificationAllowedErr</tt></a>:

1621

Raised if this declaration is readonly is readonly.</li>

1622

</ul>

1623

</td>

1624

</tr>

1625

</tbody>

1626

</table>

1627

</dd></dl>

1628

1629

1630

1631

1632

<dd>Internal readonly attribute, DO NOT USE!

1633

</dd></dl>

1634

1635

1636

1637

<tt class="descname">setVariable</tt><big>(</big>variableName, value<big>)</big><a class="headerlink" href="#cssutils.css.CSSVariablesDeclaration.setVariable" title="Permalink to this definition">¶</a></dt>

1638

<dd>Used to set a variable value within this variable declaration block.

1639

1640

1641

1642

1643

<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

1644

<li>variableName – The name of the CSS variable.</li>

1645

<li>value – The new value of the variable, may also be a CSSValue object.</li>

1646

</ul>

1647

</td>

1648

</tr>

1649

<tr class="field"><th class="field-name">Exceptions :</th><td class="field-body"><ul class="first last simple">

1650

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.SyntaxErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">SyntaxErr</tt></a>:

1651

Raised if the specified value has a syntax error and is

1652

unparsable.</li>

1653

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.NoModificationAllowedErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">NoModificationAllowedErr</tt></a>:

1654

Raised if this declaration is readonly or the property is

1655

readonly.</li>

1656

</ul>

1657

</td>

1658

</tr>

1659

</tbody>

1660

</table>

1661

</dd></dl>

1662

1663

</dd></dl>

1664

1665

</div>

1666

1667

<h3><tt class="docutils literal">CSSStyleDeclaration</tt><a class="headerlink" href="#cssstyledeclaration" title="Permalink to this headline">¶</a></h3>

1668

1669

1670

class <tt class="descclassname">cssutils.css.</tt><tt class="descname">CSSStyleDeclaration</tt><big>(</big>cssText=u'', parentRule=None, readonly=False<big>)</big><a class="headerlink" href="#cssutils.css.CSSStyleDeclaration" title="Permalink to this definition">¶</a></dt>

1671

<dd>The CSSStyleDeclaration class represents a single CSS declaration

1672

block. This class may be used to determine the style properties

1673

currently set in a block or to set style properties explicitly

1674

within the block.

1675

While an implementation may not recognize all CSS properties within

1676

a CSS declaration block, it is expected to provide access to all

1677

specified properties in the style sheet through the

1678

CSSStyleDeclaration interface.

1679

Furthermore, implementations that support a specific level of CSS

1680

should correctly handle CSS shorthand properties for that level. For

1681

a further discussion of shorthand properties, see the CSS2Properties

1682

interface.

1683

Additionally the CSS2Properties interface is implemented.

1684

1685

<dt>$css2propertyname</dt>

1686

<dd>All properties defined in the CSS2Properties class are available

1687

as direct properties of CSSStyleDeclaration with their respective

1688

DOM name, so e.g. <tt class="docutils literal">fontStyle</tt> for property ‘font-style’.

1689

These may be used as:

1690

<div class="last highlight-python"><div class="highlight"><pre>>>> style = CSSStyleDeclaration(cssText='color: red')

1691

>>> style.color = 'green'

1692

>>> print style.color

1693

green

1694

>>> del style.color

1695

>>> print style.color

1696

1697

</pre></div>

1698

</div>

1699

</dd>

1700

</dl>

1701

Format:

1702

<div class="highlight-python"><pre>[Property: Value Priority?;]* [Property: Value Priority?]?</pre>

1703

</div>

1704

1705

1706

<tt class="descname">children</tt><big>(</big><big>)</big><a class="headerlink" href="#cssutils.css.CSSStyleDeclaration.children" title="Permalink to this definition">¶</a></dt>

1707

<dd>Generator yielding any known child in this declaration including

1708

all properties, comments or CSSUnknownrules.

1709

</dd></dl>

1710

1711

1712

1713

<tt class="descname">cssText</tt><a class="headerlink" href="#cssutils.css.CSSStyleDeclaration.cssText" title="Permalink to this definition">¶</a></dt>

1714

<dd>(DOM) A parsable textual representation of the declaration block excluding the surrounding curly braces.

1715

</dd></dl>

1716

1717

1718

1719

<tt class="descname">getCssText</tt><big>(</big>separator=None<big>)</big><a class="headerlink" href="#cssutils.css.CSSStyleDeclaration.getCssText" title="Permalink to this definition">¶</a></dt>

1720

1721

1722

1723

1724

<tr class="field"><th class="field-name">Returns:</th><td class="field-body">serialized property cssText, each property separated by

1725

given <cite>separator</cite> which may e.g. be <tt class="docutils literal">u''</tt> to be able to use

1726

cssText directly in an HTML style attribute. <tt class="docutils literal">;</tt> is part of

1727

each property (except the last one) and cannot be set with

1728

separator!</td>

1729

</tr>

1730

</tbody>

1731

</table>

1732

</dd></dl>

1733

1734

1735

1736

<tt class="descname">getProperties</tt><big>(</big>name=None, all=False<big>)</big><a class="headerlink" href="#cssutils.css.CSSStyleDeclaration.getProperties" title="Permalink to this definition">¶</a></dt>

1737

1738

1739

1740

1741

<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

1742

<li>name – optional <cite>name</cite> of properties which are requested.

1743

Only properties with this always normalized <cite>name</cite> are returned.

1744

If <cite>name</cite> is <tt class="xref docutils literal">None</tt> all properties are returned (at least one for

1745

each set name depending on parameter <cite>all</cite>).</li>

1746

<li>all – if <tt class="xref docutils literal">False</tt> (DEFAULT) only the effective properties are returned.

1747

If name is given a list with only one property is returned.

1748

if <tt class="xref docutils literal">True</tt> all properties including properties set multiple times

1749

with different values or priorities for different UAs are returned.

1750

The order of the properties is fully kept as in the original

1751

stylesheet.

1752

</li>

1753

</ul>

1754

</td>

1755

</tr>

1756

<tr class="field"><th class="field-name">Returns:</th><td class="field-body">a list of <a class="reference internal" href="#cssutils.css.Property" title="cssutils.css.Property"><tt class="xref py py-class docutils literal">Property</tt></a> objects set in

1757

this declaration.

1758

</td>

1759

</tr>

1760

</tbody>

1761

</table>

1762

</dd></dl>

1763

1764

1765

1766

<tt class="descname">getProperty</tt><big>(</big>name, normalize=True<big>)</big><a class="headerlink" href="#cssutils.css.CSSStyleDeclaration.getProperty" title="Permalink to this definition">¶</a></dt>

1767

1768

1769

1770

1771

<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

1772

<li>name – of the CSS property, always lowercase (even if not normalized)</li>

1773

<li>normalize – if <tt class="xref docutils literal">True</tt> (DEFAULT) name will be normalized (lowercase, no simple

1774

escapes) so “color”, “COLOR” or “Color” will all be equivalent

1775

If <tt class="xref docutils literal">False</tt> may return NOT the effective value but the

1776

effective for the unnormalized name.

1777

</li>

1778

</ul>

1779

</td>

1780

</tr>

1781

<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the effective <a class="reference internal" href="#cssutils.css.Property" title="cssutils.css.Property"><tt class="xref py py-class docutils literal">Property</tt></a> object.

1782

</td>

1783

</tr>

1784

</tbody>

1785

</table>

1786

</dd></dl>

1787

1788

1789

1790

<tt class="descname">getPropertyCSSValue</tt><big>(</big>name, normalize=True<big>)</big><a class="headerlink" href="#cssutils.css.CSSStyleDeclaration.getPropertyCSSValue" title="Permalink to this definition">¶</a></dt>

1791

1792

1793

1794

1795

<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

1796

<li>name – of the CSS property, always lowercase (even if not normalized)</li>

1797

<li>normalize – if <tt class="xref docutils literal">True</tt> (DEFAULT) name will be normalized (lowercase, no simple

1798

escapes) so “color”, “COLOR” or “Color” will all be equivalent

1799

If <tt class="xref docutils literal">False</tt> may return NOT the effective value but the

1800

effective for the unnormalized name.

1801

</li>

1802

</ul>

1803

</td>

1804

</tr>

1805

<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><a class="reference internal" href="#cssutils.css.CSSValue" title="cssutils.css.CSSValue"><tt class="xref py py-class docutils literal">CSSValue</tt></a>, the value of the effective

1806

property if it has been explicitly set for this declaration block.

1807

</td>

1808

</tr>

1809

</tbody>

1810

</table>

1811

(DOM)

1812

Used to retrieve the object representation of the value of a CSS

1813

property if it has been explicitly set within this declaration

1814

block. Returns None if the property has not been set.

1815

(This method returns None if the property is a shorthand

1816

property. Shorthand property values can only be accessed and

1817

modified as strings, using the getPropertyValue and setProperty

1818

methods.)

1819

cssutils currently always returns a CSSValue if the property is

1820

set.

1821

1822

<dt>for more on shorthand properties see</dt>

1823

<dd><a class="reference external" href="http://www.dustindiaz.com/css-shorthand/">http://www.dustindiaz.com/css-shorthand/</a></dd>

1824

</dl>

1825

</dd></dl>

1826

1827

1828

1829

<tt class="descname">getPropertyPriority</tt><big>(</big>name, normalize=True<big>)</big><a class="headerlink" href="#cssutils.css.CSSStyleDeclaration.getPropertyPriority" title="Permalink to this definition">¶</a></dt>

1830

1831

1832

1833

1834

<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

1835

<li>name – of the CSS property, always lowercase (even if not normalized)</li>

1836

<li>normalize – if <tt class="xref docutils literal">True</tt> (DEFAULT) name will be normalized (lowercase, no simple

1837

escapes) so “color”, “COLOR” or “Color” will all be equivalent

1838

If <tt class="xref docutils literal">False</tt> may return NOT the effective value but the

1839

effective for the unnormalized name.

1840

</li>

1841

</ul>

1842

</td>

1843

</tr>

1844

<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the priority of the effective CSS property (e.g. the

1845

“important” qualifier) if the property has been explicitly set in

1846

this declaration block. The empty string if none exists.

1847

</td>

1848

</tr>

1849

</tbody>

1850

</table>

1851

</dd></dl>

1852

1853

1854

1855

<tt class="descname">getPropertyValue</tt><big>(</big>name, normalize=True<big>)</big><a class="headerlink" href="#cssutils.css.CSSStyleDeclaration.getPropertyValue" title="Permalink to this definition">¶</a></dt>

1856

1857

1858

1859

1860

<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

1861

<li>name – of the CSS property, always lowercase (even if not normalized)</li>

1862

<li>normalize – if <tt class="xref docutils literal">True</tt> (DEFAULT) name will be normalized (lowercase, no simple

1863

escapes) so “color”, “COLOR” or “Color” will all be equivalent

1864

If <tt class="xref docutils literal">False</tt> may return NOT the effective value but the

1865

effective for the unnormalized name.

1866

</li>

1867

</ul>

1868

</td>

1869

</tr>

1870

<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective property if it has been explicitly set

1871

for this declaration block. Returns the empty string if the

1872

property has not been set.

1873

</td>

1874

</tr>

1875

</tbody>

1876

</table>

1877

</dd></dl>

1878

1879

1880

1881

<tt class="descname">item</tt><big>(</big>index<big>)</big><a class="headerlink" href="#cssutils.css.CSSStyleDeclaration.item" title="Permalink to this definition">¶</a></dt>

1882

<dd>(DOM) Retrieve the properties that have been explicitly set in

1883

this declaration block. The order of the properties retrieved using

1884

this method does not have to be the order in which they were set.

1885

This method can be used to iterate over all properties in this

1886

declaration block.

1887

1888

1889

1890

1891

<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

1892

<li>index – of the property to retrieve, negative values behave like

1893

negative indexes on Python lists, so -1 is the last element</li>

1894

</ul>

1895

</td>

1896

</tr>

1897

<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the name of the property at this ordinal position. The

1898

empty string if no property exists at this position.

1899

</td>

1900

</tr>

1901

</tbody>

1902

</table>

1903

ATTENTION:

1904

Only properties with different names are counted. If two

1905

properties with the same name are present in this declaration

1906

only the effective one is included.

1907

<a class="reference internal" href="#cssutils.css.CSSStyleDeclaration.item" title="cssutils.css.CSSStyleDeclaration.item"><tt class="xref py py-meth docutils literal">item()</tt></a> and <a class="reference internal" href="#cssutils.css.CSSStyleDeclaration.length" title="cssutils.css.CSSStyleDeclaration.length"><tt class="xref py py-attr docutils literal">length</tt></a> work on the same set here.

1908

</dd></dl>

1909

1910

1911

1912

1913

<dd>Analoguous to standard dict returns property names which are set in

1914

this declaration.

1915

</dd></dl>

1916

1917

1918

1919

<tt class="descname">length</tt><a class="headerlink" href="#cssutils.css.CSSStyleDeclaration.length" title="Permalink to this definition">¶</a></dt>

1920

<dd>(DOM) The number of distinct properties that have been explicitly in this declaration block. The range of valid indices is 0 to length-1 inclusive. These are properties with a different <tt class="docutils literal">name</tt> only. <a class="reference internal" href="#cssutils.css.CSSStyleDeclaration.item" title="cssutils.css.CSSStyleDeclaration.item"><tt class="xref py py-meth docutils literal">item()</tt></a> and <a class="reference internal" href="#cssutils.css.CSSStyleDeclaration.length" title="cssutils.css.CSSStyleDeclaration.length"><tt class="xref py py-attr docutils literal">length</tt></a> work on the same set here.

1921

</dd></dl>

1922

1923

1924

1925

<tt class="descname">parentRule</tt><a class="headerlink" href="#cssutils.css.CSSStyleDeclaration.parentRule" title="Permalink to this definition">¶</a></dt>

1926

<dd>(DOM) The CSS rule that contains this declaration block or None if this CSSStyleDeclaration is not attached to a CSSRule.

1927

</dd></dl>

1928

1929

1930

1931

<tt class="descname">removeProperty</tt><big>(</big>name, normalize=True<big>)</big><a class="headerlink" href="#cssutils.css.CSSStyleDeclaration.removeProperty" title="Permalink to this definition">¶</a></dt>

1932

<dd>(DOM)

1933

Used to remove a CSS property if it has been explicitly set within

1934

this declaration block.

1935

1936

1937

1938

1939

<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

1940

<li>name – of the CSS property</li>

1941

<li>normalize – if <tt class="xref docutils literal">True</tt> (DEFAULT) name will be normalized (lowercase, no simple

1942

escapes) so “color”, “COLOR” or “Color” will all be equivalent.

1943

The effective Property value is returned and all Properties

1944

with <tt class="docutils literal">Property.name == name</tt> are removed.

1945

If <tt class="xref docutils literal">False</tt> may return NOT the effective value but the

1946

effective for the unnormalized <cite>name</cite> only. Also only the

1947

Properties with the literal name <cite>name</cite> are removed.

1948

</li>

1949

</ul>

1950

</td>

1951

</tr>

1952

<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the property if it has been explicitly set for

1953

this declaration block. Returns the empty string if the property

1954

has not been set or the property name does not correspond to a

1955

known CSS property

1956

</td>

1957

</tr>

1958

<tr class="field"><th class="field-name">Exceptions :</th><td class="field-body"><ul class="first last simple">

1959

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.NoModificationAllowedErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">NoModificationAllowedErr</tt></a>:

1960

Raised if this declaration is readonly or the property is

1961

readonly.</li>

1962

</ul>

1963

</td>

1964

</tr>

1965

</tbody>

1966

</table>

1967

</dd></dl>

1968

1969

1970

1971

1972

<dd>Internal readonly attribute, DO NOT USE!

1973

</dd></dl>

1974

1975

1976

1977

<tt class="descname">setProperty</tt><big>(</big>name, value=None, priority=u'', normalize=True<big>)</big><a class="headerlink" href="#cssutils.css.CSSStyleDeclaration.setProperty" title="Permalink to this definition">¶</a></dt>

1978

<dd>(DOM) Set a property value and priority within this declaration

1979

block.

1980

1981

1982

1983

1984

<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

1985

<li>name – of the CSS property to set (in W3C DOM the parameter is called

1986

“propertyName”), always lowercase (even if not normalized)

1987

If a property with this <cite>name</cite> is present it will be reset.

1988

cssutils also allowed <cite>name</cite> to be a

1989

<a class="reference internal" href="#cssutils.css.Property" title="cssutils.css.Property"><tt class="xref py py-class docutils literal">Property</tt></a> object, all other

1990

parameter are ignored in this case

1991

</li>

1992

<li>value – the new value of the property, ignored if <cite>name</cite> is a Property.</li>

1993

<li>priority – the optional priority of the property (e.g. “important”),

1994

ignored if <cite>name</cite> is a Property.</li>

1995

<li>normalize – if True (DEFAULT) <cite>name</cite> will be normalized (lowercase, no simple

1996

escapes) so “color”, “COLOR” or “Color” will all be equivalent</li>

1997

</ul>

1998

</td>

1999

</tr>

2000

<tr class="field"><th class="field-name">Exceptions :</th><td class="field-body"><ul class="first last simple">

2001

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.SyntaxErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">SyntaxErr</tt></a>:

2002

Raised if the specified value has a syntax error and is

2003

unparsable.</li>

2004

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.NoModificationAllowedErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">NoModificationAllowedErr</tt></a>:

2005

Raised if this declaration is readonly or the property is

2006

readonly.</li>

2007

</ul>

2008

</td>

2009

</tr>

2010

</tbody>

2011

</table>

2012

</dd></dl>

2013

2014

</dd></dl>

2015

2016

The official DOM provides no method to obtain all values set for a property. Cssutils from 0.9.4 implements the additional method <a class="reference internal" href="#cssutils.css.CSSStyleDeclaration.getProperties" title="cssutils.css.CSSStyleDeclaration.getProperties"><tt class="xref py py-meth docutils literal">getProperties()</tt></a>, example:

2017

<div class="highlight-python"><div class="highlight"><pre>>>> cssText = '''background: white url(paper.png) scroll; /* for all UAs */

2018

... background: white url(ledger.png) fixed; /* for UAs that do fixed backgrounds */

2019

... '''

2020

>>> # omit comments for this example

2021

>>> cssutils.ser.prefs.keepComments = False

2022

>>> style = cssutils.css.CSSStyleDeclaration(cssText=cssText)

2023

>>> print style.cssText

2024

background: white url(paper.png) scroll;

2025

background: white url(ledger.png) fixed;

2026

>>> # work with properties:

2027

>>> proplist = style.getProperties('background', all=True)

2028

>>> proplist

2029

[cssutils.css.Property(name='background', value=u'white url(paper.png) scroll', priority=u''), cssutils.css.Property(name='background', value=u'white url(ledger.png) fixed', priority=u'')]

2030

>>> for prop in proplist: print prop.value

2031

white url(paper.png) scroll

2032

white url(ledger.png) fixed

2033

>>> # overwrite the current property, to overwrite all iterate over proplist

2034

>>> style['background'] = ('red', '!important')

2035

>>> # importance in DOM ist 'important' but '!important' works too

2036

>>> print style['background'], style.getPropertyPriority('background')

2037

red important

2038

>>> print style.cssText

2039

background: white url(paper.png) scroll;

2040

background: red !important;

2041

>>> # output only "effective" properties

2042

>>> cssutils.ser.prefs.keepAllProperties = False

2043

>>> print style.cssText

2044

background: red !important;

2045

</pre></div>

2046

</div>

2047

</div>

2048

2049

<h3><tt class="docutils literal">Property</tt><a class="headerlink" href="#property" title="Permalink to this headline">¶</a></h3>

2050

2051

2052

class <tt class="descclassname">cssutils.css.</tt><tt class="descname">Property</tt><big>(</big>name=None, value=None, priority=u'', _mediaQuery=False, parent=None<big>)</big><a class="headerlink" href="#cssutils.css.Property" title="Permalink to this definition">¶</a></dt>

2053

<dd>A CSS property in a StyleDeclaration of a CSSStyleRule (cssutils).

2054

Format:

2055

<div class="highlight-python"><pre>property = name

2056

: IDENT S*

2057

;

2058

2059

expr = value

2060

: term [ operator term ]*

2061

;

2062

term

2063

: unary_operator?

2064

2065

ANGLE S* | TIME S* | FREQ S* | function ]

2066

| STRING S* | IDENT S* | URI S* | hexcolor

2067

;

2068

function

2069

: FUNCTION S* expr ')' S*

2070

;

2071

/*

2072

* There is a constraint on the color that it must

2073

* have either 3 or 6 hex-digits (i.e., [0-9a-fA-F])

2074

* after the "#"; e.g., "#000" is OK, but "#abcd" is not.

2075

*/

2076

hexcolor

2077

: HASH S*

2078

;

2079

2080

prio

2081

: IMPORTANT_SYM S*

2082

;</pre>

2083

</div>

2084

2085

2086

<tt class="descname">cssText</tt><a class="headerlink" href="#cssutils.css.Property.cssText" title="Permalink to this definition">¶</a></dt>

2087

<dd>A parsable textual representation.

2088

</dd></dl>

2089

2090

2091

2092

<tt class="descname">cssValue</tt><a class="headerlink" href="#cssutils.css.Property.cssValue" title="Permalink to this definition">¶</a></dt>

2093

<dd>(cssutils) CSSValue object of this property

2094

</dd></dl>

2095

2096

2097

2098

<tt class="descname">literalname</tt><a class="headerlink" href="#cssutils.css.Property.literalname" title="Permalink to this definition">¶</a></dt>

2099

<dd>Readonly literal (not normalized) name of this property

2100

</dd></dl>

2101

2102

2103

2104

<tt class="descname">literalpriority</tt><a class="headerlink" href="#cssutils.css.Property.literalpriority" title="Permalink to this definition">¶</a></dt>

2105

<dd>Readonly literal (not normalized) priority of this property

2106

</dd></dl>

2107

2108

2109

2110

2111

<dd>Name of this property.

2112

</dd></dl>

2113

2114

2115

2116

<tt class="descname">parent</tt><a class="headerlink" href="#cssutils.css.Property.parent" title="Permalink to this definition">¶</a></dt>

2117

<dd>The Parent Node (normally a CSSStyledeclaration) of this Property

2118

</dd></dl>

2119

2120

2121

2122

<tt class="descname">priority</tt><a class="headerlink" href="#cssutils.css.Property.priority" title="Permalink to this definition">¶</a></dt>

2123

<dd>Priority of this property.

2124

</dd></dl>

2125

2126

2127

2128

<tt class="descname">valid</tt><a class="headerlink" href="#cssutils.css.Property.valid" title="Permalink to this definition">¶</a></dt>

2129

<dd>Check if value of this property is valid in the properties context.

2130

</dd></dl>

2131

2132

2133

2134

<tt class="descname">validate</tt><big>(</big><big>)</big><a class="headerlink" href="#cssutils.css.Property.validate" title="Permalink to this definition">¶</a></dt>

2135

<dd>Validate value against <cite>profiles</cite> which are checked dynamically.

2136

properties in e.g. @font-face rules are checked against

2137

<tt class="docutils literal">cssutils.profile.CSS3_FONT_FACE</tt> only.

2138

For each of the following cases a message is reported:

2139

<ul>

2140

2141

<dt>INVALID (so the property is known but not valid)</dt>

2142

<dd><tt class="docutils literal">ERROR    Property: Invalid value for "{PROFILE-1[/PROFILE-2...]"

2143

property: ...</tt>

2144

</dd>

2145

</dl>

2146

</li>

2147

2148

<dt>VALID but not in given profiles or defaultProfiles</dt>

2149

<dd><tt class="docutils literal">WARNING    Property: Not valid for profile "{PROFILE-X}" but valid

2150

"{PROFILE-Y}" property: ...</tt>

2151

</dd>

2152

</dl>

2153

</li>

2154

2155

<dt>VALID in current profile</dt>

2156

<dd><tt class="docutils literal">DEBUG    Found valid "{PROFILE-1[/PROFILE-2...]" property...</tt>

2157

</dd>

2158

</dl>

2159

</li>

2160

2161

<dt>UNKNOWN property</dt>

2162

<dd><tt class="docutils literal">WARNING    Unknown Property name...</tt> is issued

2163

</dd>

2164

</dl>

2165

</li>

2166

</ul>

2167

so for example:

2168

<div class="highlight-python"><pre>cssutils.log.setLevel(logging.DEBUG)

2169

parser = cssutils.CSSParser()

2170

s = parser.parseString('''body {

2171

unknown-property: x;

2172

color: 4;

2173

color: rgba(1,2,3,4);

2174

color: red

2175

}''')

2176

2177

# Log output:

2178

2179

WARNING Property: Unknown Property name. [2:9: unknown-property]

2180

ERROR Property: Invalid value for "CSS Color Module Level 3/CSS Level 2.1" property: 4 [3:9: color]

2181

DEBUG Property: Found valid "CSS Color Module Level 3" value: rgba(1, 2, 3, 4) [4:9: color]

2182

DEBUG Property: Found valid "CSS Level 2.1" value: red [5:9: color]</pre>

2183

</div>

2184

and when setting an explicit default profile:

2185

<div class="highlight-python"><pre>cssutils.profile.defaultProfiles = cssutils.profile.CSS_LEVEL_2

2186

s = parser.parseString('''body {

2187

unknown-property: x;

2188

color: 4;

2189

color: rgba(1,2,3,4);

2190

color: red

2191

}''')

2192

2193

# Log output:

2194

2195

WARNING Property: Unknown Property name. [2:9: unknown-property]

2196

ERROR Property: Invalid value for "CSS Color Module Level 3/CSS Level 2.1" property: 4 [3:9: color]

2197

WARNING Property: Not valid for profile "CSS Level 2.1" but valid "CSS Color Module Level 3" value: rgba(1, 2, 3, 4) [4:9: color]

2198

DEBUG Property: Found valid "CSS Level 2.1" value: red [5:9: color]</pre>

2199

</div>

2200

</dd></dl>

2201

2202

2203

2204

<tt class="descname">value</tt><a class="headerlink" href="#cssutils.css.Property.value" title="Permalink to this definition">¶</a></dt>

2205

<dd>The textual value of this Properties cssValue.

2206

</dd></dl>

2207

2208

</dd></dl>

2209

2210

</div>

2211

2212

<h3>Values<a class="headerlink" href="#values" title="Permalink to this headline">¶</a></h3>

2213

2214

<h4><tt class="docutils literal">CSSValue</tt><a class="headerlink" href="#cssvalue" title="Permalink to this headline">¶</a></h4>

2215

2216

2217

class <tt class="descclassname">cssutils.css.</tt><tt class="descname">CSSValue</tt><big>(</big>cssText=None, parent=None, readonly=False<big>)</big><a class="headerlink" href="#cssutils.css.CSSValue" title="Permalink to this definition">¶</a></dt>

2218

<dd>The CSSValue interface represents a simple or a complex value.

2219

A CSSValue object only occurs in a context of a CSS property.

2220

2221

2222

<tt class="descname">cssText</tt><a class="headerlink" href="#cssutils.css.CSSValue.cssText" title="Permalink to this definition">¶</a></dt>

2223

<dd>A string representation of the current value.

2224

</dd></dl>

2225

2226

2227

2228

<tt class="descname">cssValueType</tt><a class="headerlink" href="#cssutils.css.CSSValue.cssValueType" title="Permalink to this definition">¶</a></dt>

2229

<dd>A (readonly) code defining the type of the value.

2230

</dd></dl>

2231

2232

2233

2234

<tt class="descname">cssValueTypeString</tt><a class="headerlink" href="#cssutils.css.CSSValue.cssValueTypeString" title="Permalink to this definition">¶</a></dt>

2235

<dd>(readonly) Name of cssValueType.

2236

</dd></dl>

2237

2238

2239

2240

2241

<dd>Internal readonly attribute, DO NOT USE!

2242

</dd></dl>

2243

2244

</dd></dl>

2245

2246

</div>

2247

2248

<h4><tt class="docutils literal">CSSPrimitiveValue</tt><a class="headerlink" href="#cssprimitivevalue" title="Permalink to this headline">¶</a></h4>

2249

2250

2251

class <tt class="descclassname">cssutils.css.</tt><tt class="descname">CSSPrimitiveValue</tt><big>(</big>cssText=None, parent=None, readonly=False<big>)</big><a class="headerlink" href="#cssutils.css.CSSPrimitiveValue" title="Permalink to this definition">¶</a></dt>

2252

<dd>Represents a single CSS Value. May be used to determine the value of a

2253

specific style property currently set in a block or to set a specific

2254

style property explicitly within the block. Might be obtained from the

2255

getPropertyCSSValue method of CSSStyleDeclaration.

2256

Conversions are allowed between absolute values (from millimeters to

2257

centimeters, from degrees to radians, and so on) but not between

2258

relative values. (For example, a pixel value cannot be converted to a

2259

centimeter value.) Percentage values can’t be converted since they are

2260

relative to the parent value (or another property value). There is one

2261

exception for color percentage values: since a color percentage value

2262

is relative to the range 0-255, a color percentage value can be

2263

converted to a number; (see also the RGBColor interface).

2264

2265

2266

<tt class="descname">cssText</tt><a class="headerlink" href="#cssutils.css.CSSPrimitiveValue.cssText" title="Permalink to this definition">¶</a></dt>

2267

<dd>A string representation of the current value.

2268

</dd></dl>

2269

2270

2271

2272

<tt class="descname">cssValueTypeString</tt><a class="headerlink" href="#cssutils.css.CSSPrimitiveValue.cssValueTypeString" title="Permalink to this definition">¶</a></dt>

2273

<dd>(readonly) Name of cssValueType.

2274

</dd></dl>

2275

2276

2277

2278

<tt class="descname">getCounterValue</tt><big>(</big><big>)</big><a class="headerlink" href="#cssutils.css.CSSPrimitiveValue.getCounterValue" title="Permalink to this definition">¶</a></dt>

2279

<dd>(DOM) This method is used to get the Counter value. If

2280

this CSS value doesn’t contain a counter value, a DOMException

2281

is raised. Modification to the corresponding style property

2282

can be achieved using the Counter interface.

2283

Not implemented.

2284

</dd></dl>

2285

2286

2287

2288

<tt class="descname">getFloatValue</tt><big>(</big>unitType=None<big>)</big><a class="headerlink" href="#cssutils.css.CSSPrimitiveValue.getFloatValue" title="Permalink to this definition">¶</a></dt>

2289

<dd>(DOM) This method is used to get a float value in a

2290

specified unit. If this CSS value doesn’t contain a float value

2291

or can’t be converted into the specified unit, a DOMException

2292

is raised.

2293

2294

2295

2296

2297

<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

2298

<li>unitType – to get the float value. The unit code can only be a float unit type

2299

(i.e. CSS_NUMBER, CSS_PERCENTAGE, CSS_EMS, CSS_EXS, CSS_PX, CSS_CM,

2300

CSS_MM, CSS_IN, CSS_PT, CSS_PC, CSS_DEG, CSS_RAD, CSS_GRAD, CSS_MS,

2301

CSS_S, CSS_HZ, CSS_KHZ, CSS_DIMENSION) or None in which case

2302

the current dimension is used.</li>

2303

</ul>

2304

</td>

2305

</tr>

2306

<tr class="field"><th class="field-name">Returns:</th><td class="field-body">not necessarily a float but some cases just an integer

2307

e.g. if the value is <tt class="docutils literal">1px</tt> it return <tt class="docutils literal">1</tt> and not <tt class="docutils literal">1.0</tt>

2308

Conversions might return strange values like 1.000000000001

2309

2310

</td>

2311

</tr>

2312

</tbody>

2313

</table>

2314

</dd></dl>

2315

2316

2317

2318

<tt class="descname">getRGBColorValue</tt><big>(</big><big>)</big><a class="headerlink" href="#cssutils.css.CSSPrimitiveValue.getRGBColorValue" title="Permalink to this definition">¶</a></dt>

2319

<dd>(DOM) This method is used to get the RGB color. If this

2320

CSS value doesn’t contain a RGB color value, a DOMException

2321

is raised. Modification to the corresponding style property

2322

can be achieved using the RGBColor interface.

2323

</dd></dl>

2324

2325

2326

2327

<tt class="descname">getRectValue</tt><big>(</big><big>)</big><a class="headerlink" href="#cssutils.css.CSSPrimitiveValue.getRectValue" title="Permalink to this definition">¶</a></dt>

2328

<dd>(DOM) This method is used to get the Rect value. If this CSS

2329

value doesn’t contain a rect value, a DOMException is raised.

2330

Modification to the corresponding style property can be achieved

2331

using the Rect interface.

2332

Not implemented.

2333

</dd></dl>

2334

2335

2336

2337

<tt class="descname">getStringValue</tt><big>(</big><big>)</big><a class="headerlink" href="#cssutils.css.CSSPrimitiveValue.getStringValue" title="Permalink to this definition">¶</a></dt>

2338

<dd>(DOM) This method is used to get the string value. If the

2339

CSS value doesn’t contain a string value, a DOMException is raised.

2340

Some properties (like ‘font-family’ or ‘voice-family’)

2341

convert a whitespace separated list of idents to a string.

2342

Only the actual value is returned so e.g. all the following return the

2343

actual value <tt class="docutils literal">a</tt>: url(a), attr(a), “a”, ‘a’

2344

</dd></dl>

2345

2346

2347

2348

<tt class="descname">primitiveType</tt><a class="headerlink" href="#cssutils.css.CSSPrimitiveValue.primitiveType" title="Permalink to this definition">¶</a></dt>

2349

<dd>(readonly) The type of the value as defined by the constants in this class.

2350

</dd></dl>

2351

2352

2353

2354

<tt class="descname">primitiveTypeString</tt><a class="headerlink" href="#cssutils.css.CSSPrimitiveValue.primitiveTypeString" title="Permalink to this definition">¶</a></dt>

2355

<dd>Name of primitive type of this value.

2356

</dd></dl>

2357

2358

2359

2360

2361

<dd>Internal readonly attribute, DO NOT USE!

2362

</dd></dl>

2363

2364

2365

2366

<tt class="descname">setFloatValue</tt><big>(</big>unitType, floatValue<big>)</big><a class="headerlink" href="#cssutils.css.CSSPrimitiveValue.setFloatValue" title="Permalink to this definition">¶</a></dt>

2367

<dd>(DOM) A method to set the float value with a specified unit.

2368

If the property attached with this value can not accept the

2369

specified unit or the float value, the value will be unchanged and

2370

a DOMException will be raised.

2371

2372

2373

2374

2375

<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

2376

<li>unitType – a unit code as defined above. The unit code can only be a float

2377

unit type</li>

2378

<li>floatValue – the new float value which does not have to be a float value but

2379

may simple be an int e.g. if setting:

2380

<div class="highlight-python"><div class="highlight"><pre>setFloatValue(CSS_PX, 1)

2381

</pre></div>

2382

</div>

2383

</li>

2384

</ul>

2385

</td>

2386

</tr>

2387

<tr class="field"><th class="field-name">Exceptions :</th><td class="field-body"><ul class="first last simple">

2388

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.InvalidAccessErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">InvalidAccessErr</tt></a>:

2389

Raised if the attached property doesn’t

2390

support the float value or the unit type.</li>

2391

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.NoModificationAllowedErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">NoModificationAllowedErr</tt></a>:

2392

Raised if this property is readonly.</li>

2393

</ul>

2394

</td>

2395

</tr>

2396

</tbody>

2397

</table>

2398

</dd></dl>

2399

2400

2401

2402

<tt class="descname">setStringValue</tt><big>(</big>stringType, stringValue<big>)</big><a class="headerlink" href="#cssutils.css.CSSPrimitiveValue.setStringValue" title="Permalink to this definition">¶</a></dt>

2403

<dd>(DOM) A method to set the string value with the specified

2404

unit. If the property attached to this value can’t accept the

2405

specified unit or the string value, the value will be unchanged and

2406

a DOMException will be raised.

2407

2408

2409

2410

2411

<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

2412

<li>stringType – a string code as defined above. The string code can only be a

2413

string unit type (i.e. CSS_STRING, CSS_URI, CSS_IDENT, and

2414

CSS_ATTR).</li>

2415

<li>stringValue – the new string value

2416

Only the actual value is expected so for (CSS_URI, “a”) the

2417

new value will be <tt class="docutils literal">url(a)</tt>. For (CSS_STRING, “‘a’”)

2418

the new value will be <tt class="docutils literal">"\'a\'"</tt> as the surrounding <tt class="docutils literal">'</tt> are

2419

not part of the string value</li>

2420

</ul>

2421

</td>

2422

</tr>

2423

<tr class="field"><th class="field-name">Exceptions :</th><td class="field-body"><ul class="first last simple">

2424

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.InvalidAccessErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">InvalidAccessErr</tt></a>:

2425

Raised if the CSS value doesn’t contain a

2426

string value or if the string value can’t be converted into

2427

the specified unit.</li>

2428

<li><a class="reference external" href="http://docs.python.org/dev/library/xml.dom.html#xml.dom.NoModificationAllowedErr" title="(in Python v3.2)"><tt class="xref py py-exc docutils literal">NoModificationAllowedErr</tt></a>:

2429

Raised if this property is readonly.</li>

2430

</ul>

2431

</td>

2432

</tr>

2433

</tbody>

2434

</table>

2435

</dd></dl>

2436

2437

</dd></dl>

2438

2439

</div>

2440

2441

<h4><tt class="docutils literal">CSSValueList</tt><a class="headerlink" href="#cssvaluelist" title="Permalink to this headline">¶</a></h4>

2442

2443

2444

class <tt class="descclassname">cssutils.css.</tt><tt class="descname">CSSValueList</tt><big>(</big>cssText=None, parent=None, readonly=False<big>)</big><a class="headerlink" href="#cssutils.css.CSSValueList" title="Permalink to this definition">¶</a></dt>

2445

<dd>The CSSValueList interface provides the abstraction of an ordered

2446

collection of CSS values.

2447

Some properties allow an empty list into their syntax. In that case,

2448

these properties take the none identifier. So, an empty list means

2449

that the property has the value none.

2450

The items in the CSSValueList are accessible via an integral index,

2451

starting from 0.

2452

2453

2454

<tt class="descname">cssText</tt><a class="headerlink" href="#cssutils.css.CSSValueList.cssText" title="Permalink to this definition">¶</a></dt>

2455

<dd>A string representation of the current value.

2456

</dd></dl>

2457

2458

2459

2460

<tt class="descname">cssValueTypeString</tt><a class="headerlink" href="#cssutils.css.CSSValueList.cssValueTypeString" title="Permalink to this definition">¶</a></dt>

2461

<dd>(readonly) Name of cssValueType.

2462

</dd></dl>

2463

2464

2465

2466

<tt class="descname">item</tt><big>(</big>index<big>)</big><a class="headerlink" href="#cssutils.css.CSSValueList.item" title="Permalink to this definition">¶</a></dt>

2467

<dd>(DOM) Retrieve a CSSValue by ordinal <cite>index</cite>. The

2468

order in this collection represents the order of the values in the

2469

CSS style property. If <cite>index</cite> is greater than or equal to the number

2470

of values in the list, this returns <tt class="xref docutils literal">None</tt>.

2471

</dd></dl>

2472

2473

2474

2475

<tt class="descname">length</tt><a class="headerlink" href="#cssutils.css.CSSValueList.length" title="Permalink to this definition">¶</a></dt>

2476

<dd>(DOM attribute) The number of CSSValues in the list.

2477

</dd></dl>

2478

2479

2480

2481

2482

<dd>Internal readonly attribute, DO NOT USE!

2483

</dd></dl>

2484

2485

</dd></dl>

2486

2487

</div>

2488

2489

<h4><tt class="docutils literal">CSSFunction</tt><a class="headerlink" href="#cssfunction" title="Permalink to this headline">¶</a></h4>

2490

2491

2492

class <tt class="descclassname">cssutils.css.cssvalue.</tt><tt class="descname">CSSFunction</tt><big>(</big>cssText=None, parent=None, readonly=False<big>)</big><a class="headerlink" href="#cssutils.css.cssvalue.CSSFunction" title="Permalink to this definition">¶</a></dt>

2493

<dd>A CSS function value like rect() etc.

2494

</dd></dl>

2495

2496

</div>

2497

2498

<h4><tt class="docutils literal">CSSVariable</tt><a class="headerlink" href="#cssvariable" title="Permalink to this headline">¶</a></h4>

2499

2500

2501

class <tt class="descclassname">cssutils.css.</tt><tt class="descname">CSSVariable</tt><big>(</big>cssText=None, parent=None, readonly=False<big>)</big><a class="headerlink" href="#cssutils.css.CSSVariable" title="Permalink to this definition">¶</a></dt>

2502

<dd>The CSSVariable represents a call to CSS Variable.

2503

2504

2505

<tt class="descname">cssText</tt><a class="headerlink" href="#cssutils.css.CSSVariable.cssText" title="Permalink to this definition">¶</a></dt>

2506

<dd>A string representation of the current variable.

2507

</dd></dl>

2508

2509

2510

2511

<tt class="descname">cssValueTypeString</tt><a class="headerlink" href="#cssutils.css.CSSVariable.cssValueTypeString" title="Permalink to this definition">¶</a></dt>

2512

<dd>(readonly) Name of cssValueType.

2513

</dd></dl>

2514

2515

2516

2517

2518

<dd>Internal readonly attribute, DO NOT USE!

2519

</dd></dl>

2520

2521

2522

2523

<tt class="descname">value</tt><a class="headerlink" href="#cssutils.css.CSSVariable.value" title="Permalink to this definition">¶</a></dt>

2524

<dd>Find contained sheet and @variables there

2525

</dd></dl>

2526

2527

</dd></dl>

2528

2529

</div>

2530

2531

<h4><tt class="docutils literal">ExpressionValue</tt><a class="headerlink" href="#expressionvalue" title="Permalink to this headline">¶</a></h4>

2532

2533

2534

class <tt class="descclassname">cssutils.css.cssvalue.</tt><tt class="descname">ExpressionValue</tt><big>(</big>cssText=None, parent=None, readonly=False<big>)</big><a class="headerlink" href="#cssutils.css.cssvalue.ExpressionValue" title="Permalink to this definition">¶</a></dt>

2535

<dd>Special IE only CSSFunction which may contain anything.

2536

Used for expressions and <tt class="docutils literal">alpha(opacity=100)</tt> currently.

2537

2538

2539

<tt class="descname">cssText</tt><a class="headerlink" href="#cssutils.css.cssvalue.ExpressionValue.cssText" title="Permalink to this definition">¶</a></dt>

2540

<dd>A string representation of the current value.

2541

</dd></dl>

2542

2543

</dd></dl>

2544

2545

</div>

2546

</div>

2547

</div>

2548

2549

<h2>Additional Info<a class="headerlink" href="#additional-info" title="Permalink to this headline">¶</a></h2>

2550

Some classes in this package support standard Python idioms like iteration on certain attributes:

2551

<div class="highlight-python"><div class="highlight"><pre>>>> import cssutils

2552

>>> sheet = cssutils.css.CSSStyleSheet()

2553

>>> sheet.cssText = '@charset "ascii";a { color: green }'

2554

>>> for rule in sheet:

2555

... print rule

2556

...

2557

<cssutils.css.CSSCharsetRule object encoding='ascii' at 0x2ce7

2558

<cssutils.css.CSSStyleRule object selector=u'a' style=u'color:

2559

s=<cssutils.util._Namespaces object at 0x02CE7B30> at 0x2ce7d3

2560

</pre></div>

2561

</div>

2562

<tt class="docutils literal">for in</tt> is supported by <a class="reference internal" href="#cssutils.css.CSSStyleSheet" title="cssutils.css.CSSStyleSheet"><tt class="xref py py-class docutils literal">CSSStyleSheet</tt></a> and <a class="reference internal" href="#cssutils.css.CSSMediaRule" title="cssutils.css.CSSMediaRule"><tt class="xref py py-class docutils literal">CSSMediaRule</tt></a> (iterating over the contained <a class="reference internal" href="#cssutils.css.CSSRule" title="cssutils.css.CSSRule"><tt class="xref py py-class docutils literal">CSSRule</tt></a> objects, <a class="reference internal" href="#cssutils.css.CSSStyleDeclaration" title="cssutils.css.CSSStyleDeclaration"><tt class="xref py py-class docutils literal">CSSStyleDeclaration</tt></a> (over the names of the contained <a class="reference internal" href="#cssutils.css.Property" title="cssutils.css.Property"><tt class="xref py py-class docutils literal">Property</tt></a> objects), <a class="reference internal" href="#cssutils.css.CSSValueList" title="cssutils.css.CSSValueList"><tt class="xref py py-class docutils literal">CSSValueList</tt></a> (over the <a class="reference internal" href="#cssutils.css.CSSValue" title="cssutils.css.CSSValue"><tt class="xref py py-class docutils literal">CSSValue</tt></a> objects in the list).

2563

</div>

2564

</div>

2565

2566

2567

</div>

2568

</div>

2569

</div>

2570

2571

2572

<h3><a href="../index.html">Table Of Contents</a></h3>

2573

<ul>

2574

<li><a class="reference internal" href="#">Package <tt class="docutils literal">cssutils.css</tt></a><ul>

2575

<li><a class="reference internal" href="#cssstylesheet"><tt class="docutils literal">CSSStyleSheet</tt></a></li>

2576

<li><a class="reference internal" href="#css-rules">CSS rules</a><ul>

2577

<li><a class="reference internal" href="#cssrule"><tt class="docutils literal">CSSRule</tt></a></li>

2578

<li><a class="reference internal" href="#cssrulelist"><tt class="docutils literal">CSSRuleList</tt></a></li>

2579

<li><a class="reference internal" href="#csscharsetrule"><tt class="docutils literal">CSSCharsetRule</tt></a></li>

2580

<li><a class="reference internal" href="#cssfontfacerule"><tt class="docutils literal">CSSFontFaceRule</tt></a></li>

2581

<li><a class="reference internal" href="#cssimportrule"><tt class="docutils literal">CSSImportRule</tt></a></li>

2582

<li><a class="reference internal" href="#cssmediarule"><tt class="docutils literal">CSSMediaRule</tt></a></li>

2583

<li><a class="reference internal" href="#cssnamespacerule"><tt class="docutils literal">CSSNamespaceRule</tt></a></li>

2584

<li><a class="reference internal" href="#csspagerule"><tt class="docutils literal">CSSPageRule</tt></a></li>

2585

<li><a class="reference internal" href="#cssstylerule"><tt class="docutils literal">CSSStyleRule</tt></a></li>

2586

<li><a class="reference internal" href="#cssvariablesrule"><tt class="docutils literal">CSSVariablesRule</tt></a></li>

2587

<li><a class="reference internal" href="#csscomment"><tt class="docutils literal">CSSComment</tt></a></li>

2588

</ul>

2589

</li>

2590

<li><a class="reference internal" href="#selector-related-classes-selectorlist-and-selector">Selector related classes: <tt class="docutils literal">SelectorList</tt> and <tt class="docutils literal">Selector</tt></a><ul>

2591

<li><a class="reference internal" href="#selectorlist"><tt class="docutils literal">SelectorList</tt></a></li>

2592

<li><a class="reference internal" href="#selector"><tt class="docutils literal">Selector</tt></a></li>

2593

</ul>

2594

</li>

2595

<li><a class="reference internal" href="#style-related-classes-cssstyledeclaration-property-cssvalue-etc">Style related classes: <tt class="docutils literal">CSSStyleDeclaration</tt>, <tt class="docutils literal">Property</tt>, <tt class="docutils literal">CSSValue</tt> etc</a><ul>

2596

<li><a class="reference internal" href="#cssvariablesdeclaration"><tt class="docutils literal">CSSVariablesDeclaration</tt></a></li>

2597

<li><a class="reference internal" href="#cssstyledeclaration"><tt class="docutils literal">CSSStyleDeclaration</tt></a></li>

2598

<li><a class="reference internal" href="#property"><tt class="docutils literal">Property</tt></a></li>

2599

<li><a class="reference internal" href="#values">Values</a><ul>

2600

<li><a class="reference internal" href="#cssvalue"><tt class="docutils literal">CSSValue</tt></a></li>

2601

<li><a class="reference internal" href="#cssprimitivevalue"><tt class="docutils literal">CSSPrimitiveValue</tt></a></li>

2602

<li><a class="reference internal" href="#cssvaluelist"><tt class="docutils literal">CSSValueList</tt></a></li>

2603

<li><a class="reference internal" href="#cssfunction"><tt class="docutils literal">CSSFunction</tt></a></li>

2604

<li><a class="reference internal" href="#cssvariable"><tt class="docutils literal">CSSVariable</tt></a></li>

2605

<li><a class="reference internal" href="#expressionvalue"><tt class="docutils literal">ExpressionValue</tt></a></li>

2606

</ul>

2607

</li>

2608

</ul>

2609

</li>

2610

<li><a class="reference internal" href="#additional-info">Additional Info</a></li>

2611

</ul>

2612

</li>

2613

</ul>

2614

2615

<h4>Previous topic</h4>

2616

<a href="serialize.html"

2617

title="previous chapter">serializing CSS</a>

2618

<h4>Next topic</h4>

2619

<a href="stylesheets.html"

2620

title="next chapter">Package <tt class="docutils literal">cssutils.stylesheets</tt></a>

2621

2622

2623

<li><a href="../_sources/docs/css.txt"

2624

rel="nofollow">Show Source</a></li>

2625

</ul>

2626

2627

<h3>Quick search</h3>

2628

2629

2630

2631

2632

2633

</form>

2634

2635

Enter search terms or a module, class or function name.

2636

2637

</div>

2638

2639

</div>

2640

</div>

2641

2642

</div>

2643

2644

<h3>Navigation</h3>

2645

<ul>

2646

2647

<a href="../genindex.html" title="General Index"

2648

>index</a></li>

2649

2650

<a href="../py-modindex.html" title="Python Module Index"

2651

>modules</a> |</li>

2652

2653

<a href="stylesheets.html" title="Package cssutils.stylesheets"

2654

>next</a> |</li>

2655

2656

<a href="serialize.html" title="serializing CSS"

2657

>previous</a> |</li>

2658

<li><a href="../index.html">cssutils v0.9.7b4 documentation</a> »</li>

2659

</ul>

2660

</div>

2661

2662

2663

Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.4.

2664

</div>

2665

</body>

2666

</html>

b'\\ No newline at end of file'