annotate libinterp/corefcn/display.h @ 27919:1891570abac8

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.
author John W. Eaton <jwe@octave.org>
date Mon, 06 Jan 2020 22:29:51 -0500
parents b442ec6dda5c
children bd51beb6205e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8561
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
1 /*
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
2
27919
1891570abac8 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27918
diff changeset
3 Copyright (C) 2009-2020 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 27275
diff changeset
4
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 27275
diff changeset
5 See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 27275
diff changeset
6 or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 27275
diff changeset
7
8561
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
8
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
9 This file is part of Octave.
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
10
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23795
diff changeset
11 Octave is free software: you can redistribute it and/or modify it
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
12 under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23795
diff changeset
13 the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
14 (at your option) any later version.
8561
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
15
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
16 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
17 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
19 GNU General Public License for more details.
8561
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
20
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
21 You should have received a copy of the GNU General Public License
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
22 along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23795
diff changeset
23 <https://www.gnu.org/licenses/>.
8561
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
24
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
25 */
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
26
20791
f7084eae3318 maint: Use Octave coding conventions for #if statements.
Rik <rik@octave.org>
parents: 19697
diff changeset
27 #if ! defined (octave_display_h)
8561
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
28 #define octave_display_h 1
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
29
21244
1473547f50f5 include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents: 20947
diff changeset
30 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents: 20947
diff changeset
31
20947
ecb95c6384f2 backout changeset e74e617060cf
John W. Eaton <jwe@octave.org>
parents: 20924
diff changeset
32 #include <string>
17828
6b787e274eb1 make -q suppress no graphical display startup message (bug #38937)
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
33
20947
ecb95c6384f2 backout changeset e74e617060cf
John W. Eaton <jwe@octave.org>
parents: 20924
diff changeset
34 class Matrix;
8561
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
35
23746
7f176909ab86 move display_info class inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
36 namespace octave
8561
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
37 {
27266
596312d4f25d don't use singleton pattern for display_info class
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
38 class display_info
17828
6b787e274eb1 make -q suppress no graphical display startup message (bug #38937)
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
39 {
23746
7f176909ab86 move display_info class inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
40 public:
7f176909ab86 move display_info class inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
41
27266
596312d4f25d don't use singleton pattern for display_info class
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
42 // Create object with default values. To be useful, you must call
596312d4f25d don't use singleton pattern for display_info class
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
43 // initialize to find the actual system parameters for the given
596312d4f25d don't use singleton pattern for display_info class
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
44 // display.
23746
7f176909ab86 move display_info class inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
45
27266
596312d4f25d don't use singleton pattern for display_info class
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
46 display_info (void)
27275
1565c39aa940 don't show display warning in display_info initialization (bug #56651)
John W. Eaton <jwe@octave.org>
parents: 27266
diff changeset
47 : m_rx (72), m_ry (72), m_ht (1), m_wd (1), m_dp (0),
1565c39aa940 don't show display warning in display_info initialization (bug #56651)
John W. Eaton <jwe@octave.org>
parents: 27266
diff changeset
48 m_dpy_avail (false), m_msg ()
27266
596312d4f25d don't use singleton pattern for display_info class
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
49 { }
13983
7dd7cccf0757 clean up memory allocated for singletons before exit
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
50
27266
596312d4f25d don't use singleton pattern for display_info class
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
51 ~display_info (void) = default;
596312d4f25d don't use singleton pattern for display_info class
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
52
596312d4f25d don't use singleton pattern for display_info class
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
53 display_info (const display_info&) = default;
596312d4f25d don't use singleton pattern for display_info class
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
54
596312d4f25d don't use singleton pattern for display_info class
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
55 display_info& operator = (const display_info&) = default;
23746
7f176909ab86 move display_info class inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
56
27266
596312d4f25d don't use singleton pattern for display_info class
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
57 void initialize (void);
8561
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
58
27266
596312d4f25d don't use singleton pattern for display_info class
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
59 double x_dpi (void) const { return m_rx; }
596312d4f25d don't use singleton pattern for display_info class
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
60
596312d4f25d don't use singleton pattern for display_info class
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
61 double y_dpi (void) const { return m_ry; }
8561
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
62
27266
596312d4f25d don't use singleton pattern for display_info class
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
63 int height (void) const { return m_ht; }
596312d4f25d don't use singleton pattern for display_info class
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
64
596312d4f25d don't use singleton pattern for display_info class
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
65 int width (void) const { return m_wd; }
15160
973296940c89 don't start GUI if display is not available
John W. Eaton <jwe@octave.org>
parents: 15096
diff changeset
66
27266
596312d4f25d don't use singleton pattern for display_info class
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
67 int depth (void) const { return m_dp; }
596312d4f25d don't use singleton pattern for display_info class
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
68
596312d4f25d don't use singleton pattern for display_info class
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
69 bool display_available (void) const { return m_dpy_avail; }
17828
6b787e274eb1 make -q suppress no graphical display startup message (bug #38937)
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
70
27275
1565c39aa940 don't show display warning in display_info initialization (bug #56651)
John W. Eaton <jwe@octave.org>
parents: 27266
diff changeset
71 std::string message (void) const { return m_msg; }
1565c39aa940 don't show display warning in display_info initialization (bug #56651)
John W. Eaton <jwe@octave.org>
parents: 27266
diff changeset
72
23746
7f176909ab86 move display_info class inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
73 private:
7f176909ab86 move display_info class inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
74
27266
596312d4f25d don't use singleton pattern for display_info class
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
75 // X- and Y- Resolution of the display in dots (pixels) per inch.
596312d4f25d don't use singleton pattern for display_info class
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
76 double m_rx;
596312d4f25d don't use singleton pattern for display_info class
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
77 double m_ry;
8561
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
78
23746
7f176909ab86 move display_info class inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
79 // Height, width, and depth of the display.
7f176909ab86 move display_info class inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
80 int m_ht;
7f176909ab86 move display_info class inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
81 int m_wd;
7f176909ab86 move display_info class inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
82 int m_dp;
8561
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
83
23746
7f176909ab86 move display_info class inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
84 bool m_dpy_avail;
27275
1565c39aa940 don't show display warning in display_info initialization (bug #56651)
John W. Eaton <jwe@octave.org>
parents: 27266
diff changeset
85
1565c39aa940 don't show display warning in display_info initialization (bug #56651)
John W. Eaton <jwe@octave.org>
parents: 27266
diff changeset
86 // Message associated with any initiailization failure. Set if
1565c39aa940 don't show display warning in display_info initialization (bug #56651)
John W. Eaton <jwe@octave.org>
parents: 27266
diff changeset
87 // m_dpy_avail is false.
1565c39aa940 don't show display warning in display_info initialization (bug #56651)
John W. Eaton <jwe@octave.org>
parents: 27266
diff changeset
88 std::string m_msg;
23746
7f176909ab86 move display_info class inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
89 };
7f176909ab86 move display_info class inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 23220
diff changeset
90 }
8561
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
91
66165de2cc42 add new files for previous changeset
John W. Eaton <jwe@octave.org>
parents:
diff changeset
92 #endif