Back to index

plone3  3.1.7
interfaces.py
Go to the documentation of this file.
00001 from zope.interface import Interface
00002 
00003 class IKSSCoreCommands(Interface):
00004     """The core commands"""
00005 
00006     def getSelector(type, selector):
00007         """Return a specific type of selector
00008 
00009         The type can be `css` or `htmlid`. The selector is the value for the
00010         selector."""
00011 
00012     def getCssSelector(selector):
00013         """Return a CSS selector with selector as the value"""
00014 
00015     def getHtmlIdSelector(selector):
00016         """Return a HTML id selector with selector as the value"""
00017 
00018     def getSameNodeSelector():
00019         """Return the same node as the value"""
00020 
00021     def getParentNodeSelector(selector):
00022         """Return a all nodes in the parent chain which match the css
00023         selector"""
00024 
00025     def replaceInnerHTML(selector, new_value, withKssSetup='True'):
00026         """Replace the contents of a node (selector) with the new_value"""
00027 
00028     def replaceHTML(selector, new_value, withKssSetup='True'):
00029         """Replace the node itself with new_value
00030         
00031         Node selection is done using the selector argument."""
00032 
00033     def setAttribute(selector, name, value):
00034         """Set an attribute on node(s) specified by the selector"""
00035 
00036     def setKssAttribute(selector, name, value):
00037         """Set a KSS attribute on node(s) specified by the selector"""
00038 
00039     def setStyle(selector, name, value):
00040         """Set the style attribute of nodes specified by the selector"""
00041 
00042     def insertHTMLAfter(selector, new_value, withKssSetup='True'):
00043         """Insert some HTML after the node indicated by selector"""
00044 
00045     def insertHTMLBefore(selector, new_value, withKssSetup='True'):
00046         """Insert some HTML before the node specified by selector"""
00047 
00048     def insertHTMLAsFirstChild(selector, new_value, withKssSetup='True'):
00049         """Insert some HTML as the first child of the node specified by selector"""
00050 
00051     def insertHTMLAsLastChild(selector, new_value, withKssSetup='True'):
00052         """Insert some HTML as the last child of the node specified by selector"""
00053 
00054     def clearChildNodes(selector):
00055         """Remove all the child nodes from the node specified by selector"""
00056 
00057     def deleteNode(selector):
00058         """Remove the node itself specified by selector"""
00059 
00060     def deleteNodeAfter(selector):
00061         """Remove the node after the node specified by selector"""
00062 
00063     def deleteNodeBefore(selector):
00064         """Remove the node before the node specified by selector"""
00065 
00066     def copyChildNodesFrom(selector, id):
00067         """Copy the child nodes from the node specified by id to the selector node
00068         
00069         The copy operation will clear out all childnodes of selector."""
00070 
00071     def copyChildNodesTo(selector, id):
00072         """Copy the child nodes from the selector node to the node specified by id
00073         
00074         The copy operation will clear out all childnodes of selector."""
00075 
00076     def moveNodeAfter(selector, id):
00077         """Move the node indicated by selector to a sibling after id"""
00078 
00079     def setStateVar(varname, value):
00080         """Set a client side kukit variable"""
00081 
00082     def continueEvent(name, allnodes=False, **kw):
00083         """Trigger an event on the client """
00084         # TODO: explain a bit better what this does
00085 
00086     def toggleClass(selector, value):
00087         """Add/remove a class to/from a node.
00088         
00089         If the class is present it will be removed. Else the class will be
00090         added.  """
00091 
00092     def addClass(selector, value):
00093         """Add a class to a node."""
00094 
00095     def removeClass(selector, value):
00096         """Remove a class from a node."""
00097 
00098     def focus(selector):
00099         """Set focus to selected node."""