source: molecuilder/src/UIElements/UIFactory.hpp@ 78b9d9

Last change on this file since 78b9d9 was 78b9d9, checked in by Tillmann Crueger <crueger@…>, 16 years ago

Improved Doxygen documentation

  • Property mode set to 100644
File size: 1.6 KB
RevLine 
[6d21bd]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
[3e8325]11class MainWindow;
[6d21bd]12class Dialog;
13
[d97af9]14class MoleculeListClass;
15class config;
16class periodentafel;
17
18struct menuPopulaters;
[78b9d9]19/**
20 * Abstract Factory to create any kind of User interface object needed by the programm.
21 *
22 * The factory can be created and has to be set to a certain type upon creation. It will then
23 * only create UIelements of that certain type, so that all UIElements match. This way different
24 * UIs can be handled in a concise abstract way.
25 */
[6d21bd]26class UIFactory
27{
28
29public:
[3e8325]30 enum InterfaceTypes {Text};
[6d21bd]31 virtual ~UIFactory();
32
[78b9d9]33 /**
34 * Produce some kind of main window, of whichever type was chosen when the factory was created
35 */
[d97af9]36 virtual MainWindow* makeMainWindow(menuPopulaters,MoleculeListClass *, config *, periodentafel *, char *)=0;
[78b9d9]37
38 /**
39 * Produce a User Interaction Dialog, that can query values from the User.
40 * Again the type is determined upon factory creation.
41 */
[6d21bd]42 virtual Dialog* makeDialog()=0;
43
44protected:
45 UIFactory();
46
47// singleton stuff
[3e8325]48private:
49 static UIFactory *theFactory;
50
[6d21bd]51public:
[78b9d9]52 /**
53 * create a Factory of a certain type. From that moment on only those UIElements can be produced by the factory
54 */
[6d21bd]55 static void makeUserInterface(InterfaceTypes type);
[78b9d9]56
57 /**
58 * get the previously created factory
59 */
[6d21bd]60 static UIFactory* get();
[78b9d9]61
62 /**
63 * Destroy the created factory.
64 *
65 * Make sure that all UIElements that were created by the factory are destroyed before calling this method.
66 */
[3e8325]67 static void purgeInstance();
[6d21bd]68};
69
70#endif /* UIFACTORY_HPP_ */
Note: See TracBrowser for help on using the repository browser.