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

« back to all changes in this revision

Viewing changes to okular/core/textpage.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:
95
95
 
96
96
    public:
97
97
        /**
 
98
         * Defines the behaviour of adding characters to text() result
 
99
         * @since 0.10 (KDE 4.4)
 
100
         */
 
101
        enum TextAreaInclusionBehaviour
 
102
        {
 
103
            AnyPixelTextAreaInclusionBehaviour,      ///< A character is included into text() result if any pixel of his bounding box is in the given area
 
104
            CentralPixelTextAreaInclusionBehaviour  ///< A character is included into text() result if the central pixel of his bounding box is in the given area
 
105
        };
 
106
 
 
107
        /**
98
108
         * Creates a new text page.
99
109
         */
100
110
        TextPage();
137
147
         * - a null string if @p rect is a valid pointer to a null area
138
148
         * - the whole page text if @p rect is a null pointer
139
149
         * - the text which is included by rectangular area @p rect otherwise
 
150
         * Uses AnyPixelTextAreaInclusionBehaviour
140
151
         */
141
152
        QString text( const RegularAreaRect *rect = 0 ) const;
142
153
 
143
154
        /**
 
155
         * Text extraction function.
 
156
         *
 
157
         * Returns:
 
158
         * - a null string if @p rect is a valid pointer to a null area
 
159
         * - the whole page text if @p rect is a null pointer
 
160
         * - the text which is included by rectangular area @p rect otherwise
 
161
         * @since 0.10 (KDE 4.4)
 
162
         */
 
163
        QString text( const RegularAreaRect * rect, TextAreaInclusionBehaviour b ) const;
 
164
 
 
165
        /**
144
166
         * Returns the rectangular area of the given @p selection.
145
167
         */
146
168
        RegularAreaRect *textArea( TextSelection *selection ) const;