File: ConfigurationDialog.pm

package info (click to toggle)
libdemeter-perl 0.9.27%2Bds6-9
  • links: PTS, VCS
  • area: contrib
  • in suites: forky, sid, trixie
  • size: 74,028 kB
  • sloc: perl: 73,233; python: 2,196; makefile: 1,999; ansic: 1,368; lisp: 454; sh: 74
file content (165 lines) | stat: -rw-r--r-- 4,459 bytes parent folder | download
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
package Demeter::UI::Wx::ConfigurationDialog;

=for Copyright
 .
 Copyright (c) 2006-2019 Bruce Ravel (http://bruceravel.github.io/home).
 All rights reserved.
 .
 This file is free software; you can redistribute it and/or
 modify it under the same terms as Perl itself. See The Perl
 Artistic License.
 .
 This program 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.

=cut


=head1 NAME

Demeter::UI::Wx::ConfigurationDialog - A Wx dialog with a checkbox for suppressing the dialog in the future

=head1 VERSION

This documentation refers to Demeter version 0.9.26.

=head1 SYNOPSIS

This dialog presents an informational message (like a
Wx::MessageDialog),and presents the user with a checkbox for
suppressing the message in the future.  The intent is that the return
value of the dialog will be used to set a boolean configuration
parameter.

  use Demeter::UI::Wx::VerbDialog;
  my $dialog = Demeter::UI::Wx::VerbDialog->new($parent, -1,
                          "Warning, Will Robinson!,
                          "Warning!",
                          );

When shown, a window like this is displayed:

   +-----------------------------------------+
   |                Warning!                 |
   +-----------------------------------------+
   |  Warning, Will Robinson!                |
   | _______________________________________ |
   |                               +------+  |
   |  [ ] Do not show again        |  OK  |  |
   |                               +------+  |
   +-----------------------------------------+

The dialog returns the value of the checkbox, which can then be used
to set a boolean:

   my $value = $dialog -> ShowModal;
   Demeter -> co -> set_default($group, $parameter, $value);

=head1 DESCRIPTION

The arguments of the constructor are

=over 4

=item 1.

The parent widget

=item 2.

The ID

=item 3.

The text for the body of the dialog

=item 4.

The text for the title of the dialog

=item 5.

Optional verb for checkbox label.  Default is to say "Do not show
again".  "ask" might be a better choice if C<$message> is a question.

=head1 BUGS AND LIMITATIONS

Please report problems to the Ifeffit Mailing List
(L<http://cars9.uchicago.edu/mailman/listinfo/ifeffit/>)

Patches are welcome.

=head1 AUTHOR

Bruce Ravel, L<http://bruceravel.github.io/home>

L<http://bruceravel.github.io/demeter/>

=head1 LICENCE AND COPYRIGHT

Copyright (c) 2006-2019 Bruce Ravel (L<http://bruceravel.github.io/home>). All rights reserved.

This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See L<perlgpl>.

This program 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.

=cut


use strict;
use warnings;
use Carp;
use Text::Wrap;
use Wx qw( :everything );
use Wx::Event qw(EVT_BUTTON);
use base 'Wx::Dialog';


sub new {
  my ($class, $parent, $id, $message, $title, $verb) = @_;
  $verb ||= 'show';

  my $this = $class->SUPER::new($parent, $id, $title, wxDefaultPosition, wxDefaultSize,
				wxCLOSE_BOX|wxCAPTION|wxSYSTEM_MENU|wxSTAY_ON_TOP
			       );

  my $vbox = Wx::BoxSizer->new( wxVERTICAL );
  my $hbox = Wx::BoxSizer->new( wxHORIZONTAL );

  local $Text::Wrap::columns = 60;

  my $info = Wx::Bitmap->new( wxTheApp->GetStdIcon( wxICON_INFORMATION ) );
  $hbox->Add(Wx::StaticBitmap->new($this, -1, $info, wxDefaultPosition, wxDefaultSize), 0, wxTOP|wxBOTTOM, 10);
  $hbox->Add(Wx::StaticText->new($this, -1, wrap(q{}, q{}, $message), wxDefaultPosition, [-1,-1]), 0, wxALL|wxGROW, 20);
  $vbox->Add($hbox, 0, wxALL|wxGROW, 2);

  $vbox->Add(Wx::StaticLine->new($this, -1, [-1,-1], [1,1], wxLI_HORIZONTAL), 0, wxALL|wxGROW, 2);

  $hbox = Wx::BoxSizer->new( wxHORIZONTAL );

  my $check = Wx::CheckBox -> new($this, -1, "Do not $verb again", wxDefaultPosition, wxDefaultSize);
  $hbox->Add($check, 0, wxALL, 2);

  $hbox->Add(1,1,1);

  my $button = Wx::Button->new($this, wxID_OK, q{}, wxDefaultPosition, wxDefaultSize);
  $hbox->Add($button, 0, wxALL, 2);
  $button->SetFocus;
  EVT_BUTTON($this, $button, sub{OnButton(@_, $check->GetValue)});
  $vbox->Add($hbox, 0, wxALL|wxGROW, 2);

  $this->SetSizerAndFit($vbox);
  return $this;
};


sub OnButton {
  my ($this, $event, $value) = @_;
  $this->EndModal($value);
};

1;