okular/core/sourcereference.h

   1 /***************************************************************************
   2  *   Copyright (C) 2007 by Pino Toscano <pino@kde.org>                     *
   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 #ifndef OKULAR_SOURCEREFERENCE_H
  11 #define OKULAR_SOURCEREFERENCE_H
  12
  13 #include <okular/core/okular_export.h>
  14
  15 class QString;
  16
  17 namespace Okular {
  18
  19 /**
  20  * @short Defines a source reference
  21  *
  22  * A source reference is a reference to one of the source(s) of the loaded
  23  * document.
  24  */
  25 class OKULAR_EXPORT SourceReference
  26 {
  27     public:
  28         /**
  29          * Creates a reference to the row @p row and column @p column of the
  30          * source @p fileName
  31          */
  32         SourceReference( const QString &fileName, int row, int column = 0 );
  33
  34         /**
  35          * Destroys the source reference.
  36          */
  37         ~SourceReference();
  38
  39         /**
  40          * Returns the filename of the source.
  41          */
  42         QString fileName() const;
  43
  44         /**
  45          * Returns the row of the position in the source file.
  46          */
  47         int row() const;
  48
  49         /**
  50          * Returns the column of the position in the source file.
  51          */
  52         int column() const;
  53
  54     private:
  55         class Private;
  56         Private* const d;
  57
  58         Q_DISABLE_COPY( SourceReference )
  59 };
  60
  61 }
  62
  63 #endif
  64