/*
 * Project: MoleCuilder
 * Description: creates and alters molecular systems
 * Copyright (C)  2010 University of Bonn. All rights reserved.
 * Please see the LICENSE file or "Copyright notice" in builder.cpp for details.
 */

/**
 * \file userinterfaces.dox
 *
 * Created on: Oct 31, 2011
 *    Author: heber
 */

/**
 * \page userinterfaces User Interfaces
 *
 *  MoleCuilder has four interfaces at your disposal:
 *  -# \ref userinterfaces-textmenu  A simple interactive console-based menu,
 *    where awaits your choices and inputs in order to set atoms
 *               as you like
 *  -# \ref userinterfaces-commandline Every command can also be chained up as
 *    a sequence of actions on the command line to be executed
 *               with any user interaction.
 *  -# \ref userinterfaces-graphical A graphical user interface that also
 *    display the molecular structure being built and lots of other
 *               informations to ease the construction of bigger geometries.
 *  -# \ref userinterfaces-python Molecuilder's functionality is available as a
 *    python module to be used in python scripts
 *
 *  Note that all user interfaces are created via a common way that is
 *  controlled via the Action's \b .def files. Therein menu position, name
 *  and so forth are given. Hence, the same menus are created for both the
 *  text and the graphical user interface.
 *
 *  \section userinterfaces-query Making queries to the user
 *
 *  The passing of values from the user to the code is done via a \ref Dialog
 *  class that contains a number of \ref Query instances.
 *  Both Dialog and Query have to be implemented for each of the interfaces
 *  for each of the required types.
 *
 *  See \ref Query to understand how a value from the user actually happens to
 *  end up in the \ref ValueStorage for \ref Action's to find it.
 *
 *  \section userinterfaces-menu Menu structure
 *
 *  \sa Menu for information on how the menu structure is done.
 *
 *
 * \date 2012-03-16
 *
 */