source: src/UIElements/UIFactory.hpp@ de8e45

Action_Thermostats Add_AtomRandomPerturbation Add_FitFragmentPartialChargesAction Add_RotateAroundBondAction Add_SelectAtomByNameAction Added_ParseSaveFragmentResults AddingActions_SaveParseParticleParameters Adding_Graph_to_ChangeBondActions Adding_MD_integration_tests Adding_ParticleName_to_Atom Adding_StructOpt_integration_tests AtomFragments Automaking_mpqc_open AutomationFragmentation_failures Candidate_v1.5.4 Candidate_v1.6.0 Candidate_v1.6.1 ChangeBugEmailaddress ChangingTestPorts ChemicalSpaceEvaluator CombiningParticlePotentialParsing Combining_Subpackages Debian_Package_split Debian_package_split_molecuildergui_only Disabling_MemDebug Docu_Python_wait EmpiricalPotential_contain_HomologyGraph EmpiricalPotential_contain_HomologyGraph_documentation Enable_parallel_make_install Enhance_userguide Enhanced_StructuralOptimization Enhanced_StructuralOptimization_continued Example_ManyWaysToTranslateAtom Exclude_Hydrogens_annealWithBondGraph FitPartialCharges_GlobalError Fix_BoundInBox_CenterInBox_MoleculeActions Fix_ChargeSampling_PBC Fix_ChronosMutex Fix_FitPartialCharges Fix_FitPotential_needs_atomicnumbers Fix_ForceAnnealing Fix_IndependentFragmentGrids Fix_ParseParticles Fix_ParseParticles_split_forward_backward_Actions Fix_PopActions Fix_QtFragmentList_sorted_selection Fix_Restrictedkeyset_FragmentMolecule Fix_StatusMsg Fix_StepWorldTime_single_argument Fix_Verbose_Codepatterns Fix_fitting_potentials Fixes ForceAnnealing_goodresults ForceAnnealing_oldresults ForceAnnealing_tocheck ForceAnnealing_with_BondGraph ForceAnnealing_with_BondGraph_continued ForceAnnealing_with_BondGraph_continued_betteresults ForceAnnealing_with_BondGraph_contraction-expansion FragmentAction_writes_AtomFragments FragmentMolecule_checks_bonddegrees GeometryObjects Gui_Fixes Gui_displays_atomic_force_velocity ImplicitCharges IndependentFragmentGrids IndependentFragmentGrids_IndividualZeroInstances IndependentFragmentGrids_IntegrationTest IndependentFragmentGrids_Sole_NN_Calculation JobMarket_RobustOnKillsSegFaults JobMarket_StableWorkerPool JobMarket_unresolvable_hostname_fix MoreRobust_FragmentAutomation ODR_violation_mpqc_open PartialCharges_OrthogonalSummation PdbParser_setsAtomName PythonUI_with_named_parameters QtGui_reactivate_TimeChanged_changes Recreated_GuiChecks Rewrite_FitPartialCharges RotateToPrincipalAxisSystem_UndoRedo SaturateAtoms_findBestMatching SaturateAtoms_singleDegree StoppableMakroAction Subpackage_CodePatterns Subpackage_JobMarket Subpackage_LinearAlgebra Subpackage_levmar Subpackage_mpqc_open Subpackage_vmg Switchable_LogView ThirdParty_MPQC_rebuilt_buildsystem TrajectoryDependenant_MaxOrder TremoloParser_IncreasedPrecision TremoloParser_MultipleTimesteps TremoloParser_setsAtomName Ubuntu_1604_changes stable
Last change on this file since de8e45 was de8e45, checked in by Frederik Heber <heber@…>, 15 years ago

Added explanation to various UIElements.

  • documentation in CommandLineParser.hpp on how to create new actions to appear by doxygen documentation.
  • explaination of UIFactory, Dialog and Query.

Signed-off-by: Frederik Heber <heber@…>

  • Property mode set to 100644
File size: 1.7 KB
Line 
1/*
2 * UIFactory.hpp
3 *
4 * Created on: Jan 5, 2010
5 * Author: crueger
6 */
7
8#ifndef UIFACTORY_HPP_
9#define UIFACTORY_HPP_
10
11class MainWindow;
12class Dialog;
13class DialogDescription;
14
15#include "Patterns/Singleton.hpp"
16
17/**
18 * Abstract Factory to create any kind of User interface object needed by the programm.
19 *
20 * The factory can be created and has to be set to a certain type upon creation. It will then
21 * only create UIelements of that certain type, so that all UIElements match. This way different
22 * UIs can be handled in a concise abstract way.
23 *
24 * The main functionality is the MainWindow and the Dialog.
25 *
26 * MainWindow basically is the framework if the UI. The MainWindow has a run function which is
27 * called MainWindow::Display(), which will listen for user input and react to it via actions for
28 * as long as the user desires or tells the MainWindow to quit.
29 *
30 * Within the MainWindow Dialog classes may be instantiated which ask the user for input to
31 * certain actions he wants to perform.
32 *
33 */
34class UIFactory : public Singleton<UIFactory,false>
35{
36
37public:
38 enum InterfaceTypes {Text, CommandLine};
39 virtual ~UIFactory();
40
41 /**
42 * Produce some kind of main window, of whichever type was chosen when the factory was created
43 */
44 virtual MainWindow* makeMainWindow()=0;
45
46 /**
47 * Produce a User Interaction Dialog, that can query values from the User.
48 * Again the type is determined upon factory creation.
49 */
50 virtual Dialog* makeDialog()=0;
51
52protected:
53 UIFactory();
54
55public:
56 /**
57 * create a Factory of a certain type. From that moment on only those UIElements can be produced by the factory
58 */
59 static void makeUserInterface(InterfaceTypes type);
60
61};
62
63#endif /* UIFACTORY_HPP_ */
Note: See TracBrowser for help on using the repository browser.