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