The Gnome Chemistry Utils  0.15.1
reaction-arrow.h
Go to the documentation of this file.
1 // -*- C++ -*-
2 
3 /*
4  * GChemPaint library
5  * reaction-arrow.h
6  *
7  * Copyright (C) 2004-2014 Jean Bréfort <jean.brefort@normalesup.org>
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License as
11  * published by the Free Software Foundation; either version 3 of the
12  * License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
22  * USA
23  */
24 
25 #ifndef GCHEMPAINT_REACTION_ARROW_H
26 #define GCHEMPAINT_REACTION_ARROW_H
27 
30 #include "arrow.h"
31 #include <gcu/dialog-owner.h>
32 #include <list>
33 
34 namespace gcu {
35 class UIManager;
36 }
37 
38 namespace gcp {
39 
40 typedef enum {
41  NumberingSchemeArabic,
42  NumberingSchemeRoman,
43  NumberingSchemeRomanLow
44 } NumberingScheme;
45 
46 class ReactionStep;
47 class Reaction;
48 class ReactionProp;
49 
50 class ReactionArrowStep; //private class
51 
54 class ReactionArrow: public Arrow, public gcu::DialogOwner
55 {
56 friend class ReactionArrowPrivate;
57 public:
60  ReactionArrow (Reaction* react, unsigned Type = SimpleArrow);
64  virtual ~ReactionArrow ();
65 
72  xmlNodePtr Save (xmlDocPtr xml) const;
79  bool Load (xmlNodePtr node);
83  void AddItem ();
87  void UpdateItem ();
97  bool BuildContextualMenu (gcu::UIManager *UIManager, gcu::Object *object, double x, double y);
106  void Move (double x, double y, double z = 0);
115  void SetCoords (double xstart, double ystart, double xend, double yend);
123  void SetSelected (int state);
129  void AddProp (gcu::Object *object);
134  void PositionChildren ();
145  bool OnSignal (gcu::SignalId Signal, gcu::Object *Child);
155  bool SetProperty (unsigned property, char const *value);
156 
160  std::string Name ();
161 
166  char GetSymbolicPosition (double x, double y);
171  void OnLoaded ();
172 
173  unsigned GetLastStep () const;
174  unsigned GetLastLine (unsigned step) const;
175  unsigned GetLastPos (unsigned step, unsigned line) const;
176  void SetChildPos (ReactionProp *prop, unsigned step, unsigned line, unsigned rank);
177  void RemoveProp (ReactionProp *prop);
178 
179 private:
180  unsigned m_Type;
181  bool m_TypeChanged;
182  std::list < ReactionArrowStep * > m_Steps;
183  unsigned m_nSteps;
184 
185 GCU_PROP (unsigned, MaxLinesAbove)
186 GCU_PROP (NumberingScheme, NumberingScheme);
187 };
188 
189 } // namespace gcp
190 
191 #endif // GCHEMPAINT_REACTION_ARROW_H
virtual ~ReactionArrow()
xmlNodePtr Save(xmlDocPtr xml) const
void AddProp(gcu::Object *object)
base class for a user interface manager
Definition: ui-manager.h:33
Chemical reaction class.
Definition: reaction.h:47
std::string Name()
bool BuildContextualMenu(gcu::UIManager *UIManager, gcu::Object *object, double x, double y)
bool Load(xmlNodePtr node)
bool SetProperty(unsigned property, char const *value)
unsigned SignalId
Definition: object.h:151
void SetSelected(int state)
void SetCoords(double xstart, double ystart, double xend, double yend)
char GetSymbolicPosition(double x, double y)
#define GCU_PROP(type, member)
Definition: macros.h:51
bool OnSignal(gcu::SignalId Signal, gcu::Object *Child)
void Move(double x, double y, double z=0)