pyams_content.component.gallery package ⊞

pyams_content.component.gallery.file

pyams_content.component.gallery.interfaces

interface pyams_content.component.gallery.interfaces.IBaseGallery[source]

Extends: zope.container.interfaces.IOrderedContainer, zope.annotation.interfaces.IAttributeAnnotatable, pyams_content.features.renderer.interfaces.IRenderedContent

Base gallery interface

renderer

Gallery template

Presentation template used for this gallery

Implementation:zope.schema.Choice
Read Only:False
Required:True
Default Value:‘default’
append(self, value, notify=True)

Append new file to gallery

@param value: the media object to append @param boolean notify: if ‘False’, the given value object is pre-located so that

adding events are not notified
get_visible_medias(self)

Get iterator over visible medias

interface pyams_content.component.gallery.interfaces.IGallery[source]

Extends: pyams_content.component.gallery.interfaces.IBaseGallery

Gallery interface

__setitem__(key, value)

Add the given object to the container under the given name.

Raises a TypeError if the key is not a unicode or ascii string.

Raises a ValueError if the key is empty, or if the key contains a character which is not allowed in an object name.

Raises a KeyError if the key violates a uniqueness constraint.

The container might choose to add a different object than the one passed to this method.

If the object doesn’t implement IContained, then one of two things must be done:

  1. If the object implements ILocation, then the IContained interface must be declared for the object.
  2. Otherwise, a ContainedProxy is created for the object and stored.

The object’s __parent__ and __name__ attributes are set to the container and the given name.

If the old parent was None, then an IObjectAddedEvent is generated, otherwise, an IObjectMovedEvent is generated. An IContainerModifiedEvent is generated for the container.

If the object replaces another object, then the old object is deleted before the new object is added, unless the container vetos the replacement by raising an exception.

If the object’s __parent__ and __name__ were already set to the container and the name, then no events are generated and no hooks. This allows advanced clients to take over event generation.

title

Title

Gallery title, as shown in front-office

Implementation:pyams_i18n.schema.I18nTextLineField
Read Only:False
Required:False
Default Value:None
Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine
Read Only:False
Required:True
Default Value:None
Allowed Type:str

Value Type

Implementation:zope.schema.TextLine
Read Only:False
Required:False
Default Value:None
Allowed Type:str
description

Description

Gallery description displayed by front-office template

Implementation:pyams_i18n.schema.I18nTextField
Read Only:False
Required:False
Default Value:None
Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine
Read Only:False
Required:True
Default Value:None
Allowed Type:str

Value Type

Implementation:zope.schema.Text
Read Only:False
Required:False
Default Value:None
Allowed Type:str
interface pyams_content.component.gallery.interfaces.IGalleryFile[source]

Extends: pyams_content.component.gallery.interfaces.IGalleryItem

Gallery file marker interface

data

Image or video data

Image or video content

Implementation:pyams_file.schema.MediaField
Read Only:False
Required:True
Default Value:None
Allowed Type:bytes
title

Legend

Implementation:pyams_i18n.schema.I18nTextLineField
Read Only:False
Required:False
Default Value:None
Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine
Read Only:False
Required:True
Default Value:None
Allowed Type:str

Value Type

Implementation:zope.schema.TextLine
Read Only:False
Required:False
Default Value:None
Allowed Type:str
alt_title

Accessibility title

Alternate title used to describe media content

Implementation:pyams_i18n.schema.I18nTextLineField
Read Only:False
Required:False
Default Value:None
Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine
Read Only:False
Required:True
Default Value:None
Allowed Type:str

Value Type

Implementation:zope.schema.TextLine
Read Only:False
Required:False
Default Value:None
Allowed Type:str
description

Associated text

Media description displayed in front-office templates

Implementation:pyams_i18n.schema.I18nTextField
Read Only:False
Required:False
Default Value:None
Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine
Read Only:False
Required:True
Default Value:None
Allowed Type:str

Value Type

Implementation:zope.schema.Text
Read Only:False
Required:False
Default Value:None
Allowed Type:str
author

Author

Name of document’s author

Implementation:zope.schema.TextLine
Read Only:False
Required:True
Default Value:None
Allowed Type:str
sound

Audio data

Sound file associated with the current media

Implementation:pyams_file.schema.AudioField
Read Only:False
Required:False
Default Value:None
Allowed Type:bytes
sound_title

Sound title

Title of associated sound file

Implementation:pyams_i18n.schema.I18nTextLineField
Read Only:False
Required:False
Default Value:None
Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine
Read Only:False
Required:True
Default Value:None
Allowed Type:str

Value Type

Implementation:zope.schema.TextLine
Read Only:False
Required:False
Default Value:None
Allowed Type:str
sound_description

Sound description

Short description of associated sound file

Implementation:pyams_i18n.schema.I18nTextField
Read Only:False
Required:False
Default Value:None
Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine
Read Only:False
Required:True
Default Value:None
Allowed Type:str

Value Type

Implementation:zope.schema.Text
Read Only:False
Required:False
Default Value:None
Allowed Type:str
visible

Visible media?

If ‘no’, this media won’t be displayed in front office

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:True
Allowed Type:bool
interface pyams_content.component.gallery.interfaces.IGalleryItem[source]

Gallery item base interface

__parent__
Implementation:zope.schema.Field
Read Only:False
Required:True
Default Value:None
interface pyams_content.component.gallery.interfaces.IGalleryParagraph[source]

Extends: pyams_content.component.gallery.interfaces.IBaseGallery, pyams_content.component.paragraph.interfaces.IBaseParagraph

Gallery paragraph

interface pyams_content.component.gallery.interfaces.IGalleryTarget[source]

Extends: zope.annotation.interfaces.IAttributeAnnotatable

Gallery container target marker interface

pyams_content.component.gallery.paragraph