← Back to branch summary

~ubuntu-branches/ubuntu/maverick/kdegraphics/maverick-proposed

« back to all changes in this revision

Viewing changes to okular/core/document.h

  • Committer: Bazaar Package Importer
  • Author(s): Jonathan Thomas
  • Date: 2009-12-02 14:03:43 UTC
  • mfrom: (1.1.35 upstream)
  • Revision ID: james.westby@ubuntu.com-20091202140343-2732gbkj69g89arq
Tags: 4:4.3.80-0ubuntu1
* New upstream beta release:
  - Add build-depend on shared-desktop-ontologies for nepomuk integration
  - Bump .so versions for libkexiv, libkdcraw and libkipi
  - Update various .install files

Show diffs side-by-side

added added

removed removed

Lines of Context:
okular/core/document.h
543
543
        bool saveChanges( const QString &fileName );
544
544
 
545
545
        /**
 
546
         * Save the document and the optional changes to it to the specified
 
547
         * @p fileName and returns a @p errorText if fails.
 
548
         *
 
549
         * @since 0.10 (KDE 4.4)
 
550
         */
 
551
        bool saveChanges( const QString &fileName, QString *errorText );
 
552
 
 
553
        /**
546
554
         * Register the specified @p view for the current document.
547
555
         *
548
556
         * It is unregistered from the previous document, if any.
579
587
         */
580
588
        bool saveDocumentArchive( const QString &fileName );
581
589
 
 
590
        /**
 
591
         * Asks the generator to dynamically generate a SourceReference for a given
 
592
         * page number and absolute X and Y position on this page.
 
593
         *
 
594
         * @attention Ownership of the returned SourceReference is transferred to the caller.
 
595
         * @note This method does not call processSourceReference( const SourceReference * )
 
596
         *
 
597
         * @since 0.10 (KDE 4.4)
 
598
        */
 
599
        const SourceReference * dynamicSourceReference( int pageNr, double absX, double absY );
 
600
 
 
601
 
582
602
    public Q_SLOTS:
583
603
        /**
584
604
         * This slot is called whenever the user changes the @p rotation of
809
829
            ModificationDate,   ///< The date of last modification of the document
810
830
            MimeType,           ///< The mime type of the document
811
831
            Category,           ///< The category of the document
812
 
            Keywords            ///< The keywords which describe the content of the document
 
832
            Keywords,           ///< The keywords which describe the content of the document
 
833
            FilePath,           ///< The path of the file @since 0.10 (KDE 4.4)
 
834
            DocumentSize,       ///< The size of the document @since 0.10 (KDE 4.4)
 
835
            PagesSize           ///< The size of the pages (if all pages have the same size) @since 0.10 (KDE 4.4)
813
836
        };
814
837
 
815
838
        /**
828
851
         * Sets the value for a predefined key. You should use this method
829
852
         * whenever a predefined key exists for your value.
830
853
         */
831
 
        void set( enum Key, const QString &value );
 
854
        void set( Key key, const QString &value );
832
855
 
833
856
        /**
834
857
         * Returns the value for a given key or an empty string when the
835
858
         * key doesn't exist.
836
859
         */
837
860
        QString get( const QString &key ) const;
 
861
 
 
862
        /**
 
863
         * Returns the internal string for the given key
 
864
         * @since 0.10 (KDE 4.4)
 
865
         */
 
866
        static QString getKeyString( Key key );
 
867
 
 
868
        /**
 
869
         * Returns the user visible string for the given key
 
870
         * @since 0.10 (KDE 4.4)
 
871
         */
 
872
        static QString getKeyTitle( Key key );
 
873
 
838
874
};
839
875
 
840
876
/**
961
997
Q_DECLARE_OPERATORS_FOR_FLAGS( Okular::Document::PixmapRequestFlags )
962
998
 
963
999
#endif
 
1000
 
 
1001
/* kate: replace-tabs on; indent-width 4; */