cms.apps.menus package

Submodules

cms.apps.menus.admin module

class cms.apps.menus.admin.MenuableAdmin(model, admin_site)

Bases: django.contrib.admin.options.ModelAdmin

delete_model(request, obj)
fieldsets_append = {u'Einstellungen': (('menu',),)}
get_form(request, obj=None, **kwargs)
media
save_model(request, obj, form, change)
class cms.apps.menus.admin.MenusItemAdmin(model, admin_site, menu)

Bases: cms.contrib.admin.admin.CMSAdmin, cms.core.admin.OwnableAdmin, cms.core.translations.admin.TranslationAdmin

This class is used as a proxy by MenuAdmin to manipulate menu items. It should never be registered.

autocomplete_lookup_fields = {'generic': [['content_type', 'object_id']], 'm2m': ['sites'], 'fk': ['author']}
delete_view(request, object_id, extra_context=None)
fields_with_sibling = ('description',)
fieldsets = ((u'Allgemein', {'fields': ['title', ('status', 'mark'), 'parent']}), (u'Einstellungen', {'fields': [('login_required', 'sitemapped'), 'schema']}), (u'URL', {'fields': [('content_type', 'object_id'), ('view',), 'slug', 'slugNamed', 'target']}), (u'Erweitert', {'fields': ['description', 'description_auto', 'author', 'sites']}))
get_form(request, obj=None, **kwargs)
media
raw_id_fields = ('object_id', 'author', 'sites')
response_add(request, obj, post_url_continue=None)
response_change(request, obj)
save_model(request, obj, form, change)
class cms.apps.menus.admin.MenusItemAdmin2(model, admin_site)

Bases: django.contrib.admin.options.ModelAdmin

change_view(request, object_id, form_url='', extra_context=None)
media
class cms.apps.menus.admin.MenusMenuAdmin(model, admin_site)

Bases: cms.core.admin.DisplayableAdmin

add_menu_item(request, menu_pk)

Custom view

change_form_template = 'admin/menus/menusmenu/change_form.html'
delete_menu_item(request, menu_pk, menu_item_pk)

Custom view

edit_menu_item(request, menu_pk, menu_item_pk)

Custom view

fieldsets = ((u'Allgemein', {'fields': ['title', 'status']}), (u'Einstellungen', {'fields': [('login_required', 'sitemapped')]}), (u'Erweitert', {'fields': ['slug', 'description', 'author', 'sites']}))
get_changelist_actions(obj)
get_object_with_change_permissions(request, model, obj_pk)

Helper function that returns a menu/menuitem if it exists and if the user has the change permissions

get_urls()
history_menu_item(request, menu_pk, menu_item_pk)

Custom view

list_exclude = ('get_changelist_actions',)
media
menu_item_admin_class

alias of MenusItemAdmin

move_down_item(request, menu_pk, menu_item_pk)
move_up_item(request, menu_pk, menu_item_pk)

cms.apps.menus.cms_initialize module

class cms.apps.menus.cms_initialize.CMSInitialize

Bases: cms.core.models.CMSInitializeBase

models = (<class 'cms.apps.menus.models.MenusItem'>, <class 'cms.apps.menus.models.MenusMenu'>)

cms.apps.menus.cms_plugin module

class cms.apps.menus.cms_plugin.CMSPlugin

Bases: cms.core.plugins.CMSPluginBase

admin_icon_class = 'icon-dropmenu'
description = <django.utils.functional.__proxy__ object at 0x3265c50>
status = 'stable'
verbose_name = <django.utils.functional.__proxy__ object at 0x3265cd0>
version = '0.3'

cms.apps.menus.cms_sitemaps module

class cms.apps.menus.cms_sitemaps.MenusItemSitemap

Bases: cms.contrib.sitemaps.sitemap.SitemapBase

app_label = 'menus'
get_queryset(model)
model_name = 'MenusItem'

cms.apps.menus.fields module

class cms.apps.menus.fields.MenusItemChoiceField(choices=(), required=True, widget=None, label=None, initial=None, help_text=u'', *args, **kwargs)

Bases: django.forms.fields.ChoiceField

Custom field to display the list of items in a tree manner

clean(value)
class cms.apps.menus.fields.MenusItemContentTypeChoiceField(choices=(), required=True, widget=None, label=None, initial=None, help_text=u'', *args, **kwargs)

Bases: django.forms.fields.ChoiceField

Custom field to display the list of items in a tree manner

clean(value)

cms.apps.menus.management module

cms.apps.menus.management.create_group(sender, **kwargs)

cms.apps.menus.models module

class cms.apps.menus.models.MenusItem(id, keywords_string, created_date, modified_date, created_by_id, modified_by_id, description, description_auto, login_required, title, slug, status, published_date, expired_date, sitemapped, mark, author_id, parent_id, slugNamed, target, level, rank, menu_id, schema, content_type_id, object_id, view)

Bases: cms.core.models.Displayable, cms.core.models.Ownable

class ApiPrivate
fields = ('parent', 'slugNamed', 'target', 'level', 'rank', 'menu', 'schema', 'content_type', 'object_id', 'view')
exception MenusItem.DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception MenusItem.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

class MenusItem.Settings
ADMIN_DASHBOARD_EXCLUDE = True
SITEMAP_CHANGEFREQ = 'weekly'
SITEMAP_PRIORITY = 0.5
MenusItem.TARGET_CHOICES = [('_blank', <django.utils.functional.__proxy__ object at 0x428edd0>), ('_self', <django.utils.functional.__proxy__ object at 0x428ee10>), ('_parent', <django.utils.functional.__proxy__ object at 0x428ee50>), ('_top', <django.utils.functional.__proxy__ object at 0x428ee90>)]
class MenusItem.Translation
fields = ('slugNamed',)
MenusItem.author
MenusItem.cache_delete()
MenusItem.children()
MenusItem.children_values_list_menu(lang)
MenusItem.clean_fields(exclude=None)
MenusItem.content_object

Provides a generic relation to any object through content-type/object-id fields.

MenusItem.content_type
MenusItem.created_by
MenusItem.delete()
MenusItem.description

A descriptor used for the original translated field.

MenusItem.get_absolute_url()
MenusItem.get_css_classes()
MenusItem.get_description(**kwargs)
MenusItem.get_fields_from_object()
MenusItem.get_flattened()
MenusItem.get_keywordsfield_name()
MenusItem.get_mark_display(*moreargs, **morekwargs)
MenusItem.get_next_by_created_date(*moreargs, **morekwargs)
MenusItem.get_next_by_modified_date(*moreargs, **morekwargs)
MenusItem.get_next_by_published_date(*moreargs, **morekwargs)
MenusItem.get_previous_by_created_date(*moreargs, **morekwargs)
MenusItem.get_previous_by_modified_date(*moreargs, **morekwargs)
MenusItem.get_previous_by_published_date(*moreargs, **morekwargs)
MenusItem.get_schema_display(*moreargs, **morekwargs)
MenusItem.get_slug()
MenusItem.get_status_display(*moreargs, **morekwargs)
MenusItem.get_target_display(*moreargs, **morekwargs)
MenusItem.has_children()
MenusItem.has_siblings()
MenusItem.is_root_item_of
MenusItem.keywords

This class provides the functionality that makes the related-object managers available as attributes on a model class, for fields that have multiple “remote” values and have a GenericRelation defined in their model (rather than having another model pointed at them). In the example “article.publications”, the publications attribute is a ReverseGenericRelatedObjectsDescriptor instance.

MenusItem.keywords_string

A descriptor used for the original translated field.

MenusItem.menu
MenusItem.menusitem_set
MenusItem.modified_by
MenusItem.objects = <cms.core.translations.translator.NewMultilingualManager object at 0x43ee7d0>
MenusItem.parent
MenusItem.save(force_insert=False, **kwargs)
MenusItem.siblings()
MenusItem.sites
MenusItem.slug

A descriptor used for the original translated field.

MenusItem.slugNamed

A descriptor used for the original translated field.

MenusItem.title

A descriptor used for the original translated field.

MenusItem.title_with_spacer()
class cms.apps.menus.models.MenusMenu(id, keywords_string, created_date, modified_date, created_by_id, modified_by_id, description, description_auto, login_required, title, slug, status, published_date, expired_date, sitemapped, mark, author_id, root_item_id)

Bases: cms.core.models.Displayable, cms.core.models.Ownable

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception MenusMenu.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

class MenusMenu.Translation
fields = ('-slug', '-title', '-description')
MenusMenu.author
MenusMenu.clean_fields(exclude=None)
MenusMenu.contained_items
MenusMenu.created_by
MenusMenu.delete()
MenusMenu.get_keywordsfield_name()
MenusMenu.get_mark_display(*moreargs, **morekwargs)
MenusMenu.get_next_by_created_date(*moreargs, **morekwargs)
MenusMenu.get_next_by_modified_date(*moreargs, **morekwargs)
MenusMenu.get_next_by_published_date(*moreargs, **morekwargs)
MenusMenu.get_previous_by_created_date(*moreargs, **morekwargs)
MenusMenu.get_previous_by_modified_date(*moreargs, **morekwargs)
MenusMenu.get_previous_by_published_date(*moreargs, **morekwargs)
MenusMenu.get_status_display(*moreargs, **morekwargs)
MenusMenu.keywords

This class provides the functionality that makes the related-object managers available as attributes on a model class, for fields that have multiple “remote” values and have a GenericRelation defined in their model (rather than having another model pointed at them). In the example “article.publications”, the publications attribute is a ReverseGenericRelatedObjectsDescriptor instance.

MenusMenu.keywords_string

A descriptor used for the original translated field.

MenusMenu.modified_by
MenusMenu.objects = <cms.core.translations.translator.NewMultilingualManager object at 0x43f2f50>
MenusMenu.root_item
MenusMenu.save(force_insert=False, **kwargs)
MenusMenu.sites

cms.apps.menus.utils module

cms.apps.menus.utils.clean_ranks(menu_items)

Resets ranks from 0 to n, n being the number of items.

cms.apps.menus.utils.get_menu_choices()

Returns all menus and there items as choices.

cms.apps.menus.utils.get_parent_choices(menu, menu_item=None)

Returns flat list of tuples (possible_parent.pk, possible_parent.title_with_spacer). If ‘menu_item’ is not given or None, returns every item of the menu. If given, intentionally omit it and its descendant in the list.

cms.apps.menus.utils.move_item(menu_item, vector)

Helper function to move and item up or down in the database

cms.apps.menus.utils.move_item_or_clean_ranks(menu_item, vector)

Helper function to move and item up or down in the database. If the moving fails, we assume that the ranks were corrupted, so we clean them and try the moving again.

Module contents