8 #include <all_include.h>
9 #include <mapstorage.h>
10 #include <mapselector.h>
11 #include <libgnomecanvasmm.h>
12 #include <libgnomecanvasmm/polygon.h>
14 ///Ancestor class of algorithm graphical interface classes.
16 ///It also demonstrates, how should an algorithm graphical interface
17 ///work. Children of this class have the same functions and attributes,
18 ///therefore with all of them can the holder \ref AlgoWin communicate
21 ///IMPORTANT! In a child class only the following tasks are to do:
23 ///-call \ref init function with correct parameters from correctly parametrized constructor
25 ///-implement \ref build_box function
27 ///-implement \ref run function
29 ///because all other thing is automatically done in \ref init function!
31 class AlgoBox : public Gtk::VBox
33 ///Signal emitted in case of need for list of maps.
35 ///If the user has selected different tab to work on
36 ///new maps are selected as well. These new maps should be
37 ///provided for \ref AlgoBox. To get these maps, \ref AlgoBox
39 sigc::signal<void, std::string> signal_maplist_need;
41 ///Signal emitted in case of need for \ref NewMapWin.
43 ///If user wants to create a new for an input, or output
44 ///it can let \ref NewMapWin popped up from here as well.
45 ///In that case will be this signal emitted.
46 sigc::signal<void, std::string, bool> signal_newmapwin_need;
48 ///Signal emitted when maplists are updated after tab change
49 sigc::signal<void> signal_maplist_updated;
53 ///Holder of tabnames.
54 Gtk::ComboBoxText tabcbt;
56 ///Holder of widgets, in which nodemaps can be selected to work on.
57 std::vector<MapSelector *> nodemapcbts;
59 ///Holder of widgets, in which edgemaps can be selected to work on.
60 std::vector<MapSelector *> edgemapcbts;
62 ///Maps of selected tabs.
63 MapStorage * mapstorage;
66 ///Empty constructor called by children.
71 ///Calls \ref init function
72 ///with the provided parameters. \ref init function
73 ///is needed, because it is virtual, therefore the
74 ///functions of the proper class will be called when
76 ///\param tablist list of tabs in \ref MainWin
77 AlgoBox(std::vector<std::string> tablist);
79 ///Initiates \ref AlgoBox.
81 ///Creates the graphical interface for the realized algorithm, initiates variables, connects signals.
83 ///List of tabs in \ref MainWin is required, but no one
84 ///will be selected automatically. Every other
85 ///entry field remains empty (unselected), until a \ref NoteBookTab
88 ///It also have to bind all the signals to the correct place.
89 ///This function is virtual, in all type of children of
90 ///\ref AlgoBox the correct function willbe called.
92 ///Therefore it is IMPORTANT that only \ref run and \ref build_box
93 ///has to be implemented in children of \ref AlgoBox, every other
94 ///thing will automatically work properly by the help of this
95 ///function that must be called in constructor of child!!!
96 virtual void init(std::vector<std::string>);
98 ///Signal emitted, when selected tab changes, and new list of maps required.
99 sigc::signal<void, std::string> signal_maplist_needed();
101 ///Emitted if user wants to create a new map for inpuit or output.
102 sigc::signal<void, std::string, bool> signal_newmapwin_needed(){return signal_newmapwin_need;};
104 sigc::signal<void> signal_upon_maplist_updated(){return signal_maplist_updated;};
106 ///Emits signal that requires list of maps for the recently selected \ref NoteBookTab.
107 void emit_tab_change();
109 ///Interface, through which \ref AlgoBox can be notified about tab addition, deletion in \ref MainWin
113 void update_tablist( std::vector< std::string > tl );
115 ///Interface, through which \ref AlgoBox can get the maps of the recently selected \ref NoteBookTab
117 ///\param ms the maps
118 ///of the recently selected \ref NoteBookTab
119 void update_maplist( MapStorage * ms);
121 ///Interface, through which \ref AlgoBox can be notified about nodemap addition.
123 ///If new map was added to \ref MapStorage of currently selected \ref NoteBookTab
124 ///a signal is emitted by it. This signal is connected to this function, so \ref MapSelector s
125 ///in \ref nodemapcbts can be notified, and those can registrate the new map. (\ref MapSelector::append_text)
126 void nodemaplist_changed(std::string);
128 ///Interface, through which \ref AlgoBox can be notified about edgemap addition.
130 ///If new map was added to \ref MapStorage of currently selected \ref NoteBookTab
131 ///a signal is emitted by it. This signal is connected to this function, so \ref MapSelector s
132 ///in \ref edgemapcbts can be notified, and those can registrate the new map. (\ref MapSelector::append_text)
133 void edgemaplist_changed(std::string);
135 ///Aid function to provide data for a given entry.
137 ///At the moment it is only used for updating info
138 ///in \ref tabcbt. It clears it first, after that
139 ///inserts the data got from caller, and if there
140 ///was previously selected item it switches entry
142 ///\param tl list of entries (at the moment tabs in \ref MainWin)
143 ///\param cbt the entry to update (at the moment only \ref tabcbt)
144 void update_cbt( std::vector< std::string > tl, Gtk::ComboBoxText & cbt);
146 ///Runs the ralized algorithm.
148 ///Prepare the data for it
149 ///and after that postprocess it if necessary.
150 ///This is only a demo here, but in children it
151 ///runs the algorithm really.
154 ///Creates the layout of the \ref AlgoBox
156 ///Place all the entries
157 ///required. Run and close button is not
158 ///its responsibility!
159 virtual void build_box();
161 ///Emits \ref signal_newmapwin_need if user wants to create new input or output map.
163 ///Called in case of pressing \ref MapSelector::newbut.
164 ///\param itisedge edge or nodemap is required.
165 virtual void emit_new_map_signal(bool itisedge);
167 ///Aid function to make addition of \ref MapSelector easy in \ref build_box.
169 ///\param label label to show in \ref MapSelector
170 ///\param itisedge whether edge or nodemaps stored in \ref MapSelector
171 void addMapSelector(std::string label, bool itisedge);