EmbeddedObjects.lyx, Math.lyx, UserGuide.lyx: Spanish translation updates by Ignacio

[lyx.git] / src / BiblioInfo.h

diff --git a/src/BiblioInfo.h b/src/BiblioInfo.h
index 12e5754436925371ec653d76cef9e1407755f682..0baa06c5c2d97b57d7e5122a081282ac1d54d63b 100644 (file)
--- a/src/BiblioInfo.h
+++ b/src/BiblioInfo.h
@@ -32,17 +32,19 @@ class Buffer;
 std::vector<CiteStyle> citeStyles(CiteEngine);
 /// \param latex_str a LaTeX command, "cite", "Citep*", etc
 CitationStyle citationStyleFromString(std::string const & latex_str);
-/// the other way rounf
+/// the other way round
 std::string citationStyleToString(CitationStyle const &);
 
 
 /// Class to represent information about a BibTeX or
 /// bibliography entry.
-/// The keys are BibTeX fields (e.g., author, title, etc), 
-/// and the values are the associated field values.
+/// This class basically wraps a std::map, and many of its
+/// methods simply delegate to the corresponding methods of
+/// std::map.
 class BibTeXInfo {
 public:
-       ///
+       /// The keys are BibTeX fields (e.g., author, title, etc), 
+       /// and the values are the associated field values.
        typedef std::map<docstring, docstring>::const_iterator const_iterator;
        ///
        BibTeXInfo() : is_bibtex_(true) {}
@@ -51,19 +53,13 @@ public:
        BibTeXInfo(bool ib) : is_bibtex_(ib) {}
        /// constructor that sets the entryType
        BibTeXInfo(docstring const & key, docstring const & type);
-       /// Search for the given field and return the associated info.
-       /// The point of this is that BibTeXInfo::operator[] has no const
-       /// form.
-       docstring const & getValueForField(docstring const & field) const;
-       ///
-       docstring const & getValueForField(std::string const & field) const;
        ///
        bool hasField(docstring const & field) const;
-       /// return the short form of an authorlist
+       /// \return the short form of an authorlist
        docstring const getAbbreviatedAuthor() const;
        /// 
        docstring const getYear() const;
-       /// Returns formatted BibTeX data suitable for framing.
+       /// \return formatted BibTeX data suitable for framing.
        docstring const getInfo() const;
        ///
        int count(docstring const & f) const { return bimap_.count(f); }
@@ -71,9 +67,16 @@ public:
        const_iterator find(docstring const & f) const { return bimap_.find(f); }
        ///
        const_iterator end() const { return bimap_.end(); }
-       ///
+       /// \return value for field f
+       /// note that this will create an empty field if it does not exist
        docstring & operator[](docstring const & f) 
                { return bimap_[f]; }
+       /// \return value for field f
+       /// this one, since it is const, will simply return docstring() if
+       /// we don't have the field and will NOT create an empty field
+       docstring const & operator[](docstring const & field) const;
+       ///
+       docstring const & operator[](std::string const & field) const;
        ///
        docstring const & allData() const { return all_data_; }
        ///
@@ -100,20 +103,19 @@ class BiblioInfo {
 public:
        /// bibliography key --> data for that key
        typedef std::map<docstring, BibTeXInfo>::const_iterator const_iterator;
-       /// Returns a sorted vector of bibliography keys
+       /// \return a sorted vector of bibliography keys
        std::vector<docstring> const getKeys() const;
-       /// Returns a sorted vector of present BibTeX fields
+       /// \return a sorted vector of present BibTeX fields
        std::vector<docstring> const getFields() const;
-       /// Returns a sorted vector of BibTeX entry types in use
+       /// \return a sorted vector of BibTeX entry types in use
        std::vector<docstring> const getEntries() const;
-       /// return the short form of an authorlist
+       /// \return the short form of an authorlist
        docstring const getAbbreviatedAuthor(docstring const & key) const;
-       /// return the year from the bibtex data record
+       /// \return the year from the bibtex data record
        docstring const getYear(docstring const & key) const;
-       /// Returns formatted BibTeX data associated with a given key.
+       /// \return formatted BibTeX data associated with a given key.
        /// Empty if no info exists. 
        docstring const getInfo(docstring const & key) const;
-       
        /**
          * "Translates" the available Citation Styles into strings for a given key,
          * either numerical or author-year depending upon the active engine. (See