%
% API Documentation for cssutils
% Module cssutils.css.csscharsetrule
%
% Generated by epydoc 3.0.1
% [Fri Feb 01 19:05:21 2008]
%

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                          Module Description                           %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    \index{cssutils \textit{(package)}!cssutils.css \textit{(package)}!cssutils.css.csscharsetrule \textit{(module)}|(}
\section{Module cssutils.css.csscharsetrule}

    \label{cssutils:css:csscharsetrule}

CSSCharsetRule implements DOM Level 2 CSS CSSCharsetRule.
\begin{description}
\item[{TODO:}] \leavevmode \begin{itemize}
\item {} 
check specific allowed syntaxes

\item {} 
check encoding syntax and not codecs.lookup?

\end{itemize}

\end{description}
\textbf{Version:} \$LastChangedRevision: 950 \$



\textbf{Date:} \$LastChangedDate: 2008-01-27 17:28:41 +0100 (So, 27 Jan 2008) \$



\textbf{Author:} \$LastChangedBy: cthedot \$




%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                           Class Description                           %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    \index{cssutils \textit{(package)}!cssutils.css \textit{(package)}!cssutils.css.csscharsetrule \textit{(module)}!cssutils.css.csscharsetrule.CSSCharsetRule \textit{(class)}|(}
\subsection{Class CSSCharsetRule}

    \label{cssutils:css:csscharsetrule:CSSCharsetRule}
\begin{tabular}{cccccccccc}
% Line for object, linespec=[False, False, False]
\multicolumn{2}{r}{\settowidth{\BCL}{object}\multirow{2}{\BCL}{object}}
&&
&&
&&
  \\\cline{3-3}
  &&\multicolumn{1}{c|}{}
&&
&&
&&
  \\
% Line for cssutils.util.Base, linespec=[False, False]
\multicolumn{4}{r}{\settowidth{\BCL}{cssutils.util.Base}\multirow{2}{\BCL}{cssutils.util.Base}}
&&
&&
  \\\cline{5-5}
  &&&&\multicolumn{1}{c|}{}
&&
&&
  \\
% Line for cssutils.css.cssrule.CSSRule, linespec=[False]
\multicolumn{6}{r}{\settowidth{\BCL}{cssutils.css.cssrule.CSSRule}\multirow{2}{\BCL}{cssutils.css.cssrule.CSSRule}}
&&
  \\\cline{7-7}
  &&&&&&\multicolumn{1}{c|}{}
&&
  \\
&&&&&&\multicolumn{2}{l}{\textbf{cssutils.css.csscharsetrule.CSSCharsetRule}}
\end{tabular}


The CSSCharsetRule interface represents an @charset rule in a CSS style
sheet. The value of the encoding attribute does not affect the encoding
of text data in the DOM objects; this encoding is always UTF-16
(also in Python?). After a stylesheet is loaded, the value of the
encoding attribute is the value found in the @charset rule. If there
was no @charset in the original document, then no CSSCharsetRule is
created. The value of the encoding attribute may also be used as a hint
for the encoding used on serialization of the style sheet.

The value of the @charset rule (and therefore of the CSSCharsetRule)
may not correspond to the encoding the document actually came in;
character encoding information e.g. in an HTTP header, has priority
(see CSS document representation) but this is not reflected in the
CSSCharsetRule.


%___________________________________________________________________________

\hypertarget{properties}{}
\pdfbookmark[3]{Properties}{properties}
\paragraph*{Properties}
\label{properties}
\begin{description}
\item[{cssText: of type DOMString}] \leavevmode 
The parsable textual representation of this rule

\item[{encoding: of type DOMString}] \leavevmode 
The encoding information used in this @charset rule.

\end{description}

Inherits properties from CSSRule


%___________________________________________________________________________

\hypertarget{format}{}
\pdfbookmark[3]{Format}{format}
\paragraph*{Format}
\label{format}
\begin{description}
\item[{charsetrule:}] \leavevmode 
CHARSET{\_}SYM S* STRING S* ';'

\item[{BUT: Only valid format is:}] \leavevmode 
@charset ``ENCODING'';

\end{description}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                                Methods                                %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

  \subsubsection{Methods}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{\_\_init\_\_}(\textit{self}, \textit{encoding}={\tt None}, \textit{parentRule}={\tt None}, \textit{parentStyleSheet}={\tt None}, \textit{readonly}={\tt False})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
\begin{description}
\item[{encoding:}] \leavevmode 
a valid character encoding

\item[{readonly:}] \leavevmode 
defaults to False, not used yet

\end{description}

if readonly allows setting of properties in constructor only
\setlength{\parskip}{1ex}
      Overrides: object.\_\_init\_\_

    \end{boxedminipage}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{\_\_repr\_\_}(\textit{self})

\setlength{\parskip}{2ex}
    repr(x)

\setlength{\parskip}{1ex}
      Overrides: object.\_\_repr\_\_ 	extit{(inherited documentation)}

    \end{boxedminipage}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{\_\_str\_\_}(\textit{self})

\setlength{\parskip}{2ex}
    str(x)

\setlength{\parskip}{1ex}
      Overrides: object.\_\_str\_\_ 	extit{(inherited documentation)}

    \end{boxedminipage}


\large{\textbf{\textit{Inherited from object}}}

\begin{quote}
\_\_delattr\_\_(), \_\_getattribute\_\_(), \_\_hash\_\_(), \_\_new\_\_(), \_\_reduce\_\_(), \_\_reduce\_ex\_\_(), \_\_setattr\_\_()
\end{quote}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                              Properties                               %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

  \subsubsection{Properties}

    \vspace{-1cm}
\hspace{\varindent}\begin{longtable}{|p{\varnamewidth}|p{\vardescrwidth}|l}
\cline{1-2}
\cline{1-2} \centering \textbf{Name} & \centering \textbf{Description}& \\
\cline{1-2}
\endhead\cline{1-2}\multicolumn{3}{r}{\small\textit{continued on next page}}\\\endfoot\cline{1-2}
\endlastfoot\raggedright e\-n\-c\-o\-d\-i\-n\-g\- & \raggedright (DOM)The encoding information used in this @charset rule.&\\
\cline{1-2}
\raggedright c\-s\-s\-T\-e\-x\-t\- & \raggedright (DOM) The parsable textual representation.&\\
\cline{1-2}
\multicolumn{2}{|l|}{\textit{Inherited from cssutils.css.cssrule.CSSRule \textit{(Section \ref{cssutils:css:cssrule:CSSRule})}}}\\
\multicolumn{2}{|p{\varwidth}|}{\raggedright parentRule, parentStyleSheet, typeString}\\
\cline{1-2}
\multicolumn{2}{|l|}{\textit{Inherited from object}}\\
\multicolumn{2}{|p{\varwidth}|}{\raggedright \_\_class\_\_}\\
\cline{1-2}
\end{longtable}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                            Class Variables                            %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

  \subsubsection{Class Variables}

    \vspace{-1cm}
\hspace{\varindent}\begin{longtable}{|p{\varnamewidth}|p{\vardescrwidth}|l}
\cline{1-2}
\cline{1-2} \centering \textbf{Name} & \centering \textbf{Description}& \\
\cline{1-2}
\endhead\cline{1-2}\multicolumn{3}{r}{\small\textit{continued on next page}}\\\endfoot\cline{1-2}
\endlastfoot\raggedright t\-y\-p\-e\- & \raggedright The type of this rule, as defined by a CSSRule type constant.
Overwritten in derived classes.

The expectation is that binding-specific casting methods can be used to
cast down from an instance of the CSSRule interface to the specific
derived interface implied by the type.
(Casting not for this Python implementation I guess...)

\textbf{Value:} 
{\tt 2}&\\
\cline{1-2}
\multicolumn{2}{|l|}{\textit{Inherited from cssutils.css.cssrule.CSSRule \textit{(Section \ref{cssutils:css:cssrule:CSSRule})}}}\\
\multicolumn{2}{|p{\varwidth}|}{\raggedright CHARSET\_RULE, COMMENT, FONT\_FACE\_RULE, IMPORT\_RULE, MEDIA\_RULE, NAMESPACE\_RULE, PAGE\_RULE, STYLE\_RULE, UNKNOWN\_RULE}\\
\cline{1-2}
\end{longtable}

    \index{cssutils \textit{(package)}!cssutils.css \textit{(package)}!cssutils.css.csscharsetrule \textit{(module)}!cssutils.css.csscharsetrule.CSSCharsetRule \textit{(class)}|)}
    \index{cssutils \textit{(package)}!cssutils.css \textit{(package)}!cssutils.css.csscharsetrule \textit{(module)}|)}
