qt4/demos/CMakeLists.txt | 1
qt4/src/CMakeLists.txt | 1
qt4/src/poppler-annotation.h | 70 ++++++++++++++++++++++++++++++++++++++++---
qt4/src/poppler-link.h | 12 ++++---
qt4/src/poppler-qt4.h | 22 +++++++++++--
qt4/tests/CMakeLists.txt | 1
6 files changed, 93 insertions(+), 14 deletions(-)
New commits:
commit d35ca2ce5df12d40e295873e44b1f18ea40ba897
Author: Pino Toscano <[EMAIL PROTECTED]>
Date: Sun Sep 7 01:13:33 2008 +0200
[Qt4] apidox improvements
diff --git a/qt4/src/poppler-annotation.h b/qt4/src/poppler-annotation.h
index 9b8b54d..ab54c6f 100644
--- a/qt4/src/poppler-annotation.h
+++ b/qt4/src/poppler-annotation.h
@@ -105,13 +105,27 @@ class POPPLER_QT4_EXPORT Annotation
enum RevScope { Reply = 1, Group = 2, Delete = 4 };
enum RevType { None = 1, Marked = 2, Unmarked = 4, Accepted = 8,
Rejected = 16, Cancelled = 32, Completed = 64 };
+ /**
+ * Returns the author of the annotation.
+ */
QString author() const;
+ /**
+ * Sets a new author for the annotation.
+ */
void setAuthor( const QString &author );
QString contents() const;
void setContents( const QString &contents );
+ /**
+ * Returns the unique name (ID) of the annotation.
+ */
QString uniqueName() const;
+ /**
+ * Sets a new unique name for the annotation.
+ *
+ * \note no check of the new uniqueName is done
+ */
void setUniqueName( const QString &uniqueName );
QDateTime modificationDate() const;
@@ -183,10 +197,14 @@ class POPPLER_QT4_EXPORT Annotation
*/
virtual SubType subType() const = 0;
- // methods: storage/retrieval from xml nodes
+ /**
+ * Save this annotation as a child of \p parentNode.
+ */
virtual void store( QDomNode & parentNode, QDomDocument & document ) const;
- // destructor
+ /**
+ * Destructor.
+ */
virtual ~Annotation();
protected:
@@ -436,7 +454,7 @@ class POPPLER_QT4_EXPORT StampAnnotation : public Annotation
Standard names for stamp annotation icons are:
- Approved
- - Asls
+ - AsIs
- Confidential
- Departmental
- Draft (this is the default icon type)
@@ -526,7 +544,9 @@ class POPPLER_QT4_EXPORT CaretAnnotation : public Annotation
virtual void store( QDomNode &parentNode, QDomDocument &document ) const;
virtual SubType subType() const;
- // local enums
+ /**
+ * The symbols for the caret annotation.
+ */
enum CaretSymbol { None, P };
CaretSymbol caretSymbol() const;
@@ -553,10 +573,24 @@ class POPPLER_QT4_EXPORT FileAttachmentAnnotation :
public Annotation
virtual void store( QDomNode &parentNode, QDomDocument &document ) const;
virtual SubType subType() const;
+ /**
+ * Returns the name of the icon of this annotation.
+ */
QString fileIconName() const;
+ /**
+ * Sets a new name for the icon of this annotation.
+ */
void setFileIconName( const QString &icon );
+ /**
+ * Returns the EmbeddedFile of this annotation.
+ */
EmbeddedFile* embeddedFile() const;
+ /**
+ * Sets a new EmbeddedFile for this annotation.
+ *
+ * \note FileAttachmentAnnotation takes ownership of the object
+ */
void setEmbeddedFile( EmbeddedFile *ef );
private:
@@ -580,10 +614,24 @@ class POPPLER_QT4_EXPORT SoundAnnotation : public
Annotation
virtual void store( QDomNode &parentNode, QDomDocument &document ) const;
virtual SubType subType() const;
+ /**
+ * Returns the name of the icon of this annotation.
+ */
QString soundIconName() const;
+ /**
+ * Sets a new name for the icon of this annotation.
+ */
void setSoundIconName( const QString &icon );
+ /**
+ * Returns the SoundObject of this annotation.
+ */
SoundObject* sound() const;
+ /**
+ * Sets a new SoundObject for this annotation.
+ *
+ * \note SoundAnnotation takes ownership of the object
+ */
void setSound( SoundObject *ef );
private:
@@ -607,10 +655,24 @@ class POPPLER_QT4_EXPORT MovieAnnotation : public
Annotation
virtual void store( QDomNode &parentNode, QDomDocument &document ) const;
virtual SubType subType() const;
+ /**
+ * Returns the MovieObject of this annotation.
+ */
MovieObject* movie() const;
+ /**
+ * Sets a new MovieObject for this annotation.
+ *
+ * \note MovieAnnotation takes ownership of the object
+ */
void setMovie( MovieObject *movie );
+ /**
+ * Returns the title of the movie of this annotation.
+ */
QString movieTitle() const;
+ /**
+ * Sets a new title for the movie of this annotation.
+ */
void setMovieTitle( const QString &title );
private:
diff --git a/qt4/src/poppler-link.h b/qt4/src/poppler-link.h
index fb973fa..7a8492a 100644
--- a/qt4/src/poppler-link.h
+++ b/qt4/src/poppler-link.h
@@ -122,11 +122,11 @@ class POPPLER_QT4_EXPORT Link
{
None, ///< Unknown link
Goto, ///< A "Go To" link
- Execute,
- Browse,
- Action,
+ Execute, ///< A command to be executed
+ Browse, ///< An URL to be browsed (eg
"http://poppler.freedesktop.org";)
+ Action, ///< A "standard" action to be executed in the
viewer
Sound, ///< A link representing a sound to be played
- Movie,
+ Movie, ///< An action to be executed on a movie
JavaScript ///< A JavaScript code to be interpreted
\since 0.10
};
@@ -204,6 +204,10 @@ class POPPLER_QT4_EXPORT LinkExecute : public Link
* The file name to be executed
*/
QString fileName() const;
+ /**
+ * If \ref fileName() represents a command, then this can hold
+ * the various parameters for it.
+ */
QString parameters() const;
/**
diff --git a/qt4/src/poppler-qt4.h b/qt4/src/poppler-qt4.h
index 912d475..12634a7 100644
--- a/qt4/src/poppler-qt4.h
+++ b/qt4/src/poppler-qt4.h
@@ -542,6 +542,8 @@ namespace Poppler {
/**
The render backends available
+
+ \since 0.6
*/
enum RenderBackend {
SplashBackend, ///< Splash backend
@@ -550,6 +552,8 @@ namespace Poppler {
/**
The render hints available
+
+ \since 0.6
*/
enum RenderHint {
Antialiasing = 0x00000001, ///< Antialiasing for graphics
@@ -572,7 +576,7 @@ namespace Poppler {
converting it to a QString first (QString::fromUtf8(), or similar)
before
converting to Latin1 encoding.
- \warning The application owns the pointer to Document, and this
should
+ \note The caller owns the pointer to Document, and this should
be deleted when no longer required.
\warning The returning document may be locked if a password is
required
@@ -597,8 +601,10 @@ namespace Poppler {
converting it to a QString first (QString::fromUtf8(), or similar)
before
converting to Latin1 encoding.
- \warning The application owns the pointer to Document, and this
should
+ \note The caller owns the pointer to Document, and this should
be deleted when no longer required.
+
+ \since 0.6
*/
static Document *loadFromData(const QByteArray &fileContents,
const QByteArray &ownerPassword=QByteArray(),
@@ -871,17 +877,23 @@ QString subject = m_doc->info("Subject");
availableRenderBackends() will always result in null QImage's.
\param backend the new rendering backend
+
+ \since 0.6
*/
void setRenderBackend( RenderBackend backend );
/**
The currently set render backend
The default backend is \ref SplashBackend
+
+ \since 0.6
*/
RenderBackend renderBackend() const;
/**
The available rendering backends.
+
+ \since 0.6
*/
static QSet<RenderBackend> availableRenderBackends();
@@ -891,10 +903,14 @@ QString subject = m_doc->info("Subject");
\note some hints may not be supported by some rendering backends.
\param on whether the flag should be added or removed.
+
+ \since 0.6
*/
void setRenderHint( RenderHint hint, bool on = true );
/**
The currently set render hints.
+
+ \since 0.6
*/
RenderHints renderHints() const;
@@ -947,7 +963,7 @@ QString subject = m_doc->info("Subject");
OptContentModel *optionalContentModel();
/**
- Document JavaScript scripts.
+ Document-level JavaScript scripts.
Returns the list of document level JavaScript scripts to be always
executed before any other script.
commit 796d4c002d47c85716775d173eddfb2ae8866eaf
Author: Pino Toscano <[EMAIL PROTECTED]>
Date: Sat Sep 6 22:48:13 2008 +0200
no more need for including the qt3 paths
diff --git a/qt4/demos/CMakeLists.txt b/qt4/demos/CMakeLists.txt
index 3401337..59b3f61 100644
--- a/qt4/demos/CMakeLists.txt
+++ b/qt4/demos/CMakeLists.txt
@@ -4,7 +4,6 @@ include_directories(
${CMAKE_CURRENT_SOURCE_DIR}
${CMAKE_CURRENT_SOURCE_DIR}/../src
${CMAKE_CURRENT_BINARY_DIR}
- ${CMAKE_SOURCE_DIR}/qt # for PageTransition
${QT4_INCLUDE_DIR}
)
diff --git a/qt4/src/CMakeLists.txt b/qt4/src/CMakeLists.txt
index a72f855..6928ea2 100644
--- a/qt4/src/CMakeLists.txt
+++ b/qt4/src/CMakeLists.txt
@@ -2,7 +2,6 @@ add_definitions(${QT4_DEFINITIONS})
include_directories(
${CMAKE_CURRENT_SOURCE_DIR}
- ${CMAKE_SOURCE_DIR}/qt # for PageTransition
${QT4_INCLUDE_DIR}
${CMAKE_CURRENT_BINARY_DIR}
)
diff --git a/qt4/tests/CMakeLists.txt b/qt4/tests/CMakeLists.txt
index 0dffb89..3faa28d 100644
--- a/qt4/tests/CMakeLists.txt
+++ b/qt4/tests/CMakeLists.txt
@@ -4,7 +4,6 @@ include_directories(
${CMAKE_CURRENT_SOURCE_DIR}
${CMAKE_CURRENT_SOURCE_DIR}/../src
${CMAKE_CURRENT_BINARY_DIR}
- ${CMAKE_SOURCE_DIR}/qt # for PageTransition
${QT4_INCLUDE_DIR}
)
_______________________________________________
poppler mailing list
[email protected]
http://lists.freedesktop.org/mailman/listinfo/poppler
