src/toolbar/models.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # This file is part of FNP-Redakcja, licensed under GNU Affero GPLv3 or later.
   4 # Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
   5 #
   6 from django.db import models
   7 from django.utils.translation import ugettext_lazy as _
   8
   9
  10 class ButtonGroup(models.Model):
  11     name = models.CharField(max_length=32)
  12     slug = models.SlugField()
  13     position = models.IntegerField(default=0)
  14
  15     class Meta:
  16         ordering = ('position', 'name',)
  17         verbose_name, verbose_name_plural = _('button group'), _('button groups')
  18
  19     def __str__(self):
  20         return self.name
  21
  22     def to_dict(self, with_buttons=False):
  23         d = {'name': self.name, 'position': self.position}
  24
  25         if with_buttons:
  26             d['buttons'] = [b.to_dict() for b in self.button_set.all()]
  27
  28         return d
  29
  30
  31 class Button(models.Model):
  32     label = models.CharField(max_length=32)
  33     slug = models.SlugField(unique=True)  # unused
  34
  35     # behaviour
  36     params = models.TextField(default='[]')  # TODO: should be a JSON field
  37     scriptlet = models.ForeignKey('Scriptlet', null=True, blank=True)
  38     link = models.CharField(max_length=256, blank=True, default='')
  39
  40     # ui related stuff
  41     accesskey = models.CharField(blank=True, max_length=1)
  42
  43     tooltip = models.CharField(blank=True, max_length=120)
  44
  45     # Why the button is restricted to have the same position in each group ?
  46     # position = models.IntegerField(default=0)
  47     group = models.ManyToManyField(ButtonGroup)
  48
  49     class Meta:
  50         ordering = ('slug',)
  51         verbose_name, verbose_name_plural = _('button'), _('buttons')
  52
  53     @property
  54     def full_tooltip(self):
  55         return u"%s %s" % (self.tooltip, "[Alt+%s]" % self.accesskey if self.accesskey else "")
  56
  57     def to_dict(self):
  58         return {
  59             'label': self.label,
  60             'tooltip': self.tooltip,
  61             'accesskey': self.accesskey,
  62             'params': self.params,
  63             'scriptlet_id': self.scriptlet_id,
  64         }
  65
  66     def __str__(self):
  67         return self.label
  68
  69
  70 class Scriptlet(models.Model):
  71     name = models.CharField(max_length=64, primary_key=True)
  72     code = models.TextField()
  73
  74     def __str__(self):
  75         return _(u'javascript') + u':' + self.name