ProteoWizard
ClickwrapPrompter.hpp
Go to the documentation of this file.
1//
2// $Id$
3//
4//
5// Original author: Matt Chambers <matt.chambers .@. vanderbilt.edu>
6//
7// Copyright 2010 Vanderbilt University - Nashville, TN 37232
8//
9// Licensed under the Apache License, Version 2.0 (the "License");
10// you may not use this file except in compliance with the License.
11// You may obtain a copy of the License at
12//
13// http://www.apache.org/licenses/LICENSE-2.0
14//
15// Unless required by applicable law or agreed to in writing, software
16// distributed under the License is distributed on an "AS IS" BASIS,
17// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18// See the License for the specific language governing permissions and
19// limitations under the License.
20//
21
22
23#ifndef CLICKWRAPPROMPTER_HPP_
24#define CLICKWRAPPROMPTER_HPP_
25
26
27#include "Export.hpp"
28#include <string>
29
30
31namespace pwiz {
32namespace util {
33
34
35/// a barrier to force end users to agree/disagree to a prompt before continuing
37{
38 public:
39
40 /// shows a modal dialog with the specified caption, text, and Agree/Disagree buttons;
41 /// returns true iff the user clicked the Agree button;
42 /// if oneTimeKey is non-empty, all calls with that key after the user has agreed will be ignored
43 static bool prompt(const std::string& caption, const std::string& text, const std::string& oneTimeKey = "");
44};
45
46
47} // namespace util
48} // namespace pwiz
49
50
51#endif // CLICKWRAPPROMPTER_HPP_
#define PWIZ_API_DECL
Definition Export.hpp:32
a barrier to force end users to agree/disagree to a prompt before continuing
static bool prompt(const std::string &caption, const std::string &text, const std::string &oneTimeKey="")
shows a modal dialog with the specified caption, text, and Agree/Disagree buttons; returns true iff t...