okular/core/action.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2004-2005 by Enrico Ros <eros.kde@email.it>             *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  ***************************************************************************/
   9
  10 #include "action.h"
  11
  12 // kde includes
  13 #include <klocale.h>
  14
  15 // local includes
  16 #include "document.h"
  17 #include "sound.h"
  18
  19 using namespace Okular;
  20
  21 class Okular::ActionPrivate
  22 {
  23     public:
  24         ActionPrivate()
  25         {
  26         }
  27
  28         virtual ~ActionPrivate()
  29         {
  30         }
  31 };
  32
  33 Action::Action( ActionPrivate &dd )
  34     : d_ptr( &dd )
  35 {
  36 }
  37
  38 Action::~Action()
  39 {
  40     delete d_ptr;
  41 }
  42
  43 QString Action::actionTip() const
  44 {
  45     return "";
  46 }
  47
  48 // GotoAction
  49
  50 class Okular::GotoActionPrivate : public Okular::ActionPrivate
  51 {
  52     public:
  53         GotoActionPrivate( const QString &fileName, const DocumentViewport &viewport )
  54             : ActionPrivate(), m_extFileName( fileName ), m_vp( viewport )
  55         {
  56         }
  57
  58         QString m_extFileName;
  59         DocumentViewport m_vp;
  60 };
  61
  62 GotoAction::GotoAction( const QString& fileName, const DocumentViewport & viewport )
  63     : Action( *new GotoActionPrivate( fileName, viewport ) )
  64 {
  65 }
  66
  67 GotoAction::~GotoAction()
  68 {
  69 }
  70
  71 Action::ActionType GotoAction::actionType() const
  72 {
  73     return Goto;
  74 }
  75
  76 QString GotoAction::actionTip() const
  77 {
  78     Q_D( const GotoAction );
  79     return d->m_extFileName.isEmpty() ? ( d->m_vp.isValid() ? i18n( "Go to page %1", d->m_vp.pageNumber + 1 ) : "" ) :
  80                                      i18n("Open external file");
  81 }
  82
  83 bool GotoAction::isExternal() const
  84 {
  85     Q_D( const GotoAction );
  86     return !d->m_extFileName.isEmpty();
  87 }
  88
  89 QString GotoAction::fileName() const
  90 {
  91     Q_D( const GotoAction );
  92     return d->m_extFileName;
  93 }
  94
  95 DocumentViewport GotoAction::destViewport() const
  96 {
  97     Q_D( const GotoAction );
  98     return d->m_vp;
  99 }
 100
 101 // ExecuteAction
 102
 103 class Okular::ExecuteActionPrivate : public Okular::ActionPrivate
 104 {
 105     public:
 106         ExecuteActionPrivate( const QString &file, const QString & parameters )
 107             : ActionPrivate(), m_fileName( file ), m_parameters( parameters )
 108         {
 109         }
 110
 111         QString m_fileName;
 112         QString m_parameters;
 113 };
 114
 115 ExecuteAction::ExecuteAction( const QString &file, const QString & parameters )
 116     : Action( *new ExecuteActionPrivate( file, parameters ) )
 117 {
 118 }
 119
 120 ExecuteAction::~ExecuteAction()
 121 {
 122 }
 123
 124 Action::ActionType ExecuteAction::actionType() const
 125 {
 126     return Execute;
 127 }
 128
 129 QString ExecuteAction::actionTip() const
 130 {
 131     Q_D( const Okular::ExecuteAction );
 132     return i18n( "Execute '%1'...", d->m_fileName );
 133 }
 134
 135 QString ExecuteAction::fileName() const
 136 {
 137     Q_D( const Okular::ExecuteAction );
 138     return d->m_fileName;
 139 }
 140
 141 QString ExecuteAction::parameters() const
 142 {
 143     Q_D( const Okular::ExecuteAction );
 144     return d->m_parameters;
 145 }
 146
 147 // BrowseAction
 148
 149 class Okular::BrowseActionPrivate : public Okular::ActionPrivate
 150 {
 151     public:
 152         BrowseActionPrivate( const QString &url )
 153             : ActionPrivate(), m_url( url )
 154         {
 155         }
 156
 157         QString m_url;
 158 };
 159
 160 BrowseAction::BrowseAction( const QString &url )
 161     : Action( *new BrowseActionPrivate( url ) )
 162 {
 163 }
 164
 165 BrowseAction::~BrowseAction()
 166 {
 167 }
 168
 169 Action::ActionType BrowseAction::actionType() const
 170 {
 171     return Browse;
 172 }
 173
 174 QString BrowseAction::actionTip() const
 175 {
 176     Q_D( const Okular::BrowseAction );
 177     return d->m_url;
 178 }
 179
 180 QString BrowseAction::url() const
 181 {
 182     Q_D( const Okular::BrowseAction );
 183     return d->m_url;
 184 }
 185
 186 // DocumentAction
 187
 188 class Okular::DocumentActionPrivate : public Okular::ActionPrivate
 189 {
 190     public:
 191         DocumentActionPrivate( enum DocumentAction::DocumentActionType documentActionType )
 192             : ActionPrivate(), m_type( documentActionType )
 193         {
 194         }
 195
 196         DocumentAction::DocumentActionType m_type;
 197 };
 198
 199 DocumentAction::DocumentAction( enum DocumentActionType documentActionType )
 200     : Action( *new DocumentActionPrivate( documentActionType ) )
 201 {
 202 }
 203
 204 DocumentAction::~DocumentAction()
 205 {
 206 }
 207
 208 DocumentAction::DocumentActionType DocumentAction::documentActionType() const
 209 {
 210     Q_D( const Okular::DocumentAction );
 211     return d->m_type;
 212 }
 213
 214 Action::ActionType DocumentAction::actionType() const
 215 {
 216     return DocAction;
 217 }
 218
 219 QString DocumentAction::actionTip() const
 220 {
 221     Q_D( const Okular::DocumentAction );
 222     switch ( d->m_type )
 223     {
 224         case PageFirst:
 225             return i18n( "First Page" );
 226         case PagePrev:
 227             return i18n( "Previous Page" );
 228         case PageNext:
 229             return i18n( "Next Page" );
 230         case PageLast:
 231             return i18n( "Last Page" );
 232         case HistoryBack:
 233             return i18n( "Back" );
 234         case HistoryForward:
 235             return i18n( "Forward" );
 236         case Quit:
 237             return i18n( "Quit" );
 238         case Presentation:
 239             return i18n( "Start Presentation" );
 240         case EndPresentation:
 241             return i18n( "End Presentation" );
 242         case Find:
 243             return i18n( "Find..." );
 244         case GoToPage:
 245             return i18n( "Go To Page..." );
 246         case Close:
 247         default: ;
 248     }
 249
 250     return QString();
 251 }
 252
 253 // SoundAction
 254
 255 class Okular::SoundActionPrivate : public Okular::ActionPrivate
 256 {
 257     public:
 258         SoundActionPrivate( double volume, bool sync, bool repeat, bool mix, Okular::Sound *sound )
 259             : ActionPrivate(), m_volume( volume ), m_sync( sync ),
 260               m_repeat( repeat ), m_mix( mix ), m_sound( sound )
 261         {
 262         }
 263
 264         ~SoundActionPrivate()
 265         {
 266             delete m_sound;
 267         }
 268
 269         double m_volume;
 270         bool m_sync : 1;
 271         bool m_repeat : 1;
 272         bool m_mix : 1;
 273         Okular::Sound *m_sound;
 274 };
 275
 276 SoundAction::SoundAction( double volume, bool sync, bool repeat, bool mix, Okular::Sound *sound )
 277     : Action( *new SoundActionPrivate( volume, sync, repeat, mix, sound ) )
 278 {
 279 }
 280
 281 SoundAction::~SoundAction()
 282 {
 283 }
 284
 285 Action::ActionType SoundAction::actionType() const
 286 {
 287     return Sound;
 288 }
 289
 290 QString SoundAction::actionTip() const
 291 {
 292     return i18n( "Play sound..." );
 293 }
 294
 295 double SoundAction::volume() const
 296 {
 297     Q_D( const Okular::SoundAction );
 298     return d->m_volume;
 299 }
 300
 301 bool SoundAction::synchronous() const
 302 {
 303     Q_D( const Okular::SoundAction );
 304     return d->m_sync;
 305 }
 306
 307 bool SoundAction::repeat() const
 308 {
 309     Q_D( const Okular::SoundAction );
 310     return d->m_repeat;
 311 }
 312
 313 bool SoundAction::mix() const
 314 {
 315     Q_D( const Okular::SoundAction );
 316     return d->m_mix;
 317 }
 318
 319 Okular::Sound *SoundAction::sound() const
 320 {
 321     Q_D( const Okular::SoundAction );
 322     return d->m_sound;
 323 }
 324
 325 // ScriptAction
 326
 327 class Okular::ScriptActionPrivate : public Okular::ActionPrivate
 328 {
 329     public:
 330         ScriptActionPrivate( enum ScriptType type, const QString &script )
 331             : ActionPrivate(), m_scriptType( type ), m_script( script )
 332         {
 333         }
 334
 335         ScriptType m_scriptType;
 336         QString m_script;
 337 };
 338
 339 ScriptAction::ScriptAction( enum ScriptType type, const QString &script )
 340     : Action( *new ScriptActionPrivate( type, script ) )
 341 {
 342 }
 343
 344 ScriptAction::~ScriptAction()
 345 {
 346 }
 347
 348 Action::ActionType ScriptAction::actionType() const
 349 {
 350     return Script;
 351 }
 352
 353 QString ScriptAction::actionTip() const
 354 {
 355     Q_D( const Okular::ScriptAction );
 356     switch ( d->m_scriptType )
 357     {
 358         case JavaScript:
 359             return i18n( "JavaScript Script" );
 360     }
 361
 362     return QString();
 363 }
 364
 365 ScriptType ScriptAction::scriptType() const
 366 {
 367     Q_D( const Okular::ScriptAction );
 368     return d->m_scriptType;
 369 }
 370
 371 QString ScriptAction::script() const
 372 {
 373     Q_D( const Okular::ScriptAction );
 374     return d->m_script;
 375 }
 376
 377 // MovieAction
 378
 379 #if 0
 380 class Okular::MovieActionPrivate : public Okular::ActionPrivate
 381 {
 382     public:
 383         MovieActionPrivate()
 384             : ActionPrivate()
 385         {
 386         }
 387 };
 388
 389 MovieAction::MovieAction()
 390     : Action( *new MovieActionPrivate() )
 391 {
 392 }
 393
 394 MovieAction::~MovieAction()
 395 {
 396 }
 397
 398 Action::ActionType MovieAction::actionType() const
 399 {
 400     return Movie;
 401 }
 402
 403 QString MovieAction::actionTip() const
 404 {
 405     return i18n( "Play movie..." );
 406 }
 407 #endif