COIN-OR::LEMON - Graph Library

Changeset 1893:4a35c7847c77 in lemon-0.x for gui


Ignore:
Timestamp:
01/12/06 16:24:24 (14 years ago)
Author:
Hegyi Péter
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2468
Message:

Documenatation of MapWin?.

Location:
gui
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • gui/map_win.cc

    r1891 r1893  
    6363}
    6464
    65 MapWin::~MapWin()
    66 {
    67 }
    68 
    6965void MapWin::nodeMapChanged(std::string mapname, int prop)
    7066{
  • gui/map_win.h

    r1891 r1893  
    1212#include <libgnomecanvasmm/polygon.h>
    1313
     14///Graph visualization setup window.
     15
    1416///This class is responsible for creating a window,
    1517///on which the visualization attributes can be
     
    1820{
    1921protected:
     22  ///\ref NoteBookTab to that the \ref MapWin belongs to.
    2023  NoteBookTab & mytab;
    2124
     25  ///Designing element
    2226  Gtk::Table * table;
    2327 
    24   MapSelector ** e_combo_array, ** n_combo_array;
     28  ///\ref MapSelectors for each property
    2529
     30  ///Each property has an own \ref MapSelector through which
     31  ///the map to visualize by the property van be set.
     32  MapSelector ** e_combo_array;
     33
     34  ///\ref MapSelectors for each property
     35
     36  ///Each property has an own \ref MapSelector through which
     37  ///the map to visualize by the property van be set.
     38  MapSelector ** n_combo_array;
     39
     40  ///Information holder
    2641  Gtk::Label * label;
    2742
     43  ///Container in which elements are organized.
    2844  Gtk::VBox vbox;
    2945
    3046public:
    31   ///Constructor of MapWin creates the widgets shown in MapWin.
    32   MapWin(const std::string& title, std::vector<std::string>, std::vector<std::string>, NoteBookTab & mw);
     47  ///Constructor
    3348
    34   ~MapWin();
     49  ///It creates the widgets shown in \ref MapWin and
     50  ///binds the needed signal to the correct place.
     51  ///\param title title of window
     52  ///\param eml edgemap list
     53  ///\param nml nodemap list
     54  ///\param mw the owner \ref NoteBookTab (\ref mytab)
     55  MapWin(const std::string& title, std::vector<std::string> eml, std::vector<std::string> nml, NoteBookTab & mw);
    3556
     57  ///Deregistrates \ref MapWin in its \ref NoteBookTab (\ref mytab)
    3658  virtual bool on_delete_event(GdkEventAny *);
    3759
    38   void nodeMapChanged(std::string, int);
     60  ///Handles changement in nodemap selection
    3961
    40   void edgeMapChanged(std::string, int);
     62  ///If \ref MapSelector emits a signal that indicates
     63  ///changement in nodemap selection this function will
     64  ///be called. It calls the appropriate handler function,
     65  ///\ref NoteBookTab::propertyChange with parameters describing the changement.
     66  ///\param mapname the recently selected map
     67  ///\param prop the changed property
     68  void nodeMapChanged(std::string mapname, int prop);
    4169
    42   void newMapWinNeeded(bool);
     70  ///Handles changement in edgemap selection
    4371
    44   ///This function inserts name of the new edgemap in the list in the combo box
    45   void registerNewEdgeMap(std::string);
     72  ///If \ref MapSelector emits a signal that indicates
     73  ///changement in edgemap selection this function will
     74  ///be called. It calls the appropriate handler function,
     75  ///\ref NoteBookTab::propertyChange with parameters describing the changement.
     76  ///\param mapname the recently selected map
     77  ///\param prop the changed property
     78  void edgeMapChanged(std::string mapname, int prop);
    4679
    47   ///This function inserts name of the new nodemap in the list in the combo box
    48   void registerNewNodeMap(std::string);
     80  ///Indicates to the owner \ref NoteBookTab that a \ref NewMapWin should be opened.
    4981
     82  ///This function is bound to the
     83  ///signal emitted by the \ref MapSelector in case of
     84  ///the user wants to create a new map. It only pass the
     85  ///information further to the tab owning this \ref MapWin that is needed to open the
     86  ///\ref NewMapWin. (\ref NoteBookTab::popupNewMapWin)
     87  ///\param itisedge should the new map will be an edgemap? (or nodemap)
     88  void newMapWinNeeded(bool itisedge);
     89
     90  ///This function inserts name of the new edgemap in the name list in \ref MapSelector s
     91
     92  ///\param new_name
     93  ///name of new map
     94  void registerNewEdgeMap(std::string new_name);
     95
     96  ///This function inserts name of the new nodemap in the name list in \ref MapSelector s
     97
     98  ///\param new_name
     99  ///name of new map
     100  void registerNewNodeMap(std::string new_name);
     101
     102  ///Close window if Esc key pressed.
    50103  virtual bool closeIfEscapeIsPressed(GdkEventKey*);
    51104
    52   void update(std::vector<std::string>, std::vector<std::string>);
     105  ///Updates list of maps in all \ref MapSelector
     106
     107  ///This function is called by \ref NoteBookTab, when the file
     108  ///showed in it has changed, therefore the contained maps
     109  ///have changed as well. \ref NoteBookTab knows, whether it
     110  ///has to call this function or not from the \ref NoteBookTab::mapwinexists
     111  ///variable.
     112  ///\param eml edge map list
     113  ///\param nml node map list
     114  void update(std::vector<std::string> eml, std::vector<std::string> nml);
    53115};
    54116
  • gui/mapselector.h

    r1892 r1893  
    9494  MapSelector(std::vector<std::string> optionlist, std::string act, std::string purpose, bool itisedge, bool def=true);
    9595
    96   ///Signal emitted if the user has changed the selection.
     96  ///Returns signal emitted if the user has changed the selection. (\ref signal_cbt)
    9797  sigc::signal<void, std::string> signal_cbt_ch();
    9898
    99   ///Signal emitted if the user has pressed New button (\ref newbut)
     99  ///Returns signal emitted if the user has pressed New button (\ref newbut) (\ref signal_newmapwin)
    100100  sigc::signal<void, bool> signal_newmapwin_needed();
    101101
Note: See TracChangeset for help on using the changeset viewer.