summaryrefslogtreecommitdiffstats
path: root/scribus/text/fsize.cpp
blob: a0cd1165c437c9c0a31aae3d58ccbac12a1d0278 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
/****************************************************************************
** $Id$
**
** Implementation of FSize class
**
** Created : 931028
**
** Copyright (C) 1992-2000 Trolltech AS.  All rights reserved.
**
** This file is part of the kernel module of the Qt GUI Toolkit.
**
** This file may be distributed under the terms of the Q Public License
** as defined by Trolltech AS of Norway and appearing in the file
** LICENSE.QPL included in the packaging of this file.
**
** This file may be distributed and/or modified under the terms of the
** GNU General Public License version 2 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.
**
** Licensees holding valid Qt Enterprise Edition or Qt Professional Edition
** licenses may use this file in accordance with the Qt Commercial License
** Agreement provided with the Software.
**
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
**
** See http://www.trolltech.com/pricing.html or email sales@trolltech.com for
**   information about Qt Commercial License Agreements.
** See http://www.trolltech.com/qpl/ for QPL licensing information.
** See http://www.trolltech.com/gpl/ for GPL licensing information.
**
** Contact info@trolltech.com if any conditions of this licensing are
** not clear to you.
**
**********************************************************************/

#include "fsize.h"
//#include "qdatastream.h"


/*!
  \class FSize
  \brief The FSize class defines the size of a two-dimensional object.

  \ingroup images
  \ingroup graphics

  A size is specified by a width and a height.

  The coordinate type is qreal (defined in \c <qwindowdefs.h> as \c qreal).
  The minimum value of qreal is qreal_MIN (-2147483648) and the maximum
  value is qreal_MAX (2147483647).

  The size can be set in the constructor and changed with setWidth()
  and setHeight(), or using operator+=(), operator-=(), operator*=()
  and operator/=(), etc. You can swap the width and height with
  transpose(). You can get a size which holds the maximum height and
  width of two sizes using expandedTo(), and the minimum height and
  width of two sizes using boundedTo().


  \sa QPoint, QRect
*/


/*****************************************************************************
  FSize member functions
 *****************************************************************************/

/*!
  \fn FSize::FSize()
  Constructs a size with invalid (negative) width and height.
*/

/*!
  \fn FSize::FSize( qreal w, qreal h )
  Constructs a size with width \a w and height \a h.
*/

/*!
  \fn bool FSize::isNull() const
  Returns TRUE if the width is 0 and the height is 0; otherwise
  returns FALSE.
*/

/*!
  \fn bool FSize::isEmpty() const
  Returns TRUE if the width is less than or equal to 0, or the height is
  less than or equal to 0; otherwise returns FALSE.
*/

/*!
  \fn bool FSize::isValid() const
  Returns TRUE if the width is equal to or greater than 0 and the height is
  equal to or greater than 0; otherwise returns FALSE.
*/

/*!
  \fn qreal FSize::width() const
  Returns the width.
  \sa height()
*/

/*!
  \fn qreal FSize::height() const
  Returns the height.
  \sa width()
*/

/*!
  \fn void FSize::setWidth( qreal w )
  Sets the width to \a w.
  \sa width(), setHeight()
*/

/*!
  \fn void FSize::setHeight( qreal h )
  Sets the height to \a h.
  \sa height(), setWidth()
*/

/*!
  Swaps the values of width and height.
*/

void FSize::transpose()
{
    qreal tmp = wd;
    wd = ht;
    ht = tmp;
}

/*! \enum FSize::ScaleMode

    This enum type defines the different ways of scaling a size.

    \img scaling.png

    \value ScaleFree  The size is scaled freely. The ratio is not preserved.
    \value ScaleMin  The size is scaled to a rectangle as large as possible
                     inside a given rectangle, preserving the aspect ratio.
    \value ScaleMax  The size is scaled to a rectangle as small as possible
                     outside a given rectangle, preserving the aspect ratio.

    \sa FSize::scale(), QImage::scale(), QImage::smoothScale()
*/

/*!
    Scales the size to a rectangle of width \a w and height \a h according
    to the ScaleMode \a mode.

    \list
    \i If \a mode is \c ScaleFree, the size is set to (\a w, \a h).
    \i If \a mode is \c ScaleMin, the current size is scaled to a rectangle
       as large as possible inside (\a w, \a h), preserving the aspect ratio.
    \i If \a mode is \c ScaleMax, the current size is scaled to a rectangle
       as small as possible outside (\a w, \a h), preserving the aspect ratio.
    \endlist

    Example:
    \code
    FSize t1( 10, 12 );
    t1.scale( 60, 60, FSize::ScaleFree );
    // t1 is (60, 60)

    FSize t2( 10, 12 );
    t2.scale( 60, 60, FSize::ScaleMin );
    // t2 is (50, 60)

    FSize t3( 10, 12 );
    t3.scale( 60, 60, FSize::ScaleMax );
    // t3 is (60, 72)
    \endcode
*/
void FSize::scale( qreal w, qreal h, Qt::AspectRatioMode mode )
{
    if ( mode == Qt::IgnoreAspectRatio ) {
	wd = (qreal)w;
	ht = (qreal)h;
    } else {
	bool useHeight = TRUE;
	qreal w0 = width();
	qreal h0 = height();
	qreal rw = h * w0 / h0;

	if ( mode == Qt::KeepAspectRatio ) {
	    useHeight = ( rw <= w );
	} else { // mode == ScaleMax
	    useHeight = ( rw >= w );
	}

	if ( useHeight ) {
	    wd = (qreal)rw;
	    ht = (qreal)h;
	} else {
	    wd = (qreal)w;
	    ht = (qreal)( w * h0 / w0 );
	}
    }
}

/*!
    \overload

    Equivalent to scale(\a{s}.width(), \a{s}.height(), \a mode).
*/
void FSize::scale( const FSize &s, Qt::AspectRatioMode mode )
{
    scale( s.width(), s.height(), mode );
}

/*!
  \fn qreal &FSize::rwidth()
  Returns a reference to the width.

  Using a reference makes it possible to directly manipulate the width.

  Example:
  \code
    FSize s( 100, 10 );
    s.rwidth() += 20;		// s becomes (120,10)
  \endcode

  \sa rheight()
*/

/*!
  \fn qreal &FSize::rheight()
  Returns a reference to the height.

  Using a reference makes it possible to directly manipulate the height.

  Example:
  \code
    FSize s( 100, 10 );
    s.rheight() += 5;		// s becomes (100,15)
  \endcode

  \sa rwidth()
*/

/*!
  \fn FSize &FSize::operator+=( const FSize &s )

  Adds \a s to the size and returns a reference to this size.

  Example:
  \code
    FSize s(  3, 7 );
    FSize r( -1, 4 );
    s += r;			// s becomes (2,11)
\endcode
*/

/*!
  \fn FSize &FSize::operator-=( const FSize &s )

  Subtracts \a s from the size and returns a reference to this size.

  Example:
  \code
    FSize s(  3, 7 );
    FSize r( -1, 4 );
    s -= r;			// s becomes (4,3)
  \endcode
*/

/*!
  \fn FSize &FSize::operator*=( qreal c )
  Multiplies both the width and height by \a c and returns a reference to
  the size.
*/

/*!
  \overload FSize &FSize::operator*=( qreal c )

  Multiplies both the width and height by \a c and returns a reference to
  the size.

  Note that the result is truncated.
*/

/*!
  \fn bool operator==( const FSize &s1, const FSize &s2 )
  \relates FSize
  Returns TRUE if \a s1 and \a s2 are equal; otherwise returns FALSE.
*/

/*!
  \fn bool operator!=( const FSize &s1, const FSize &s2 )
  \relates FSize
  Returns TRUE if \a s1 and \a s2 are different; otherwise returns FALSE.
*/

/*!
  \fn const FSize operator+( const FSize &s1, const FSize &s2 )
  \relates FSize
  Returns the sum of \a s1 and \a s2; each component is added separately.
*/

/*!
  \fn const FSize operator-( const FSize &s1, const FSize &s2 )
  \relates FSize
  Returns \a s2 subtracted from \a s1; each component is
  subtracted separately.
*/

/*!
  \fn const FSize operator*( const FSize &s, qreal c )
  \relates FSize
  Multiplies \a s by \a c and returns the result.
*/

/*!
  \overload const FSize operator*( qreal c, const FSize &s )
  \relates FSize
  Multiplies \a s by \a c and returns the result.
*/

/*!
  \overload const FSize operator*( const FSize &s, qreal c )
  \relates FSize
  Multiplies \a s by \a c and returns the result.
*/

/*!
  \overload const FSize operator*( qreal c, const FSize &s )
  \relates FSize
  Multiplies \a s by \a c and returns the result.
*/

/*!
  \fn FSize &FSize::operator/=( qreal c )
  Divides both the width and height by \a c and returns a reference to the
  size.
*/

/*!
  \fn FSize &FSize::operator/=( qreal c )
  \overload
  Divides both the width and height by \a c and returns a reference to the
  size.

  Note that the result is truncated.
*/

/*!
  \fn const FSize operator/( const FSize &s, qreal c )
  \relates FSize
  Divides \a s by \a c and returns the result.
*/

/*!
  \fn const FSize operator/( const FSize &s, qreal c )
  \relates FSize
  \overload
  Divides \a s by \a c and returns the result.

  Note that the result is truncated.
*/

/*!
  \fn FSize FSize::expandedTo( const FSize & otherSize ) const

  Returns a size with the maximum width and height of this size and
  \a otherSize.
*/

/*!
  \fn FSize FSize::boundedTo( const FSize & otherSize ) const

  Returns a size with the minimum width and height of this size and
  \a otherSize.
*/


void FSize::warningDivByZero()
{
#if defined(QT_CHECK_MATH)
    qWarning( "FSize: Division by zero error" );
#endif
}


/*****************************************************************************
  FSize stream functions
 *****************************************************************************/
// #ifndef QT_NO_DATASTREAM
// /*!
//   \relates FSize
//   Writes the size \a sz to the stream \a s and returns a reference to
//   the stream.
//
//   \sa \link datastreamformat.html Format of the QDataStream operators \endlink
// */
//
// QDataStream &operator<<( QDataStream &s, const FSize &sz )
// {
//     if ( s.version() == 1 )
// 	s << (Q_INT16)sz.width() << (Q_INT16)sz.height();
//     else
// 	s << (Q_INT32)sz.width() << (Q_INT32)sz.height();
//     return s;
// }
//
// /*!
//   \relates FSize
//   Reads the size from the stream \a s into size \a sz and returns a
//   reference to the stream.
//
//   \sa \link datastreamformat.html Format of the QDataStream operators \endlink
// */
//
// QDataStream &operator>>( QDataStream &s, FSize &sz )
// {
//     if ( s.version() == 1 ) {
// 	Q_INT16 w, h;
// 	s >> w;  sz.rwidth() = w;
// 	s >> h;  sz.rheight() = h;
//     }
//     else {
// 	Q_INT32 w, h;
// 	s >> w;  sz.rwidth() = w;
// 	s >> h;  sz.rheight() = h;
//     }
//     return s;
// }
// #endif // QT_NO_DATASTREAM