/* CharSymbol.java
 * =========================================================================
 * This file is part of the JMathTeX Library - http://jmathtex.sourceforge.net
 * 
 * Copyright (C) 2004-2007 Universiteit Gent
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 * 
 * A copy of the GNU General Public License can be found in the file
 * LICENSE.txt provided with the source distribution of this program (see
 * the META-INF directory in the source jar). This license can also be
 * found on the GNU website at http://www.gnu.org/licenses/gpl.html.
 * 
 * If you did not receive a copy of the GNU General Public License along
 * with this program, contact the lead developer, or write to the Free
 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 * 
 */

package be.ugent.caagt.jmathtex;

/**
 * An common superclass for atoms that represent one single character
 * and access the font information. 
 */
abstract class CharSymbol extends Atom {

   /**
    * Mrow will mark certain CharSymbol atoms as a text symbol.
    * Msubsup wil use this property for a certain spacing rule.
    */
   private boolean textSymbol = false;

   /**
    * Mark as text symbol (used by Dummy)
    */
   public void markAsTextSymbol() {
      textSymbol = true;
   }

   /**
    * Remove the mark so the atom remains unchanged (used by Dummy)
    */
   public void removeMark() {
      textSymbol = false;
   }

   /**
    * Tests if this atom is marked as a text symbol (used by Msubsup)
    * 
    * @return whether this CharSymbol is marked as a text symbol
    */
   public boolean isMarkedAsTextSymbol() {
      return textSymbol;
   }

   /**
    * Get the CharFont-object that uniquely identifies the character that is represented
    * by this atom.
    * 
    * @param tf the TeXFont containing all font related information
    * @return
    */
   public abstract CharFont getCharFont(TeXFont tf);
}