annotate scripts/gui/dialog.m @ 27918:b442ec6dda5c

use centralized file for copyright info for individual contributors * COPYRIGHT.md: New file. * In most other files, use "Copyright (C) YYYY-YYYY The Octave Project Developers" instead of tracking individual names in separate source files. The motivation is to reduce the effort required to update the notices each year. Until now, the Octave source files contained copyright notices that list individual contributors. I adopted these file-scope copyright notices because that is what everyone was doing 30 years ago in the days before distributed version control systems. But now, with many contributors and modern version control systems, having these file-scope copyright notices causes trouble when we update copyright years or refactor code. Over time, the file-scope copyright notices may become outdated as new contributions are made or code is moved from one file to another. Sometimes people contribute significant patches but do not add a line claiming copyright. Other times, people add a copyright notice for their contribution but then a later refactoring moves part or all of their contribution to another file and the notice is not moved with the code. As a practical matter, moving such notices is difficult -- determining what parts are due to a particular contributor requires a time-consuming search through the project history. Even managing the yearly update of copyright years is problematic. We have some contributors who are no longer living. Should we update the copyright dates for their contributions when we release new versions? Probably not, but we do still want to claim copyright for the project as a whole. To minimize the difficulty of maintaining the copyright notices, I would like to change Octave's sources to use what is described here: https://softwarefreedom.org/resources/2012/ManagingCopyrightInformation.html in the section "Maintaining centralized copyright notices": The centralized notice approach consolidates all copyright notices in a single location, usually a top-level file. This file should contain all of the copyright notices provided project contributors, unless the contribution was clearly insignificant. It may also credit -- without a copyright notice -- anyone who helped with the project but did not contribute code or other copyrighted material. This approach captures less information about contributions within individual files, recognizing that the DVCS is better equipped to record those details. As we mentioned before, it does have one disadvantage as compared to the file-scope approach: if a single file is separated from the distribution, the recipient won't see the contributors' copyright notices. But this can be easily remedied by including a single copyright notice in each file's header, pointing to the top-level file: Copyright YYYY-YYYY The Octave Project Developers See the COPYRIGHT file at the top-level directory of this distribution or at https://octave.org/COPYRIGHT.html. followed by the usual GPL copyright statement. For more background, see the discussion here: https://lists.gnu.org/archive/html/octave-maintainers/2020-01/msg00009.html Most files in the following directories have been skipped intentinally in this changeset: doc libgui/qterminal liboctave/external m4
author John W. Eaton <jwe@octave.org>
date Mon, 06 Jan 2020 15:38:17 -0500
parents 00f796120a6d
children 1891570abac8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
1 ## Copyright (C) 2016-2019 The Octave Project Developers
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
2 ##
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
3 ## 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: 26376
diff changeset
4 ## or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
5 ##
21825
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
6 ##
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
7 ## This file is part of Octave.
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
8 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
9 ## Octave is free software: you can redistribute it and/or modify it
21825
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
10 ## 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: 23220
diff changeset
11 ## the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22299
diff changeset
12 ## (at your option) any later version.
21825
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
13 ##
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
14 ## Octave is distributed in the hope that it will be useful, but
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
15 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22299
diff changeset
16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22299
diff changeset
17 ## GNU General Public License for more details.
21825
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
18 ##
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
19 ## You should have received a copy of the GNU General Public License
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
20 ## 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: 23220
diff changeset
21 ## <https://www.gnu.org/licenses/>.
21825
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
22
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
23 ## -*- texinfo -*-
22787
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
24 ## @deftypefn {} {@var{h} =} dialog ()
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
25 ## @deftypefnx {} {@var{h} =} dialog ("@var{property}", @var{value}, @dots{})
21825
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
26 ##
22787
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
27 ## Create an empty modal dialog window to which other uicontrols can be added.
21825
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
28 ##
22299
9fc91bb2aec3 doc: grammarcheck documentation for 4.2 release.
Rik <rik@octave.org>
parents: 21937
diff changeset
29 ## The dialog box is a figure object with properties as recommended for a
9fc91bb2aec3 doc: grammarcheck documentation for 4.2 release.
Rik <rik@octave.org>
parents: 21937
diff changeset
30 ## dialog box.
21825
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
31 ##
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
32 ## The default properties differing from a figure are:
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
33 ##
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
34 ## @table @asis
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
35 ## @item buttondownfcn
22787
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
36 ## @code{if isempty (allchild(gcbf)), close (gcbf), endif}
21825
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
37 ##
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
38 ## @item colormap
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
39 ## []
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
40 ##
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
41 ## @item color
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
42 ## defaultuicontrolbackgroundcolor
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
43 ##
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
44 ## @item dockcontrols
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
45 ## off
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
46 ##
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
47 ## @item handlevisibility
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
48 ## callback
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
49 ##
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
50 ## @item integerhandle
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
51 ## off
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
52 ##
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
53 ## @item inverthardcopy
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
54 ## off
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
55 ##
21937
55f7de37b618 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 21825
diff changeset
56 ## @item menubar
21825
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
57 ## none
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
58 ##
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
59 ## @item numbertitle
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
60 ## off
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
61 ##
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
62 ## @item paperpositionmode
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
63 ## auto
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
64 ##
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
65 ## @item resize
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
66 ## off
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
67 ##
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
68 ## @item windowstyle
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
69 ## modal
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
70 ##
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
71 ## @end table
21937
55f7de37b618 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 21825
diff changeset
72 ##
21825
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
73 ##
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
74 ## Multiple property-value pairs may be specified for the dialog object, but
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
75 ## they must appear in pairs.
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
76 ##
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
77 ## The return value @var{h} is a graphics handle to the created figure.
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
78 ##
22787
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
79 ## Example:
21825
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
80 ##
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
81 ## @example
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
82 ## @group
22787
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
83 ## ## create an empty dialog window titled "Dialog Example"
21825
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
84 ## h = dialog ("name", "Dialog Example");
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
85 ##
22787
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
86 ## ## create a button (default style)
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
87 ## b = uicontrol (h, "string", "OK",
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
88 ## "position", [10 10 150 40],
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
89 ## "callback", "delete (gcf)");
21825
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
90 ##
22787
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
91 ## ## wait for dialog to resume or close
21825
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
92 ## uiwait (h);
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
93 ## @end group
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
94 ## @end example
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
95 ##
22787
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
96 ## @seealso{errordlg, msgbox, questdlg, warndlg, figure, uiwait}
21825
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
97 ## @end deftypefn
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
98
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
99 ## Author: jdonoghue
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
100
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
101 function h = dialog (varargin)
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
102
22787
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
103 h = figure ( ...
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
104 "buttondownfcn", "if isempty (allchild (gcbf)), close (gcbf), endif",
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
105 "color", get (0,"defaultuicontrolbackgroundcolor"),
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
106 "colormap", [],
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
107 "dockcontrols", "off",
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
108 "handlevisibility", "callback",
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
109 "integerhandle", "off",
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
110 "inverthardcopy", "off",
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
111 "menubar", "none",
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
112 "numbertitle", "off",
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
113 "paperpositionmode", "auto",
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
114 "resize", "off",
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
115 "toolbar", "none",
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
116 "windowstyle", "modal",
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
117 varargin{:});
21937
55f7de37b618 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 21825
diff changeset
118
21825
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
119 endfunction
f1f17f13b3b9 Add dialog function (Bug #48136)
John Donoghue <john.donoghue@ieee.org>
parents:
diff changeset
120
22787
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
121 ## No BIST tests. This function just dispatches to figure().
fadaacb3d816 dialog.m: Overhaul function.
Rik <rik@octave.org>
parents: 22755
diff changeset
122 %!assert (1)