Back to index

plone3  3.1.7
Public Member Functions
kupu.plone.z3interfaces.IPloneKupuLibraryTool Class Reference
Inheritance diagram for kupu.plone.z3interfaces.IPloneKupuLibraryTool:
Inheritance graph
[legend]
Collaboration diagram for kupu.plone.z3interfaces.IPloneKupuLibraryTool:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def getLinkbyuid
def getRefBrowser
def getCaptioning
def getTableClassnames
def getParagraphStyles
def getStyleList
def filterToolbar
def getHtmlExclusions
def getStyleWhitelist
def getClassBlacklist
def getDefaultResource
def installBeforeUnload
def getFiltersourceedit
def isKupuEnabled
def getWysiwygmacros
def forcekupu_url
def query_string
def url_plus_query
def kupuUrl
def getCookedLibraries
def getPreviewForType
def getNormalViewForType
def getScaleFieldForType
def getClassesForType
def getMediaForType
def configure_kupu

Detailed Description

Definition at line 12 of file z3interfaces.py.


Member Function Documentation

def kupu.plone.z3interfaces.IPloneKupuLibraryTool.configure_kupu (   linkbyuid,
  table_classnames,
  html_exclusions,
  style_whitelist,
  class_blacklist,
  installBeforeUnload = None,
  parastyles = None,
  refbrowser = None,
  captioning = None,
  filterSourceEdit = None,
  REQUEST = None 
)
Modify kupu's configuration settings

Definition at line 106 of file z3interfaces.py.

00106 
00107         REQUEST=None):
00108         """Modify kupu's configuration settings"""
def kupu.plone.z3interfaces.IPloneKupuLibraryTool.filterToolbar (   context,
  field = None 
)
Return a filter helper for toolbar elements.
Attributes on the helper class are True if an element is enabled.

Definition at line 31 of file z3interfaces.py.

00031 
00032     def filterToolbar(context, field=None):
00033         """Return a filter helper for toolbar elements.
00034         Attributes on the helper class are True if an element is enabled."""

Generate the url used to force or suppress kupu

Definition at line 59 of file z3interfaces.py.

00059 
00060     def forcekupu_url(self, fieldName):
00061         """Generate the url used to force or suppress kupu"""

Returns True if captioning is enabled

Definition at line 19 of file z3interfaces.py.

00019 
00020     def getCaptioning():
00021         """Returns True if captioning is enabled"""

Returns the class blacklist

Definition at line 41 of file z3interfaces.py.

00041 
00042     def getClassBlacklist():
00043         """Returns the class blacklist"""

Get a sequence of classes that may be applied

Definition at line 95 of file z3interfaces.py.

00095 
00096     def getClassesForType(portal_type):
00097         """Get a sequence of classes that may be applied"""

Here is the caller graph for this function:

Return a list of libraries with our own parameters included

Definition at line 83 of file z3interfaces.py.

00083 
00084     def getCookedLibraries(context):
00085         """Return a list of libraries with our own parameters included"""

Returns the name of the default resource type (e.g. linkable)

Definition at line 44 of file z3interfaces.py.

00044 
00045     def getDefaultResource():
00046         """Returns the name of the default resource type (e.g. linkable)"""

Should kupu clean up html in source editor? Default: True

Definition at line 50 of file z3interfaces.py.

00050 
00051     def getFiltersourceedit(self):
00052         """Should kupu clean up html in source editor? Default: True"""

Returns the list of html exclusions

Definition at line 35 of file z3interfaces.py.

00035 
00036     def getHtmlExclusions():
00037         """Returns the list of html exclusions"""

Returns 'is linking by UID enabled'?

Definition at line 13 of file z3interfaces.py.

00013 
00014     def getLinkbyuid():
00015         """Returns 'is linking by UID enabled'?"""

Gets the media type image/flash

Definition at line 98 of file z3interfaces.py.

00098 
00099     def getMediaForType(portal_type):
00100         """Gets the media type image/flash"""

Get the normal view url for a specific type

Definition at line 89 of file z3interfaces.py.

00089 
00090     def getNormalViewForType(portal_type):
00091         """Get the normal view url for a specific type"""

Return a list of classnames supported by paragraphs

Definition at line 25 of file z3interfaces.py.

00025 
00026     def getParagraphStyles():
00027         """Return a list of classnames supported by paragraphs"""

Get the preview url for a specific type

Definition at line 86 of file z3interfaces.py.

00086 
00087     def getPreviewForType(portal_type):
00088         """Get the preview url for a specific type"""

Returns True if kupu_references is in all skin layers

Definition at line 16 of file z3interfaces.py.

00016 
00017     def getRefBrowser():
00018         """Returns True if kupu_references is in all skin layers"""

Get the name of the field containing a scalable image

Definition at line 92 of file z3interfaces.py.

00092 
00093     def getScaleFieldForType(portal_type):
00094         """Get the name of the field containing a scalable image"""

Return the styles for a field.

Definition at line 28 of file z3interfaces.py.

00028 
00029     def getStyleList(field=None):
00030         """Return the styles for a field."""

Returns the style whitelist

Definition at line 38 of file z3interfaces.py.

00038 
00039     def getStyleWhitelist():
00040         """Returns the style whitelist"""

Return a list of classnames supported in tables

Definition at line 22 of file z3interfaces.py.

00022 
00023     def getTableClassnames():
00024         """Return a list of classnames supported in tables"""

Find the appropriate template to use for the kupu widget

Definition at line 56 of file z3interfaces.py.

00056 
00057     def getWysiwygmacros():
00058         """Find the appropriate template to use for the kupu widget"""

Should kupu load its own unload handler? Default: False

Definition at line 47 of file z3interfaces.py.

00047 
00048     def installBeforeUnload():
00049         """Should kupu load its own unload handler? Default: False"""

def kupu.plone.z3interfaces.IPloneKupuLibraryTool.isKupuEnabled (   useragent = '',
  allowAnonymous = False,
  REQUEST = None,
  context = None,
  fieldName = None 
)
Is kupu enabled for this combination of client browser, permissions, and field.

Definition at line 53 of file z3interfaces.py.

00053 
00054     def isKupuEnabled(useragent='', allowAnonymous=False, REQUEST=None, context=None, fieldName=None):
00055         """Is kupu enabled for this combination of client browser, permissions, and field."""

def kupu.plone.z3interfaces.IPloneKupuLibraryTool.kupuUrl (   url,
  query = None 
)
Generate a url which includes resource_type and instance

Definition at line 80 of file z3interfaces.py.

00080 
00081     def kupuUrl(url, query=None):
00082         """Generate a url which includes resource_type and instance"""
        

Here is the caller graph for this function:

def kupu.plone.z3interfaces.IPloneKupuLibraryTool.query_string (   self,
  replace = {},
  original = None 
)
Updates 'original' dictionary by the values in the 'replace'
    dictionary and returns the result as url quoted query string.

    The 'original' dictionary defaults to 'REQUEST.form' if no
    parameter is passed to it. Keys in the 'replace' dictionary
    with a value of 'None' (or _.None in DTML) will be deleted
    from 'original' dictionary before being quoted.

    The original 'REQUEST.form' will remain unchanged.

Definition at line 62 of file z3interfaces.py.

00062 
00063     def query_string(self, replace={}, original=None):
00064         """ Updates 'original' dictionary by the values in the 'replace'
00065             dictionary and returns the result as url quoted query string.
00066 
00067             The 'original' dictionary defaults to 'REQUEST.form' if no
00068             parameter is passed to it. Keys in the 'replace' dictionary
00069             with a value of 'None' (or _.None in DTML) will be deleted
00070             from 'original' dictionary before being quoted.
00071 
00072             The original 'REQUEST.form' will remain unchanged.
00073         """

Adds query segment to an existing URL.
Existing query parameters are may be overridden by query,
otherwise they are preserved.

Definition at line 74 of file z3interfaces.py.

00074 
00075     def url_plus_query(url, query=None):
00076         """Adds query segment to an existing URL.
00077         Existing query parameters are may be overridden by query,
00078         otherwise they are preserved.
00079         """


The documentation for this class was generated from the following file: