API cleanup

svn path=/trunk/playground/graphics/okular/; revision=608232

core/link.cpp

@@ -24,12 +24,39 @@ QString Link::linkTip() const
     return "";
 }
 
-// Link Tips
+// LinkGoto
+LinkGoto::LinkGoto( QString fileName, const DocumentViewport & viewport )
+    : m_extFileName( fileName ), m_vp( viewport )
+{
+}
+
+LinkGoto::LinkType LinkGoto::linkType() const
+{
+    return Goto;
+}
+
 QString LinkGoto::linkTip() const
 {
-    return m_extFileName.isEmpty() ? ( m_vp.pageNumber != -1 ? i18n( "Go to page %1", m_vp.pageNumber + 1 ) : "" ) : i18n("Open external file");
+    return m_extFileName.isEmpty() ? ( m_vp.pageNumber != -1 ? i18n( "Go to page %1", m_vp.pageNumber + 1 ) : "" ) :
+                                     i18n("Open external file");
+}
+
+bool LinkGoto::isExternal() const
+{
+    return !m_extFileName.isEmpty();
+}
+
+QString LinkGoto::fileName() const
+{
+    return m_extFileName;
 }
 
+DocumentViewport LinkGoto::destViewport() const
+{
+    return m_vp;
+}
+
+
 QString LinkExecute::linkTip() const
 {
     return i18n( "Execute '%1'...", m_fileName );

core/link.h

@@ -31,30 +31,79 @@ class Sound;
 class OKULAR_EXPORT Link
 {
     public:
-        // get link type (inherited classes mustreturn an unique identifier)
-        enum LinkType { Goto, Execute, Browse, Action, Sound, Movie };
+        /**
+         * Describes the type of link.
+         */
+        enum LinkType {
+            Goto,       ///< Goto a given page or external document
+            Execute,    ///< Execute a command or external application
+            Browse,     ///< Browse a given website
+            Action,     ///< Start a custom action
+            Sound,      ///< Play a sound
+            Movie       ///< Play a movie
+        };
+
+        /**
+         * Destroys the link.
+         */
+        virtual ~Link();
+
+        /**
+         * Returns the type of the link. Every inherited class must return
+         * an unique identifier.
+         *
+         * @see LinkType
+         */
         virtual LinkType linkType() const = 0;
-        virtual QString linkTip() const;
 
-        // virtual destructor (remove warnings)
-        virtual ~Link();
+        /**
+         * Returns a i18n'ed tip of the link action that is presented to
+         * the user.
+         */
+        virtual QString linkTip() const;
 };
 
 
-/** Goto: a viewport and maybe a reference to an external filename **/
+/**
+ * The Goto link changes the viewport to another page
+ * or loads an external document.
+ */
 class OKULAR_EXPORT LinkGoto : public Link
 {
     public:
-        // query for goto parameters
-        bool isExternal() const { return !m_extFileName.isEmpty(); }
-        const QString & fileName() const { return m_extFileName; }
-        const DocumentViewport & destViewport() const { return m_vp; }
-
-        // create a Link_Goto
-        LinkGoto( QString extFileName, const DocumentViewport & vp ) { m_extFileName = extFileName; m_vp = vp; }
-        LinkType linkType() const { return Goto; }
+        /**
+         * Creates a new goto link.
+         *
+         * @p fileName The name of an external file that shall be loaded.
+         * @p viewport The target viewport information of the current document.
+         */
+        LinkGoto( QString fileName, const DocumentViewport & viewport );
+
+        /**
+         * Returns the link type.
+         */
+        LinkType linkType() const;
+
+        /**
+         * Returns the link tip.
+         */
         QString linkTip() const;
 
+        /**
+         * Returns whether the goto link points to an external document.
+         */
+        bool isExternal() const;
+
+        /**
+         * Returns the filename of the external document.
+         */
+        QString fileName() const;
+
+        /**
+         * Returns the document viewport the goto link points to.
+         */
+        DocumentViewport destViewport() const;
+
     private:
         QString m_extFileName;
         DocumentViewport m_vp;