Librarian in regular requirements.
[redakcja.git] / apps / toolbar / models.py
index 004fde9..a23e346 100644 (file)
@@ -1,3 +1,8 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of FNP-Redakcja, licensed under GNU Affero GPLv3 or later.
+# Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
+#
 from django.db import models
 from django.utils.translation import ugettext_lazy as _
 
@@ -6,58 +11,65 @@ class ButtonGroup(models.Model):
     name = models.CharField(max_length=32)
     slug = models.SlugField()
     position = models.IntegerField(default=0)
-    
+
     class Meta:
         ordering = ('position', 'name',)
         verbose_name, verbose_name_plural = _('button group'), _('button groups')
-    
+
     def __unicode__(self):
         return self.name
 
+    def to_dict(self, with_buttons=False):
+        d = {'name': self.name, 'position': self.position}
+
+        if with_buttons:
+            d['buttons'] = [b.to_dict() for b in self.button_set.all()]
+
+        return d
+
+
 class Button(models.Model):
     label = models.CharField(max_length=32)
-    slug = models.SlugField(unique=True) #unused
+    slug = models.SlugField(unique=True)  # unused
 
     # behaviour
-    params = models.TextField() # TODO: should be a JSON field
-    scriptlet = models.ForeignKey('Scriptlet')
+    params = models.TextField(default='[]')  # TODO: should be a JSON field
+    scriptlet = models.ForeignKey('Scriptlet', null=True, blank=True)
+    link = models.CharField(max_length=256, blank=True, default='')
 
     # ui related stuff
-    key = models.CharField(blank=True, max_length=1)
-    key_mod = models.PositiveIntegerField(blank=True, default=1)
+    accesskey = models.CharField(blank=True, max_length=1)
+
     tooltip = models.CharField(blank=True, max_length=120)
 
     # Why the button is restricted to have the same position in each group ?
-    # position = models.IntegerField(default=0)   
+    # position = models.IntegerField(default=0)
     group = models.ManyToManyField(ButtonGroup)
-    
+
     class Meta:
-        ordering = ('label',)
+        ordering = ('slug',)
         verbose_name, verbose_name_plural = _('button'), _('buttons')
 
-    def hotkey_code(self):
-        return ord(self.key.upper()) | (self.key_mod << 8)
+    @property
+    def full_tooltip(self):
+        return u"%s %s" % (self.tooltip, "[Alt+%s]" % self.accesskey if self.accesskey else "")
 
-    def hotkey_name(self):
-        if not self.key:
-            return ''
+    def to_dict(self):
+        return {
+            'label': self.label,
+            'tooltip': self.tooltip,
+            'accesskey': self.accesskey,
+            'params': self.params,
+            'scriptlet_id': self.scriptlet_id,
+        }
 
-        mods = []
-        if self.key_mod & 0x01: mods.append('Alt')
-        if self.key_mod & 0x02: mods.append('Ctrl')
-        if self.key_mod & 0x04: mods.append('Shift')
-        mods.append('"'+self.key+'"')
-        return '+'.join(mods)
-    
     def __unicode__(self):
         return self.label
 
+
 class Scriptlet(models.Model):
     name = models.CharField(max_length=64, primary_key=True)
     code = models.TextField()
 
-    # TODO: add this later and remap code property to this
-    # code_min = models.TextField()
-
     def __unicode__(self):
-        return _(u'javascript')+u':'+self.name
+        return _(u'javascript') + u':' + self.name