PXP Reference : Index of class methods

# Index of class methods

A
add [Pxp_tree_parser.index] | Add the passed node to the index.
add [Pxp_tree_parser.hash_index] | Add the passed node to the index.
add_attribute [Pxp_dtd.dtd_element] | `add_attribute name type default extdecl`: add an attribute declaration for an attribute with the given name, type, and default value.
add_element [Pxp_dtd.dtd] | add the given element declaration to this DTD.
add_gen_entity [Pxp_dtd.dtd] | `add_gen_entity e extdecl`: add the entity `e` as general entity to this DTD (general entities are those represented by `&name;`).
add_namespace [Pxp_dtd.namespace_manager] | `add_namespace np uri`: adds a new namespace to the object.
add_notation [Pxp_dtd.dtd] | add the given notation to this DTD.
add_par_entity [Pxp_dtd.dtd] | add the given entity as parameter entity to this DTD (parameter entities are those represented by %name;).
add_pinstr [Pxp_dtd.dtd] | add the given processing instruction to this DTD.
add_uri [Pxp_dtd.namespace_manager] | `add_uri np uri`: adds `uri` as alias URI to the namespace identified by the normprefix `np` (see above for detailed semantics).
allow_arbitrary [Pxp_dtd.dtd_element] | This method sets the `arbitrary_allowed` flag for this element.
allow_arbitrary [Pxp_dtd.dtd] | This method sets the `arbitrary_allowed` flag.
arbitrary_allowed [Pxp_dtd.dtd_element] | Returns whether arbitrary attributes are allowed or not.
arbitrary_allowed [Pxp_dtd.dtd] | Returns whether arbitrary contents are allowed or not.
as_declaration [Pxp_dtd.namespace_manager] | Returns the list of normprefixes and primary URIs.
attribute [Pxp_dtd.dtd_element] | get the type and default value of a declared attribute, or raise `Validation_error` if the attribute does not exist.
attribute_names [Pxp_dtd.dtd_element] | get the list of all declared attributes
attribute_violates_standalone_declaration [Pxp_dtd.dtd_element] | `attribute_violates_standalone_declaration name v`: Checks whether the attribute `name` violates the standalone declaration if it has value `v`.
C
content_dfa [Pxp_dtd.dtd_element] | return the DFA of the content model if there is a DFA, or `None`.
content_model [Pxp_dtd.dtd_element] | get the content model of this element declaration, or `Unspecified`
D
declaration [Pxp_dtd.namespace_scope] | Returns the list of namespace declarations of this scope (i.e.
disallow_arbitrary [Pxp_dtd.dtd_element] | Clears the `arbitrary_allowed` flag
disallow_arbitrary [Pxp_dtd.dtd] | Clears the `arbitrary_allowed` flag again
display_prefix_of_normprefix [Pxp_dtd.namespace_scope] | Translates the normalized prefix to the corresponding display prefix as declared in this object or any parent object.
display_prefix_of_uri [Pxp_dtd.namespace_scope] | Translates the URI to the corresponding display prefix as declared in this object or any parent object.
E
effective_declaration [Pxp_dtd.namespace_scope] | Returns the list of namespace declarations of this scope and all parent scopes.
element [Pxp_dtd.dtd] | looks up the element declaration with the given name.
element_names [Pxp_dtd.dtd] | returns the list of the names of all element declarations.
encoding [Pxp_dtd.proc_instruction] |
encoding [Pxp_dtd.dtd_notation] |
encoding [Pxp_dtd.dtd_element] | Return the encoding of the strings
encoding [Pxp_dtd.dtd] | returns the encoding used for character representation
ext_id [Pxp_dtd.dtd_notation] |
externally_declared [Pxp_dtd.dtd_element] | returns whether the element declaration occurs in an external entity.
F
find [Pxp_tree_parser.index] | Finds the node with the passed ID value, or raises `Not_found`
find [Pxp_tree_parser.hash_index] | Finds the node with the passed ID value, or raises `Not_found`
G
gen_entity [Pxp_dtd.dtd] | `let e, extdecl = obj # gen_entity n`: looks up the general entity `e` with the name `n`.
gen_entity_names [Pxp_dtd.dtd] | returns the list of all general entity names
get_normprefix [Pxp_dtd.namespace_manager] | Return the normprefix for a URI, or raises `Namespace_not_managed`.
get_primary_uri [Pxp_dtd.namespace_manager] | Return the primary URI for a normprefix, or raises `Namespace_prefix_not_managed`.
get_uri_list [Pxp_dtd.namespace_manager] | Return all URIs for a normprefix, or `[]` if the normprefix is unused.
I
id [Pxp_dtd.dtd] | get the identifier for this DTD.
id_attribute_name [Pxp_dtd.dtd_element] | Returns the name of the attribute with type ID, or `None`.
idref_attribute_names [Pxp_dtd.dtd_element] | Returns the names of the attributes with type IDREF or IDREFS.
index [Pxp_tree_parser.hash_index] | Returns the hash table mapping IDs to nodes.
iter_namespaces [Pxp_dtd.namespace_manager] | Iterates over all namespaces contained in the object, and calls the passed function for every namespace.
L
lexer_factory [Pxp_dtd.dtd] | Returns a lexer factory for the character encoding
lookup_or_add_namespace [Pxp_dtd.namespace_manager] | `lookup_or_add_namespace p uri`: first, the method looks up if the namespace for `uri` does already exist.
N
name [Pxp_dtd.dtd_notation] |
name [Pxp_dtd.dtd_element] | returns the name of the declared element
names_of_required_attributes [Pxp_dtd.dtd_element] | get the list of all attributes that are specified as required attributes
namespace_manager [Pxp_dtd.dtd] | For namespace-aware implementations of the node class, this method returns the namespace manager.
namespace_manager [Pxp_dtd.namespace_scope] | Returns the `namespace_manager` to which this scope object is connected
normprefix_of_display_prefix [Pxp_dtd.namespace_scope] | Translates the display prefix to the corresponding normalized prefix as declared in this object or any parent object.
notation [Pxp_dtd.dtd] | looks up the notation declaration with the given name.
notation_names [Pxp_dtd.dtd] | Returns the list of the names of all added notations
O
only_deterministic_models [Pxp_dtd.dtd] | Succeeds if all regexp content models are deterministic.
P
par_entity [Pxp_dtd.dtd] | looks up the parameter entity with the given name.
par_entity_names [Pxp_dtd.dtd] | returns the list of all parameter entity names
parent_scope [Pxp_dtd.namespace_scope] | Returns the parent object, if any
parse_pxp_option [Pxp_dtd.proc_instruction] | Parses a PI containing a PXP option.
pinstr [Pxp_dtd.dtd] | looks up all processing instructions with the given target.
pinstr_names [Pxp_dtd.dtd] | Returns the list of the names (targets) of all added pinstrs
R
root [Pxp_dtd.dtd] | get the name of the root element if present.
S
set_cm_and_extdecl [Pxp_dtd.dtd_element] | `set_cm_and_extdecl cm extdecl`: set the content model to `cm`.
set_id [Pxp_dtd.dtd] | set the identifier.
set_namespace_manager [Pxp_dtd.dtd] | Sets the namespace manager as returned by `namespace_manager`.
set_root [Pxp_dtd.dtd] | set the name of the root element.
set_standalone_declaration [Pxp_dtd.dtd] | Sets the 'standalone' declaration.
standalone_declaration [Pxp_dtd.dtd] | Whether there is a 'standalone' declaration or not.
T
target [Pxp_dtd.proc_instruction] |
U
uri_of_display_prefix [Pxp_dtd.namespace_scope] | Translates the display prefix to the corresponding URI as declared in this object or any parent object.
V
validate [Pxp_dtd.dtd_element] | checks whether this element declaration (i.e.
validate [Pxp_dtd.dtd] | ensures that the DTD is valid.
value [Pxp_dtd.proc_instruction] |
W
warn [Pxp_core_types.S.symbolic_warnings] |
warn [Pxp_core_types.S.collect_warnings] |
write [Pxp_dtd.dtd] | `write os enc doctype`: Writes the DTD as `enc`-encoded string to `os`.
write_ref [Pxp_dtd.dtd] | `write_ref os enc`: Writes a reference to the DTD as `enc`-encoded string to `os`.