[fuse-emulator-cvs] [fuse] branch master updated: Arki55 T6 - Describing file format in options.dat

[<al...@us...>]

This is an automated email from the git hooks/post-receive-user script.

allura pushed a commit to branch master
in repository fuse.

View the commit online:
https://sourceforge.net/p/fuse-emulator/fuse/ci/c5e6e6194e153cd21366a9908c8ad14cd583d4bf/

The following commit(s) were added to refs/heads/master by this push:
     new c5e6e619 Arki55 T6 - Describing file format in options.dat
     new 844574de Merge /u/arki55/fuse/ branch arki55/features/T6-options-dat-description into master
c5e6e619 is described below

commit c5e6e6194e153cd21366a9908c8ad14cd583d4bf
Author: Miroslav Ďurčík / Arki55 <mir...@gm...>
AuthorDate: Sun Dec 18 00:14:09 2022 +0100

    Arki55 T6 - Describing file format in options.dat
---
 ui/options.dat | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

diff --git a/ui/options.dat b/ui/options.dat
index 2916ef01..450e505d 100644
--- a/ui/options.dat
+++ b/ui/options.dat
@@ -1,3 +1,52 @@
+# options.dat: Data file for options dialog boxes
+# Copyright (c) 2001-2013 Philip Kendall, Marek Januszewski, Stuart Brady
+#
+# 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.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+# Author contact information:
+#
+# E-mail: phi...@sh...
+#
+# File is preprocessed by cpp-perl.pl to apply some .h like conditions (see Makefile.am),
+#   and then parsed by script Dialog.pm (Perl package Fuse::Dialog).
+#
+# Format of this file is as follows:
+#   - Description of this file, comments. Section will be ignored.
+#   - Blocks of option dialog boxes' data.
+#
+# Structure of each block:
+#   - 1x line - keyword for dialog box
+#   - 1x line - English description for dialog box
+#   - 1-N lines with options - one line per 1 option
+#   - 1-2 lines with callbacks
+#   - Empty line (end of one block)
+#
+# Structure of option line:
+#   Type, English translation, setting ID, shortcut key ID [ , Data 1 ] [ , Data 2 ]
+#     Wrapping some letter in description into () will underline it as hint for key shortcut.
+#     Setting ID must be defined in file settings.dat (there it defines also type and default value).
+#
+# Possible types:
+#   - Entry (input text) - uses data 1: max. length, data 2: label text (only in GTK).
+#   - Checkbox
+#   - Combo - uses data 1: Dropdown values separated with "|" . "*" specifies default value.
+#
+# Callbacks:
+#   - Postcheck, callback function - Called function should return if to reset machine (see needs_hard_reset).
+#   - Posthook, callback function - Will be called after settings are saved.
+#
 general
 General Options
 Entry, (E)mulation speed, emulation_speed, INPUT_KEY_e, 5, %