The Gnome Chemistry Utils 0.13.3
|
#include <gcp/document.h>
Public Member Functions | |
Document (Application *App, bool StandAlone, Window *window=NULL) | |
virtual | ~Document () |
void | Clear () |
GtkWidget * | GetWidget () |
View * | GetView () |
void | Save () const |
virtual bool | Load (xmlNodePtr node) |
const gchar * | GetTitle () const |
void | SetTitle (const gchar *title) |
void | SetLabel (const gchar *label) |
const gchar * | GetLabel () const |
void | SetFileName (std::string const &filename, const gchar *mime_type) |
const gchar * | GetFileName () const |
void | DoPrint (GtkPrintOperation *print, GtkPrintContext *context, int page) const |
void | AddObject (Object *pObject) |
void | AddAtom (Atom *pAtom) |
void | AddFragment (Fragment *pFragment) |
void | AddBond (Bond *pBond) |
void | ParseXMLTree (xmlDocPtr xml) |
void | LoadObjects (xmlNodePtr node) |
xmlDocPtr | BuildXMLTree () const |
void | Update () |
void | Remove (Object *object) |
void | Remove (const char *Id) |
void | OnProperties () |
void | OnUndo () |
void | OnRedo () |
const GDate * | GetCreationDate () |
const GDate * | GetRevisionDate () |
const gchar * | GetAuthor () |
const gchar * | GetMail () |
const gchar * | GetComment () |
void | SetAuthor (const gchar *author) |
void | SetMail (const gchar *mail) |
void | SetComment (const gchar *comment) |
void | FinishOperation () |
void | AbortOperation () |
void | PopOperation () |
void | PushOperation (Operation *operation, bool undo=true) |
void | SetActive () |
Operation * | GetNewOperation (OperationType type) |
Operation * | GetCurrentOperation () |
void | PasteData (xmlNodePtr node) |
bool | CanUndo () |
void | SetEditable (bool editable) |
bool | GetEditable () |
gcp::Application * | GetApplication () |
void | ExportImage (std::string const &filename, const char *type, int resolution=-1) |
void | SetReadOnly (bool ro) |
bool | GetReadOnly () |
virtual double | GetYAlign () |
Window * | GetWindow () |
GtkWindow * | GetGtkWindow () |
void | SetTheme (Theme *theme) |
bool | OnSignal (gcu::SignalId Signal, gcu::Object *Child) |
void | SetDirty (bool isDirty=true) |
void | OnThemeNamesChanged () |
double | GetMedianBondLength () |
bool | SetProperty (unsigned property, char const *value) |
std::string | GetProperty (unsigned property) const |
void | SetLoading (bool loading) |
void | SaveResidue (Residue const *r, xmlNodePtr node) |
gcu::Residue const * | GetResidue (char const *symbol, bool *ambiguous=NULL) |
gcu::Residue * | CreateResidue (char const *name, char const *symbol, gcu::Molecule *molecule) |
Theme * | GetTheme (void) const |
void | SetBondLength (double val) |
double | GetBondLength (void) const |
double & | GetRefBondLength (void) |
void | SetBondAngle (double val) |
double | GetBondAngle (void) const |
double & | GetRefBondAngle (void) |
void | SetArrowLength (double val) |
double | GetArrowLength (void) const |
double & | GetRefArrowLength (void) |
void | SetTextFontFamily (gchar *val) |
gchar * | GetTextFontFamily (void) const |
gchar *& | GetRefTextFontFamily (void) |
void | SetTextFontStyle (PangoStyle val) |
PangoStyle | GetTextFontStyle (void) const |
PangoStyle & | GetRefTextFontStyle (void) |
void | SetTextFontWeight (PangoWeight val) |
PangoWeight | GetTextFontWeight (void) const |
PangoWeight & | GetRefTextFontWeight (void) |
void | SetTextFontVariant (PangoVariant val) |
PangoVariant | GetTextFontVariant (void) const |
PangoVariant & | GetRefTextFontVariant (void) |
void | SetTextFontStretch (PangoStretch val) |
PangoStretch | GetTextFontStretch (void) const |
PangoStretch & | GetRefTextFontStretch (void) |
void | SetTextFontSize (gint val) |
gint | GetTextFontSize (void) const |
gint & | GetRefTextFontSize (void) |
PangoAttrList * | GetPangoAttrList (void) const |
void | SetAllowClipboard (bool val) |
bool | GetAllowClipboard (void) const |
bool & | GetRefAllowClipboard (void) |
unsigned | GetSoftwareVersion (void) const |
void | SetBracketsFontFamily (std::string val) |
std::string | GetBracketsFontFamily (void) const |
std::string & | GetRefBracketsFontFamily (void) |
void | SetBracketsFontSize (int val) |
int | GetBracketsFontSize (void) const |
int & | GetRefBracketsFontSize (void) |
The document class for GChemPaint.
Definition at line 78 of file gcp/document.h.
gcp::Document::Document | ( | Application * | App, |
bool | StandAlone, | ||
Window * | window = NULL |
||
) |
App | the application. |
StandAlone | whether the document is opened in its own window or embedded in something else. |
window | the document window if it has already been created or NULL. |
Constructs a new empty document using default theme.
virtual gcp::Document::~Document | ( | ) | [virtual] |
The destructor.
Reimplemented from gcu::Document.
void gcp::Document::AbortOperation | ( | ) |
Aborts and deletyes the current operation.
void gcp::Document::AddAtom | ( | Atom * | pAtom | ) |
pAtom | a new atom. |
Adds a new atom to the document.
void gcp::Document::AddBond | ( | Bond * | pBond | ) |
pBond | a new bond. |
Adds a new bond to the document and checks the connectivity of the new covalent structure.
void gcp::Document::AddFragment | ( | Fragment * | pFragment | ) |
pFragment | a new atoms group. |
Adds a new fragment to the document.
void gcp::Document::AddObject | ( | Object * | pObject | ) |
pObject | a new object. |
Adds a new object to the document.
xmlDocPtr gcp::Document::BuildXMLTree | ( | ) | const |
Builds the XML tree representing the document. The returned value must be freed using xmlFree.
bool gcp::Document::CanUndo | ( | ) | [inline] |
Definition at line 314 of file gcp/document.h.
void gcp::Document::Clear | ( | ) | [virtual] |
Empties a document and reinitialize it.
Reimplemented from gcu::Object.
gcu::Residue* gcp::Document::CreateResidue | ( | char const * | name, |
char const * | symbol, | ||
gcu::Molecule * | molecule | ||
) | [virtual] |
name | the name of the new residue. |
symbol | the symbol of the new residue. |
molecule | a molecule with a pseudo atom which describes the structure of the residue. |
Reimplemented from gcu::Document.
void gcp::Document::DoPrint | ( | GtkPrintOperation * | print, |
GtkPrintContext * | context, | ||
int | page | ||
) | const |
a GtkPrintOperation. | |
context | a GtkPrintContext. |
page | the page to print. |
Prints the document.
void gcp::Document::ExportImage | ( | std::string const & | filename, |
const char * | type, | ||
int | resolution = -1 |
||
) |
filename | the image filename. |
type | a string representing the image type like "png", "svg", or "eps". |
resolution | the resolution to use in the image for bitmaps or −1. |
Exports the current document as an image. The image is limited to the real bounds of the document. For bitmaps, the size is evaluated using the perceived screen resolution. If the default resolution (−1) is used, the resoution will be the screen resolution.
void gcp::Document::FinishOperation | ( | ) |
Ends the current operation and pushes it on top of the undo stack. This method must be called after all changes have been done in the document and the changes described in the operation.
gcp::Document::GetAllowClipboard | ( | void | ) | const [inline] |
Definition at line 613 of file gcp/document.h.
gcp::Application* gcp::Document::GetApplication | ( | ) | [inline] |
Definition at line 328 of file gcp/document.h.
gcp::Document::GetArrowLength | ( | void | ) | const [inline] |
Definition at line 525 of file gcp/document.h.
const gchar* gcp::Document::GetAuthor | ( | ) | [inline] |
Definition at line 241 of file gcp/document.h.
gcp::Document::GetBondAngle | ( | void | ) | const [inline] |
Definition at line 513 of file gcp/document.h.
gcp::Document::GetBondLength | ( | void | ) | const [inline] |
Definition at line 498 of file gcp/document.h.
gcp::Document::GetBracketsFontFamily | ( | void | ) | const [inline] |
Definition at line 634 of file gcp/document.h.
gcp::Document::GetBracketsFontSize | ( | void | ) | const [inline] |
Definition at line 646 of file gcp/document.h.
const gchar* gcp::Document::GetComment | ( | ) | [inline] |
Definition at line 249 of file gcp/document.h.
const GDate* gcp::Document::GetCreationDate | ( | ) | [inline] |
Definition at line 233 of file gcp/document.h.
Operation* gcp::Document::GetCurrentOperation | ( | ) | [inline] |
Definition at line 303 of file gcp/document.h.
bool gcp::Document::GetEditable | ( | ) | [inline] |
Definition at line 324 of file gcp/document.h.
const gchar* gcp::Document::GetFileName | ( | ) | const [inline] |
Definition at line 151 of file gcp/document.h.
GtkWindow* gcp::Document::GetGtkWindow | ( | ) | [virtual] |
Reimplemented from gcu::Document.
const gchar* gcp::Document::GetLabel | ( | ) | const |
const gchar* gcp::Document::GetMail | ( | ) | [inline] |
Definition at line 245 of file gcp/document.h.
double gcp::Document::GetMedianBondLength | ( | ) |
Operation* gcp::Document::GetNewOperation | ( | OperationType | type | ) |
type | the type of the new undo/redo operation. |
gcp::Document::GetPangoAttrList | ( | void | ) | const [inline] |
Definition at line 601 of file gcp/document.h.
std::string gcp::Document::GetProperty | ( | unsigned | property | ) | const [virtual] |
property | the property id as defined in objprops.h |
Used when saving to get properties from document.. Supported properties for documents are: GCU_PROP_DOC_FILENAME, GCU_PROP_DOC_MIMETYPE, GCU_PROP_DOC_TITLE, GCU_PROP_DOC_COMMENT, GCU_PROP_DOC_CREATOR, GCU_PROP_DOC_CREATION_TIME, GCU_PROP_DOC_MODIFICATION_TIME, and GCU_PROP_THEME_BOND_LENGTH.
Reimplemented from gcu::Object.
bool gcp::Document::GetReadOnly | ( | ) | [inline] |
Definition at line 348 of file gcp/document.h.
gcp::Document::GetRefAllowClipboard | ( | void | ) | [inline] |
Definition at line 613 of file gcp/document.h.
gcp::Document::GetRefArrowLength | ( | void | ) | [inline] |
Definition at line 525 of file gcp/document.h.
gcp::Document::GetRefBondAngle | ( | void | ) | [inline] |
Definition at line 513 of file gcp/document.h.
gcp::Document::GetRefBondLength | ( | void | ) | [inline] |
Definition at line 498 of file gcp/document.h.
gcp::Document::GetRefBracketsFontFamily | ( | void | ) | [inline] |
Definition at line 634 of file gcp/document.h.
gcp::Document::GetRefBracketsFontSize | ( | void | ) | [inline] |
Definition at line 646 of file gcp/document.h.
gcp::Document::GetRefTextFontFamily | ( | void | ) | [inline] |
Definition at line 537 of file gcp/document.h.
gcp::Document::GetRefTextFontSize | ( | void | ) | [inline] |
Definition at line 597 of file gcp/document.h.
gcp::Document::GetRefTextFontStretch | ( | void | ) | [inline] |
Definition at line 585 of file gcp/document.h.
gcp::Document::GetRefTextFontStyle | ( | void | ) | [inline] |
Definition at line 549 of file gcp/document.h.
gcp::Document::GetRefTextFontVariant | ( | void | ) | [inline] |
Definition at line 573 of file gcp/document.h.
gcp::Document::GetRefTextFontWeight | ( | void | ) | [inline] |
Definition at line 561 of file gcp/document.h.
gcu::Residue const* gcp::Document::GetResidue | ( | char const * | symbol, |
bool * | ambiguous = NULL |
||
) | [virtual] |
symbol | the symbol for which a Residue* is searched. |
ambiguous | where to store the boolean telling if the symbol is ambiguous or NULL. |
Documents might own not global residues with the samesymbol or name but a different meaning from the standard residue.
Reimplemented from gcu::Document.
const GDate* gcp::Document::GetRevisionDate | ( | ) | [inline] |
Definition at line 237 of file gcp/document.h.
gcp::Document::GetSoftwareVersion | ( | void | ) | const [inline] |
Retrieves the GChemPaint API number corresponding to the program which saved the file last time. Might be 0 if the file has never been saved, or if the file was not saved using GChemPaint. The version is an unsigned decimal number of the type MMMmmmµµµ, where MMM is the major version, mmm the minor version and µµµ the micro version. This is used to detect files with old syntax on loading.
Definition at line 622 of file gcp/document.h.
gcp::Document::GetTextFontFamily | ( | void | ) | const [inline] |
Definition at line 537 of file gcp/document.h.
gcp::Document::GetTextFontSize | ( | void | ) | const [inline] |
Definition at line 597 of file gcp/document.h.
gcp::Document::GetTextFontStretch | ( | void | ) | const [inline] |
Definition at line 585 of file gcp/document.h.
gcp::Document::GetTextFontStyle | ( | void | ) | const [inline] |
Definition at line 549 of file gcp/document.h.
gcp::Document::GetTextFontVariant | ( | void | ) | const [inline] |
Definition at line 573 of file gcp/document.h.
gcp::Document::GetTextFontWeight | ( | void | ) | const [inline] |
Definition at line 561 of file gcp/document.h.
gcp::Document::GetTheme | ( | void | ) | const [inline] |
Definition at line 486 of file gcp/document.h.
const gchar* gcp::Document::GetTitle | ( | ) | const |
View* gcp::Document::GetView | ( | void | ) | [inline] |
Definition at line 109 of file gcp/document.h.
GtkWidget* gcp::Document::GetWidget | ( | ) |
Window* gcp::Document::GetWindow | ( | void | ) | [inline] |
Definition at line 359 of file gcp/document.h.
virtual double gcp::Document::GetYAlign | ( | ) | [virtual] |
Used to retrieve the y coordinate for alignment. If the documetn contains just one objecst as a molecule or a reaction, it will reurn it's alignment value, otherwise 0 is returned.
Reimplemented from gcu::Object.
virtual bool gcp::Document::Load | ( | xmlNodePtr | node | ) | [virtual] |
node | the XML root node for the document. |
Loads the document from the XML tree representing it.
Reimplemented from gcu::Object.
void gcp::Document::LoadObjects | ( | xmlNodePtr | node | ) |
node | the XML node representing objects to add to the document. |
void gcp::Document::OnProperties | ( | ) |
Called by the framework when the user fires the File/Properties command.
void gcp::Document::OnRedo | ( | ) |
Called by the framework when the user fires the Edit/Redo command.
bool gcp::Document::OnSignal | ( | gcu::SignalId | Signal, |
gcu::Object * | Child | ||
) | [virtual] |
Signal | a SignalId |
Child | the child which emitted the signal or NULL |
Called when a signal has been emitted by a child. Only OnThemeChangedSignal is relevant for documents.
Reimplemented from gcu::Object.
void gcp::Document::OnThemeNamesChanged | ( | ) |
Called by the framework when the theme names have changed, i.e. a new theme has ben added, or a theme has been removed or renamed.
void gcp::Document::OnUndo | ( | ) |
Called by the framework when the user fires the Edit/Undo command.
void gcp::Document::ParseXMLTree | ( | xmlDocPtr | xml | ) |
xml | the XML document representing the GChemPaint document being loaded. |
Parses the XML tree and creates all objects it represents.
void gcp::Document::PasteData | ( | xmlNodePtr | node | ) |
node | the XML node representing objects to add to the document. |
Adds previously serialized objects from the clipboard to the document. Links can be set only to or from pasted objects.
void gcp::Document::PopOperation | ( | ) |
Removes an operation from the udo stack and deletes it.
void gcp::Document::PushOperation | ( | Operation * | operation, |
bool | undo = true |
||
) |
operation | the operation to add. |
undo | whether to put he operation on the undo or the redo stack. |
Adds the current operation to the appropriate task.
void gcp::Document::Remove | ( | Object * | object | ) |
object | the object to remove. |
Removes a child object from the document, and deletes it.
void gcp::Document::Remove | ( | const char * | Id | ) |
Id | the Id of the object to be removed. |
Removes a child object from the document, and deletes it.
void gcp::Document::Save | ( | ) | const [virtual] |
Saves the current file.
Reimplemented from gcu::Document.
void gcp::Document::SaveResidue | ( | Residue const * | r, |
xmlNodePtr | node | ||
) |
r | the residue to be saved. |
node | the XML node to which add the saved residue if needed. |
GChemPaint saves the meaning of a residue the first time it is encountered, and maintains a list of saved residues to avoid duplicates.
void gcp::Document::SetActive | ( | ) |
Called by the framework when the document becomes the active one. Updates the menus according to the document state.
gcp::Document::SetAllowClipboard | ( | bool | val | ) | [inline] |
val | whether the document may use the clipboard or no. |
Sets the rights for the document clipbard access.
Definition at line 613 of file gcp/document.h.
gcp::Document::SetArrowLength | ( | double | val | ) | [inline] |
val | the new default arrow length. |
Sets the new default arrow length for the document.
Definition at line 525 of file gcp/document.h.
void gcp::Document::SetAuthor | ( | const gchar * | author | ) |
author | the new author name. |
Setes the document author name.
gcp::Document::SetBondAngle | ( | double | val | ) | [inline] |
val | the new default bond angle between two consecutive bonds in a chain. |
Sets the new default bond angle between two consecutive bonds in a chain for the document.
Definition at line 513 of file gcp/document.h.
gcp::Document::SetBondLength | ( | double | val | ) | [inline] |
val | the new default bond length. |
Sets the new default bond length for the document.
Definition at line 498 of file gcp/document.h.
gcp::Document::SetBracketsFontFamily | ( | std::string | val | ) | [inline] |
val | the new brackets font family. |
Sets the new current brackets font family for the document.
Definition at line 634 of file gcp/document.h.
gcp::Document::SetBracketsFontSize | ( | int | val | ) | [inline] |
val | the new brackets font size. |
Sets the new current text font size for the document.
Definition at line 646 of file gcp/document.h.
void gcp::Document::SetComment | ( | const gchar * | comment | ) |
comment | the new comment. |
Sets the comment associated with the document any.
void gcp::Document::SetDirty | ( | bool | isDirty = true | ) |
Mark the document as dirty. On any attempt to close a dirty document, a dialog box is opened to ask the user if he wants to save the modified document or drop the changes.
Reimplemented from gcu::Object.
void gcp::Document::SetEditable | ( | bool | editable | ) | [inline] |
editable | whether the document might be edited or not |
This method is used to lock a document and inhibit any change in it.
Definition at line 320 of file gcp/document.h.
void gcp::Document::SetFileName | ( | std::string const & | filename, |
const gchar * | mime_type | ||
) |
filename | the new file name (URI). |
mime_type | the new mime type. |
Sets the new file name and its associated mime type.
void gcp::Document::SetLabel | ( | const gchar * | label | ) |
label | the new window title. |
Sets the label to use as window title.
void gcp::Document::SetLoading | ( | bool | loading | ) | [inline] |
loading | whether the document is loading data or not. |
Used to inhibit undo/redo operation creation when loading.
Definition at line 423 of file gcp/document.h.
void gcp::Document::SetMail | ( | const gchar * | ) |
the new e-mail address. |
Sets the document author e-mail address.
bool gcp::Document::SetProperty | ( | unsigned | property, |
char const * | value | ||
) | [virtual] |
property | the property id as defined in objprops.h |
value | the property value as a string |
Used when loading to set properties. Supported properties for documents are: GCU_PROP_DOC_FILENAME, GCU_PROP_DOC_MIMETYPE, GCU_PROP_DOC_TITLE, GCU_PROP_DOC_COMMENT, GCU_PROP_DOC_CREATOR, GCU_PROP_DOC_CREATION_TIME, GCU_PROP_DOC_MODIFICATION_TIME, and GCU_PROP_THEME_BOND_LENGTH.
Reimplemented from gcu::Object.
void gcp::Document::SetReadOnly | ( | bool | ro | ) |
ro | whether the file is read-only or not. |
If ro is true, the File/Save menu item and corresponding button will be disabled.
gcp::Document::SetTextFontFamily | ( | gchar * | val | ) | [inline] |
val | the new text font family. |
Sets the new current text font family for the document.
Definition at line 537 of file gcp/document.h.
gcp::Document::SetTextFontSize | ( | gint | val | ) | [inline] |
val | the new text font size. |
Sets the new current text font size for the document.
Definition at line 597 of file gcp/document.h.
gcp::Document::SetTextFontStretch | ( | PangoStretch | val | ) | [inline] |
val | the new text font stretch. |
Sets the new current text font stretch for the document.
Definition at line 585 of file gcp/document.h.
gcp::Document::SetTextFontStyle | ( | PangoStyle | val | ) | [inline] |
val | the new text font style. |
Sets the new current text font style for the document.
Definition at line 549 of file gcp/document.h.
gcp::Document::SetTextFontVariant | ( | PangoVariant | val | ) | [inline] |
val | the new text font variant. |
Sets the new current text font variant for the document.
Definition at line 573 of file gcp/document.h.
gcp::Document::SetTextFontWeight | ( | PangoWeight | val | ) | [inline] |
val | the new text font weight. |
Sets the new current text font weight for the document.
Definition at line 561 of file gcp/document.h.
void gcp::Document::SetTheme | ( | Theme * | theme | ) |
theme | the new theme for the document. |
Sets the theme to be used by the document. This will not change lengths of existing bonds or size of existing text.
void gcp::Document::SetTitle | ( | const gchar * | title | ) |
title | the new title. |
The document title.
void gcp::Document::Update | ( | ) |
Updates the view for all objects which have been marked as dirty.