This file is indexed.

/usr/include/avogadro/plotwidget.h is in libavogadro-dev 1.2.0-3.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
/**********************************************************************
  PlotWidget -- 2D plotting interface

  Copyright (C) 2003 Jason Harris <kstars@30doradus.org> (KDE)
  Copyright (C) 2008 David Lonie <loniedavid@gmail.com> (Avogadro)

  This file is part of the Avogadro molecular editor project.
  For more information, see <http://avogadro.cc/>

  This file is based on KPlotWidget from the KDE library. For more
  information see <http://www.kde.org/>

  Avogadro is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  Avogadro is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  02110-1301, USA.
 **********************************************************************/

#ifndef PLOTWIDGET_H
#define PLOTWIDGET_H

#include <avogadro/plotaxis.h>
#include <avogadro/plotpoint.h>
#include <avogadro/plotobject.h>

#include <QtGui/QFrame>
#include <QtCore/QList>

namespace Avogadro {

    /**
     *@class PlotWidget plotwidget.h <avogadro/plotwidget.h>
     *
     *@short Generic data plotting widget.
     *
     *Widget for drawing plots. The basic idea behind PlotWidget is that
     *you don't have to worry about any transformation from your data's
     *natural units to screen pixel coordinates; this is handled internally
     *by the widget.
     *
     *Data to be plotted are represented by one or more instances of
     *PlotObject.  PlotObject contains a list of QPointFs to be plotted
     *(again, in the data's natural units), as well as information about how
     *the data are to be rendered in the plot (i.e., as separate points or
     *connected by lines?  With what color and point style? etc).  See
     *PlotObject for more information.
     *
     *PlotWidget automatically adds axis labels with tickmarks and tick
     *labels.  These are encapsulated in the PlotAxis class.  All you have
     *to do is set the limits of the plotting area in data units, and
     *PlotWidget wil figure out the optimal positions and labels for the
     *tickmarks on the axes.
     *
     *Use setDefaultLimits() to set the limits that a double click will restore.
     *This will also call setLimits() to update the plot. Not using
     *setDefaultLimits() or calling unsetDefaultLimits() will disable double
     *click.restoration.
     *
     *Example of usage:
     *
     * @code
     PlotWidget *kpw = new PlotWidget( parent );
     // setting our limits for the plot
     kpw->setDefaultLimits( 1.0, 5.0, 1.0, 25.0 );

     // creating a plot object whose points are connected by red lines ...
     PlotObject *kpo = new PlotObject( Qt::red, PlotObject::Lines );
     // ... adding some points to it ...
     for ( float x = 1.0; x <= 5.0; x += 0.1 )
     kpo->addPoint( x, x*x );

     // ... and adding the object to the plot widget
     kpw->addPlotObject( kpo );
     * @endcode
     *
     *@note PlotWidget will take care of the objects added to it, so when
     *clearing the objects list (eg with removeAllPlotObjects()) any previous
     *reference to a PlotObject already added to a PlotWidget will be invalid.
     *
     *@author Jason Harris
     *@version 1.1
     */

    class A_EXPORT PlotWidget : public QFrame {
        Q_OBJECT
        Q_PROPERTY(int leftPadding READ leftPadding)
            Q_PROPERTY(int rightPadding READ rightPadding)
            Q_PROPERTY(int topPadding READ topPadding)
            Q_PROPERTY(int bottomPadding READ bottomPadding)
            Q_PROPERTY(QColor backgroundColor READ backgroundColor WRITE setBackgroundColor)
            Q_PROPERTY(QColor foregroundColor READ foregroundColor WRITE setForegroundColor)
            Q_PROPERTY(QColor gridColor READ gridColor WRITE setGridColor)
            Q_PROPERTY(bool grid READ isGridShown WRITE setShowGrid)
            Q_PROPERTY(bool objectToolTip READ isObjectToolTipShown WRITE setObjectToolTipShown)
            public:
        /**
         *@short Constructor.
         *@param parent the parent widget
         */
            explicit PlotWidget( QWidget * parent = 0 );

        /**
         *@short Destructor.
         */
        virtual ~PlotWidget();

        /**
         * The four types of plot axes.
         */
        enum Axis
            {
                LeftAxis = 0,  ///< the left axis
                BottomAxis,    ///< the bottom axis
                RightAxis,     ///< the right axis
                TopAxis        ///< the top axis
            };
            
        /**
         * The four directions for label shift.
         */
        enum Direction
            {
                None = 0,
                Left,  ///< 
                Down,    ///<
                Right,     ///< 
                Up        ///< 
            };
            
        /**
         *@return suggested minimum size for the plot widget
         */
        virtual QSize minimumSizeHint() const;

        /**
         *@return suggested size for the plot widget
         */
        virtual QSize sizeHint() const;

        /**
         * Set new data limits for the plot.
         * @param x1 the minimum X value in data units
         * @param x2 the maximum X value in data units
         * @param y1 the minimum Y value in data units
         * @param y2 the maximum Y value in data units
         * @sa scaleLimits() setDefaultLimits()
         */
        void setLimits( double x1, double x2, double y1, double y2 );
        /**
         * Set new data limits for the plot.
         * @param rect rectangle containing all possible values of X and Y in data units
         * @sa scaleLimits() setDefaultLimits()
         */
        void setLimits( QRectF &rect);

        /**
         * Determine the limits of the plot by examining the PlotPoints.
         * Omit PlotPoint *po to examine all PlotObjects.
         * @param po the PlotObject to be used for scaling. Omit to look at all PlotObjects.
         * @sa setLimits()
         */
        void scaleLimits(PlotObject *po = NULL);

        /**
         * Set the default data limits for the plot. These are used for
         * restoring the limits to a "normal" setting when the widget
         * is double clicked. Calling this will also update the plot to
         * the new limits specified.
         * @param x1 the minimum X value in data units
         * @param x2 the maximum X value in data units
         * @param y1 the minimum Y value in data units
         * @param y2 the maximum Y value in data units
         * @sa setLimits() unsetDefaultLimits()
         */
        void setDefaultLimits( double x1, double x2, double y1, double y2 );

        void setDefaultLimits( QRectF &rect);

        /**
         * Clears the default limits and disables double click restoration.
         * @sa setLimits() setDefaultLimits()
         */
        void unsetDefaultLimits();

        /**
         * @short Reset the secondary data limits, which control the
         * values displayed along the top and right axes.
         *
         * All data points are *plotted* using the coordinates
         * defined by setLimits(), so this function is only useful for
         * showing alternate tickmark labels along the top and right
         * edges.  For example, if you were plotting temperature on the
         * X-axis, you could use Centigrade units for the primary
         * (bottom) axis, using setLimits( 0.0, 100.0, 0.0, 1.0 ).  If
         * you also wanted to show Farenheit units along the secondary
         * (top) axis, you would additionally use
         * setSecondaryLimits( 32.0, 212.0, 0.0, 1.0 ).  The data
         * added to the plot would have x-coordinates in Centigrade degrees.
         *
         * @param x1 the minimum X value in secondary data units
         * @param x2 the maximum X value in secondary data units
         * @param y1 the minimum Y value in secondary data units
         * @param y2 the maximum Y value in secondary data units
         * @sa setLimits()
         */
        void setSecondaryLimits( double x1, double x2, double y1, double y2 );

        /**
         * Unset the secondary limits, so the top and right axes
         * show the same tickmarks as the bottom and left axes (no tickmark
         * labels will be drawn for the top and right axes in this case)
         */
        void clearSecondaryLimits();

        /**
         * @return the rectangle representing the boundaries of the current plot,
         * in natural data units.
         * @sa setLimits() defaultDataRect()
         */
        QRectF dataRect() const;

        /**
         * @return the rectangle representing the boundaries of the default plot,
         * in natural data units.
         * @sa setLimits() dataRect()
         */
        QRectF defaultDataRect() const;

        /**
         * @return the rectangle representing the boundaries of the secondary
         * data limits, if they have been set.  Otherwise, this function
         * behaves the same as dataRect().
         * @sa setSecondaryLimits()
         */
        QRectF secondaryDataRect() const;

        /**
         * @return the rectangle representing the boundaries of the current plot,
         * in screen pixel units.
         */
        QRect pixRect() const;

        /**
         * Add an item to the list of PlotObjects to be plotted.
         * @note do not use this multiple time if many objects have to be added,
         * addPlotObjects() is strongly suggested in this case
         * @param object the PlotObject to be added
         */
        void addPlotObject( PlotObject *object );

        /**
         * Add more than one PlotObject at one time.
         * @param objects the list of PlotObjects to be added
         */
        void addPlotObjects( const QList< PlotObject* >& objects );

        /**
         * @return the current list of plot objects
         */
        QList< PlotObject* > plotObjects() const;

        /**
         * Remove and delete all items from the list of PlotObjects
         */
        void removeAllPlotObjects();

        /**
         * Reset the mask used for non-overlapping labels so that all
         * regions of the plot area are considered empty.
         */
        void resetPlotMask();

        /**
         * Clear the object list, reset the data limits, and remove axis labels
         */
        void resetPlot();

        /**
         * Replace an item in the PlotObject list.
         * @param i the index of the item to be replaced
         * @param o pointer to the replacement PlotObject
         */
        void replacePlotObject( int i, PlotObject *o );

        /**
         * @return the background color of the plot.
         *
         * The default color is black.
         */
        QColor backgroundColor() const;

        /**
         * @return the foreground color, used for axes, tickmarks and associated
         * labels.
         *
         * The default color is white.
         */
        QColor foregroundColor() const;

        /**
         * @return the grid color.
         *
         * The default color is gray.
         */
        QColor gridColor() const;

        /**
         * Set the background color
         * @param bg the new background color
         */
        void setBackgroundColor( const QColor &bg );

        /**
         * Set the foreground color
         * @param fg the new foreground color
         */
        void setForegroundColor( const QColor &fg );

        /**
         * Set the grid color
         * @param gc the new grid color
         */
        void setGridColor( const QColor &gc );

        /**
         * Set the font size
         * @param pointSize the new font size in pt
         */
        void setFontSize( int pointSize );

        /**
         * Set the font
         * @param font the new font as QFont
         */
        void setFont( QFont font );

        /**
         * Get the current font
         */
        QFont getFont();

        /**
         * @return whether the grid lines are shown
         * Grid lines are not shown by default.
         */
        bool isGridShown() const;

        /**
         * @return whether the tooltip for the point objects is shown.
         * Tooltips are enabled by default.
         */
        bool isObjectToolTipShown() const;

        /**
         * @return whether the antialiasing is active
         * Antialiasing is not active by default.
         */
        bool antialiasing() const;

        /**
         * Toggle antialiased drawing.
         * @param b if true, the plot graphics will be antialiased.
         */
        void setAntialiasing( bool b );

        /**
         * @return the number of pixels to the left of the plot area.
         *
         * Padding values are set to -1 by default; if unchanged, this
         * function will try to guess a good value, based on whether
         * ticklabels and/or axis labels need to be drawn.
         */
        int leftPadding() const;

        /**
         * @return the number of pixels to the right of the plot area.
         * Padding values are set to -1 by default; if unchanged, this
         * function will try to guess a good value, based on whether
         * ticklabels and/or axis labels are to be drawn.
         */
        int rightPadding() const;

        /**
         * @return the number of pixels above the plot area.
         * Padding values are set to -1 by default; if unchanged, this
         * function will try to guess a good value, based on whether
         * ticklabels and/or axis labels are to be drawn.
         */
        int topPadding() const;

        /**
         * @return the number of pixels below the plot area.
         * Padding values are set to -1 by default; if unchanged, this
         * function will try to guess a good value, based on whether
         * ticklabels and/or axis labels are to be drawn.
         */
        int bottomPadding() const;

        /**
         * @short Set the number of pixels to the left of the plot area.
         * Set this to -1 to revert to automatic determination of padding values.
         */
        void setLeftPadding( int padding );

        /**
         * @short Set the number of pixels to the right of the plot area.
         * Set this to -1 to revert to automatic determination of padding values.
         */
        void setRightPadding( int padding );

        /**
         * @short Set the number of pixels above the plot area.
         * Set this to -1 to revert to automatic determination of padding values.
         */
        void setTopPadding( int padding );

        /**
         * @short Set the number of pixels below the plot area.
         * Set this to -1 to revert to automatic determination of padding values.
         */
        void setBottomPadding( int padding );

        /**
         * @short Revert all four padding values to -1, so that they will be
         * automatically determined.
         */
        void setDefaultPaddings();

        /**
         * @short Map a coordinate @param p from the data rect to the physical
         * pixel rect.
         * Used mainly when drawing.
         * @param p the point to be converted, in natural data units
         * @return the coordinate in the pixel coordinate system
         */
        QPointF mapToWidget( const QPointF& p ) const;

        /**
         * @short Map a coordinate @param p from the physical pixel rect to the
         * data rect.
         * Used mainly when drawing.
         * @param p the point to be converted, in pixels
         * @return the coordinate in natural data units
         */
        QPointF mapToData( const QPointF& p ) const;

        /**
         * @short Map a coordinate @param p from the frame's pixel rect to the
         * data rect.
         * Used mainly when drawing.
         * @param p the point to be converted, in pixels
         * @return the coordinate in natural data units
         */
        QPointF mapFrameToData( const QPointF& p ) const;

        /**
         * Indicate that object labels should try to avoid the given
         * rectangle in the plot.  The rectangle is in pixel coordinates.
         *
         * @note You should not normally call this function directly.
         * It is called by PlotObject when points, bars and labels are drawn.
         * @param r the rectangle defining the region in the plot that
         * text labels should avoid (in pixel coordinates)
         * @param value Allows you to determine how strongly the rectangle
         * should be avoided.  Larger values are avoided more strongly.
         */
        void maskRect( const QRectF &r, float value=1.0 );

        /**
         * Indicate that object labels should try to avoid the line
         * joining the two given points (in pixel coordinates).
         *
         * @note You should not normally call this function directly.
         * It is called by PlotObject when lines are drawn in the plot.
         * @param p1 the starting point for the line
         * @param p2 the ending point for the line
         * @param value Allows you to determine how strongly the line
         * should be avoided.  Larger values are avoided more strongly.
         */
        void maskAlongLine( const QPointF &p1, const QPointF &p2, float value=1.0 );

        /**
         * Place an object label optimally in the plot.  This function will
         * attempt to place the label as close as it can to the point to which
         * the label belongs, while avoiding overlap with regions of the plot
         * that have been masked.
         *
         * @note You should not normally call this function directly.
         * It is called internally in PlotObject::draw().
         *
         * @param painter Pointer to the painter on which to draw the label
         * @param pp pointer to the PlotPoint whose label is to be drawn.
         */
        void placeLabel( QPainter *painter, PlotPoint *pp );

        /**
         * @return the axis of the specified @p type, or 0 if no axis has been set.
         * @sa Axis
         */
        PlotAxis* axis( Axis type );

        /**
         * @return the axis of the specified @p type, or 0 if no axis has been set.
         * @sa Axis
         */
        const PlotAxis* axis( Axis type ) const;

       signals:
        /**
         * Get the point in data units selected by a left click.
         * @param x X value
         * @param y Y value
         */
        void pointClicked(double x, double y);

        /**
         * Get a list of points in data units within 4 pixels of a left click.
         * @param pl List of PlotPoints
         */
        void pointClicked(const QList<PlotPoint*> & pl);

        /**
         * Get the nearest point to a left click event.
         * @param p PlotPoint nearest click location
         */
        void pointClicked(PlotPoint*);

        /**
         * Get the point in data units from a mouseover. Use setMouseTracking(true) to enable.
         * @param x X value
         * @param y Y value
         */
        void mouseOverPoint(double x, double y);

       public Q_SLOTS:
        /**
         * Toggle whether grid lines are drawn at major tickmarks.
         * @param show if true, grid lines will be drawn.
         * @sa isGridShown()
         */
        void setShowGrid( bool show );

        /**
         * Toggle the display of a tooltip for point objects.
         * @param show whether show the tooltip.
         * @sa isObjectToolTipShown()
         */
        void setObjectToolTipShown( bool show );

        /**
         * Save the plot to an image.
         * @param filename name of the file. Format will be guess from the file extension
         * @param width width of the image in meters
         * @param height height of the image in meters
         * @param dpi resolution of the image in dots per inch
         * @param optimizeFontSize set this to true to automatically determine a appropriate font size
         */
        bool saveImage(const QString &filename, double width, double height, double dpi, bool optimizeFontSize );

        /**
         * Mark the indicated point with a yellow circle.
         * @param point PlotPoint to be highlighted
         * @sa clearAndSelectPoint() selectPoints() clearAndSelectPoints() clearSelection() setPointFollowMouse()
         */
        void selectPoint(PlotPoint* point);

        /**
         * Mark the indicated points with yellow circles.
         * @param points QList of PlotPoints to be highlighted
         * @sa selectPoint() clearAndSelectPoint() clearAndSelectPoints() clearSelection() setPointFollowMouse()
         */
        void selectPoints(const QList<PlotPoint*> & points);

        /**
         * Just like selectPoint(), but clears selection first.
         * @param point PlotPoint to be highlighted
         * @sa selectPoint() selectPoints() clearAndSelectPoints() clearSelection() setPointFollowMouse()
         */
        void clearAndSelectPoint(PlotPoint* point);

        /**
         * Just like selectPoints(), but clears selection first.
         * @param points QList of PlotPoints to be highlighted
         * @sa selectPoint() clearAndSelectPoint() selectPoints() clearSelection() setPointFollowMouse()
         */
        void clearAndSelectPoints(const QList<PlotPoint*> & points);

        /**
         * Clear out the selected points
         * @sa selectPoint() clearAndSelectPoint() selectPoints() clearAndSelectPoints() setPointFollowMouse()
         */
        void clearSelection();

        /**
         * Highlight the point nearest the mouse with a blue circle.
         * @sa selectPoint() clearAndSelectPoint() selectPoints() clearAndSelectPoints() clearSelection()
         */
        void setPointFollowMouse(bool b);
        
        /**
         * Don't permit moving away from default limits
         */
        void setJailedInDefaults(bool b);

        void setLabelShiftDirection(Direction dir, float priority=2.0);

    protected:
        /**
         * Generic event handler.
         */
        virtual bool event( QEvent* );

        /**
         * Mouse handler.
         */
        virtual void mouseMoveEvent(QMouseEvent *event);

        /**
         * Mouse handler.
         */
        virtual void mousePressEvent(QMouseEvent *event);

        /**
         * Mouse handler.
         */
        virtual void mouseDoubleClickEvent(QMouseEvent *event);

        /**
         * Mouse handler.
         */
        virtual void mouseReleaseEvent(QMouseEvent *event);

        /**
         * Wheel handler for zooming.
         */
        virtual void wheelEvent(QWheelEvent *event);

        /**
         * The paint event handler, executed when update() or repaint() is called.
         */
        virtual void paintEvent( QPaintEvent* );

        /**
         * The resize event handler, called when the widget is resized.
         */
        virtual void resizeEvent( QResizeEvent* );

        /**
         * Draws the plot axes and axis labels.
         * @internal Internal use only; one should simply call update()
         * to draw the widget with axes and all objects.
         * @param p pointer to the painter on which we are drawing
         */
        virtual void drawAxes( QPainter *p );

        /**
         * Synchronize the PixRect with the current widget size and
         * padding settings.
         */
        void setPixRect();

        /**
         * @return a list of points in the plot which are within 4 pixels
         * of the screen position given as an argument.
         * @param p The screen position from which to check for plot points.
         */
        QList<PlotPoint*> pointsUnderPoint( const QPoint& p ) const;

        /**
         * @return the nearest point in the plot to p
         * @param p The screen position from which to check for plot points.
         */
        PlotPoint* pointNearestPoint( const QPoint& p ) const;

    private:
        class Private;
        Private * const d;

        QPointF mouseClickOrigin, zoomPosF;

        Q_DISABLE_COPY( PlotWidget )
    };

}

#endif