summaryrefslogtreecommitdiff
path: root/textscreen/txt_fileselect.h
diff options
context:
space:
mode:
authorSimon Howard2013-04-01 14:59:34 +0000
committerSimon Howard2013-04-01 14:59:34 +0000
commit47af28e16863f08efd7f8f8ab04b9bcf44846cbd (patch)
tree34a49cc30f9ff65c0e56fc6c2708a2eb17f81ecb /textscreen/txt_fileselect.h
parent917aa5b184fdfc03a80ce46fb857c3a2780dc705 (diff)
parentbd0f386997cccbeb41103d76f3dc6d9484800f0d (diff)
downloadchocolate-doom-47af28e16863f08efd7f8f8ab04b9bcf44846cbd.tar.gz
chocolate-doom-47af28e16863f08efd7f8f8ab04b9bcf44846cbd.tar.bz2
chocolate-doom-47af28e16863f08efd7f8f8ab04b9bcf44846cbd.zip
Merge from trunk.
Subversion-branch: /branches/v2-branch Subversion-revision: 2577
Diffstat (limited to 'textscreen/txt_fileselect.h')
-rw-r--r--textscreen/txt_fileselect.h88
1 files changed, 88 insertions, 0 deletions
diff --git a/textscreen/txt_fileselect.h b/textscreen/txt_fileselect.h
new file mode 100644
index 00000000..dc65643d
--- /dev/null
+++ b/textscreen/txt_fileselect.h
@@ -0,0 +1,88 @@
+// Emacs style mode select -*- C++ -*-
+//-----------------------------------------------------------------------------
+//
+// Copyright(C) 2013 Simon Howard
+//
+// 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.
+//
+//-----------------------------------------------------------------------------
+//
+// Routines for selecting files, and the txt_fileselect_t widget.
+//
+//-----------------------------------------------------------------------------
+
+#ifndef TXT_FILESELECT_H
+#define TXT_FILESELECT_H
+
+/**
+ * @file txt_fileselect.h
+ *
+ * File selection widget.
+ */
+
+/**
+ * File selection widget.
+ *
+ * A file selection widget resembles an input box (@ref txt_inputbox_t)
+ * but opens a file selector dialog box when clicked.
+ */
+
+typedef struct txt_fileselect_s txt_fileselect_t;
+
+/**
+ * Returns non-zero if a native file selector is available on this
+ * platform.
+ */
+
+int TXT_CanSelectFiles(void);
+
+/**
+ * Open a native file selector to select a file.
+ *
+ * @param prompt Pointer to a string containing a prompt to display
+ * in the window.
+ * @param extensions NULL-terminated list of filename extensions for
+ * files that can be selected, or @ref TXT_DIRECTORY
+ * to select directories.
+ */
+
+char *TXT_SelectFile(char *prompt, char **extensions);
+
+/**
+ * Create a new txt_fileselect_t widget.
+ *
+ * @param variable Pointer to a char * variable in which the selected
+ * file should be stored.
+ * @param size Width of the file selector widget in characters.
+ * @param prompt Pointer to a string containing a prompt to display
+ * in the file selection window.
+ * @param extensions NULL-terminated list of filename extensions that
+ * can be used for this widget, or @ref TXT_DIRECTORY
+ * to select directories.
+ */
+
+txt_fileselect_t *TXT_NewFileSelector(char **variable, int size,
+ char *prompt, char **extensions);
+
+/**
+ * Special value to use for 'extensions' that selects a directory
+ * instead of a file.
+ */
+
+extern char *TXT_DIRECTORY[];
+
+#endif /* #ifndef TXT_FILESELECT_H */
+