apps/konqueror/settings/konqhtml/jspolicies.h

   1 /*
   2   Copyright (c) 2002 Leo Savernik <l.savernik@aon.at>
   3   Derived from jsopt.h, code copied from there is copyrighted to its
   4   respective owners.
   5
   6   This program is free software; you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation; either version 2 of the License, or
   9   (at your option) any later version.
  10
  11   This program is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with this program; if not, write to the Free Software
  18   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19
  20 */
  21
  22 #ifndef __JSPOLICIES_H__
  23 #define __JSPOLICIES_H__
  24
  25 #include <QtGui/QGroupBox>
  26
  27
  28 #include <khtml_settings.h>
  29
  30 #include "policies.h"
  31
  32 class QButtonGroup;
  33
  34 // special value for inheriting a global policy
  35 #define INHERIT_POLICY          32767
  36
  37 /**
  38  * @short Contains all the JavaScript policies and methods for their manipulation.
  39  *
  40  * This class provides access to the JavaScript policies.
  41  *
  42  * @author Leo Savernik
  43  */
  44 class JSPolicies : public Policies {
  45 public:
  46 #if 0
  47   /**
  48    * Enumeration for all policies
  49    */
  50   enum Policies { JavaScriptEnabled = 0, WindowOpen, WindowResize,
  51                 WindowMove, WindowFocus, WindowStatus, NumPolicies };
  52 #endif
  53
  54   /**
  55    * constructor
  56    * @param config configuration to initialize this instance from
  57    * @param group config group to use if this instance contains the global
  58    *    policies (global == true)
  59    * @param global true if this instance contains the global policy settings,
  60    *    false if this instance contains policies specific for a domain.
  61    * @param domain name of the domain this instance is used to configure the
  62    *    policies for (case insensitive, ignored if global == true)
  63    */
  64   JSPolicies(KSharedConfig::Ptr config, const QString &group, bool global,
  65                 const QString &domain = QString());
  66
  67   /**
  68    * dummy constructor to make QMap happy.
  69    *
  70    * Never construct an object by using this.
  71    * @internal
  72    */
  73   JSPolicies();
  74
  75   virtual ~JSPolicies();
  76
  77   /**
  78    * Returns whether the WindowOpen policy is inherited.
  79    */
  80   bool isWindowOpenPolicyInherited() const {
  81     return window_open == INHERIT_POLICY;
  82   }
  83   /**
  84    * Returns the current value of the WindowOpen policy.
  85    *
  86    * This will return an illegal value if isWindowOpenPolicyInherited is
  87    * true.
  88    */
  89   KHTMLSettings::KJSWindowOpenPolicy windowOpenPolicy() const {
  90     return (KHTMLSettings::KJSWindowOpenPolicy)window_open;
  91   }
  92
  93   /**
  94    * Returns whether the WindowResize policy is inherited.
  95    */
  96   bool isWindowResizePolicyInherited() const {
  97     return window_resize == INHERIT_POLICY;
  98   }
  99   /**
 100    * Returns the current value of the WindowResize policy.
 101    *
 102    * This will return an illegal value if isWindowResizePolicyInherited is
 103    * true.
 104    */
 105   KHTMLSettings::KJSWindowResizePolicy windowResizePolicy() const {
 106     return (KHTMLSettings::KJSWindowResizePolicy)window_resize;
 107   }
 108
 109   /**
 110    * Returns whether the WindowMove policy is inherited.
 111    */
 112   bool isWindowMovePolicyInherited() const {
 113     return window_move == INHERIT_POLICY;
 114   }
 115   /**
 116    * Returns the current value of the WindowMove policy.
 117    *
 118    * This will return an illegal value if isWindowMovePolicyInherited is
 119    * true.
 120    */
 121   KHTMLSettings::KJSWindowMovePolicy windowMovePolicy() const {
 122     return (KHTMLSettings::KJSWindowMovePolicy)window_move;
 123   }
 124
 125   /**
 126    * Returns whether the WindowFocus policy is inherited.
 127    */
 128   bool isWindowFocusPolicyInherited() const {
 129     return window_focus == INHERIT_POLICY;
 130   }
 131   /**
 132    * Returns the current value of the WindowFocus policy.
 133    *
 134    * This will return an illegal value if isWindowFocusPolicyInherited is
 135    * true.
 136    */
 137   KHTMLSettings::KJSWindowFocusPolicy windowFocusPolicy() const {
 138     return (KHTMLSettings::KJSWindowFocusPolicy)window_focus;
 139   }
 140
 141   /**
 142    * Returns whether the WindowStatus policy is inherited.
 143    */
 144   bool isWindowStatusPolicyInherited() const {
 145     return window_status == INHERIT_POLICY;
 146   }
 147   /**
 148    * Returns the current value of the WindowStatus policy.
 149    *
 150    * This will return an illegal value if isWindowStatusPolicyInherited is
 151    * true.
 152    */
 153   KHTMLSettings::KJSWindowStatusPolicy windowStatusPolicy() const {
 154     return (KHTMLSettings::KJSWindowStatusPolicy)window_status;
 155   }
 156
 157   /**
 158    * (re)loads settings from configuration file given in the constructor.
 159    */
 160   virtual void load();
 161   /**
 162    * saves current settings to the configuration file given in the constructor
 163    */
 164   virtual void save();
 165   /**
 166    * restores the default settings
 167    */
 168   virtual void defaults();
 169
 170 private:
 171   // one of KHTMLSettings::KJSWindowOpenPolicy or INHERIT_POLICY
 172   unsigned int window_open;
 173   // one of KHTMLSettings::KJSWindowResizePolicy or INHERIT_POLICY
 174   unsigned int window_resize;
 175   // one of KHTMLSettings::KJSWindowMovePolicy or INHERIT_POLICY
 176   unsigned int window_move;
 177   // one of KHTMLSettings::KJSWindowFocusPolicy or INHERIT_POLICY
 178   unsigned int window_focus;
 179   // one of KHTMLSettings::KJSWindowStatusPolicy or INHERIT_POLICY
 180   unsigned int window_status;
 181
 182   friend class JSPoliciesFrame; // for changing policies
 183 };
 184
 185 /**
 186  * @short Provides a framed widget with controls for the JavaScript policy settings.
 187  *
 188  * This widget contains controls for changing all JavaScript policies
 189  * except the JavaScript enabled policy itself. The rationale behind this is
 190  * that the enabled policy be separate from the rest in a prominent
 191  * place.
 192  *
 193  * It is suitable for the global policy settings as well as for the
 194  * domain-specific settings.
 195  *
 196  * The difference between global and domain-specific is the existence of
 197  * a special inheritance option in the latter case. That way domain-specific
 198  * policies can inherit their value from the global policies.
 199  *
 200  * @author Leo Savernik
 201  */
 202 class JSPoliciesFrame : public QGroupBox {
 203   Q_OBJECT
 204 public:
 205   /**
 206    * constructor
 207    * @param policies associated object containing the policy values. This
 208    *    object will be updated accordingly as the settings are changed.
 209    * @param title title for group box
 210    * @param parent parent widget
 211    */
 212   JSPoliciesFrame(JSPolicies *policies, const QString &title,
 213                 QWidget* parent = 0);
 214
 215   virtual ~JSPoliciesFrame();
 216
 217   /**
 218    * updates the controls to resemble the status of the underlying
 219    * JSPolicies object.
 220    */
 221   void refresh();
 222   /**
 223    * (re)loads settings from configuration file given in the constructor.
 224    */
 225   void load() {
 226     policies->load();
 227     refresh();
 228   }
 229   /**
 230    * saves current settings to the configuration file given in the constructor
 231    */
 232   void save() {
 233     policies->save();
 234   }
 235   /**
 236    * restores the default settings
 237    */
 238   void defaults() {
 239     policies->defaults();
 240     refresh();
 241   }
 242
 243 Q_SIGNALS:
 244   /**
 245    * emitted every time an option has been changed
 246    */
 247   void changed();
 248
 249 private Q_SLOTS:
 250   void setWindowOpenPolicy(int id);
 251   void setWindowResizePolicy(int id);
 252   void setWindowMovePolicy(int id);
 253   void setWindowFocusPolicy(int id);
 254   void setWindowStatusPolicy(int id);
 255
 256 private:
 257
 258   JSPolicies *policies;
 259   QButtonGroup *js_popup;
 260   QButtonGroup *js_resize;
 261   QButtonGroup *js_move;
 262   QButtonGroup *js_focus;
 263   QButtonGroup *js_statusbar;
 264 };
 265
 266
 267 #endif          // __JSPOLICIES_H__
 268