summaryrefslogtreecommitdiff
path: root/src/w32dlib/common.h
blob: 004d81ff0bf32c954986818dfae6ac5e5a27bad7 (plain)
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
//  w32dlib - Win32 Dialog Helpers
//
//  Copyright (C) 2005  Ian Cowburn (ianc@noddybox.demon.co.uk)
//
//  This program 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.
//
//  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.  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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
//  -------------------------------------------------------------------------
//
#ifndef W32DLIB_COMMON_H

#define W32DLIB_COMMON_H	"$Id$"

#include "w32dlib/base.h"

namespace W32DLib
{

    /// \brief The Common class.
    ///
    /// This class provides common dialogs and useful routines.
    ///
    class Common
    {
    public:

	/// \brief Displays a message box.
	///
	/// \param parent Parent window (NULL for none)
	/// \param msg The message to display.
	///
	static void		Message(HWND parent, const char *msg);


	/// \brief Displays an error message box.
	///
	/// \param parent Parent window (NULL for none)
	/// \param msg The error message to display.
	///
	static void		Error(HWND parent, const char *msg);


	/// \brief Displays a Yes/No message box.
	///
	/// \param parent Parent window (NULL for none)
	/// \param msg The message to display.
	/// \return True if the user selects Yes.
	///
	static bool		Query(HWND parent, const char *msg);


	/// \brief Requests a file to open.
	///
	/// \param filter The file selector filter.
	/// \return The path, or an empty string if non selected.
	///
	static std::string	OpenFile(const char *filter);


	/// \brief Requests a file to save.
	///
	/// \param filter The file selector filter.
	/// \return The path, or an empty string if non selected.
	///
	static std::string	SaveFile(const char *filter);


	/// \brief Selects a directory
	///
	/// \return The path, or an empty string if non selected.
	///
	static std::string	SelectDirectory();


	/// \brief Returns the last error as a readable string.
	///
	/// \return The error message
	///
	static std::string	GetOSError();


	/// \brief Get the application HINSTANCE.
	///
	/// \return The HINSTANCE
	///
	static HINSTANCE	GetInstance();


    private:
    	Common();

    };	// class Common

};	// namespace w32dlib

#endif	// W32DLIB_COMMON_H


// END OF FILE