Mapper  0.9.0
API documentation
Friends | List of all members
OpenOrienteering::OcdFileImport::OcdImportedTextSymbol Class Reference

#include <ocd_file_import.h>

Inheritance diagram for OpenOrienteering::OcdFileImport::OcdImportedTextSymbol:
Inheritance graph
[legend]
Collaboration diagram for OpenOrienteering::OcdFileImport::OcdImportedTextSymbol:
Collaboration graph
[legend]

Friends

class OcdFileImport
 

Additional Inherited Members

- Public Types inherited from OpenOrienteering::TextSymbol
enum  FramingMode { NoFraming = 0, LineFraming = 1, ShadowFraming = 2 }
 Modes for text framing. More...
 
- Public Types inherited from OpenOrienteering::Symbol
enum  Type {
  Point = 1, Line = 2, Area = 4, Text = 8,
  Combined = 16, NoSymbol = 0, AllSymbols = Point | Line | Area | Text | Combined
}
 Enumeration of all possible symbol types. More...
 
enum  RenderableOption { RenderBaselines = 1 << 0, RenderAreasHatched = 1 << 1, RenderNormal = 0 }
 RenderableOptions denominate variations in painting symbols. More...
 
- Public Member Functions inherited from OpenOrienteering::TextSymbol
 TextSymbol ()
 Creates an empty text symbol. More...
 
 ~TextSymbol () override
 
void createRenderables (const Object *object, const VirtualCoordVector &coords, ObjectRenderables &output, Symbol::RenderableOptions options) const override
 Creates renderables for a generic object. More...
 
void createBaselineRenderables (const TextObject *text_object, const VirtualCoordVector &coords, ObjectRenderables &output) const
 
void createLineBelowRenderables (const Object *object, ObjectRenderables &output) const
 
void colorDeletedEvent (const MapColor *color) override
 Called when a color is removed from the map. More...
 
bool containsColor (const MapColor *color) const override
 Returns if the given color is used by this symbol. More...
 
const MapColorguessDominantColor () const override
 Returns the dominant color of this symbol. More...
 
void replaceColors (const MapColorMap &color_map) override
 Replaces colors used by this symbol. More...
 
void scale (double factor) override
 Scales the symbol. More...
 
void updateQFont ()
 Updates the internal QFont from the font settings. More...
 
double calculateInternalScaling () const
 Calculates the factor to convert from the real font size to the internal font size. More...
 
const MapColorgetColor () const
 
void setColor (const MapColor *color)
 
const QStringgetFontFamily () const
 
double getFontSize () const
 
bool isBold () const
 
bool isItalic () const
 
bool isUnderlined () const
 
float getLineSpacing () const
 
double getParagraphSpacing () const
 
double getCharacterSpacing () const
 
bool usesKerning () const
 
QString getIconText () const
 
bool usesFraming () const
 
const MapColorgetFramingColor () const
 
int getFramingMode () const
 
int getFramingLineHalfWidth () const
 
int getFramingShadowXOffset () const
 
int getFramingShadowYOffset () const
 
bool hasLineBelow () const
 
const MapColorgetLineBelowColor () const
 
double getLineBelowWidth () const
 
double getLineBelowDistance () const
 
int getNumCustomTabs () const
 
int getCustomTab (int index) const
 
const QFontgetQFont () const
 
const QFontMetricsFgetFontMetrics () const
 
double getNextTab (double pos) const
 
SymbolPropertiesWidgetcreatePropertiesWidget (SymbolSettingDialog *dialog) override
 Creates a properties widget for the symbol. More...
 
- Public Member Functions inherited from OpenOrienteering::Symbol
 Symbol (Type type) noexcept
 
virtual ~Symbol ()
 
Symboloperator= (const Symbol &)=delete
 
Symboloperator= (Symbol &&)=delete
 
virtual bool validate () const
 
bool equals (const Symbol *other, Qt::CaseSensitivity case_sensitivity=Qt::CaseSensitive) const
 Checks for equality to the other symbol. More...
 
bool stateEquals (const Symbol *other) const
 Checks protected/hidden state for equality to the other symbol. More...
 
Type getType () const
 Returns the type of the symbol. More...
 
const PointSymbolasPoint () const
 Case to PointSymbol with type checking. More...
 
PointSymbolasPoint ()
 Case to PointSymbol with type checking. More...
 
const LineSymbolasLine () const
 Case to LineSymbol with type checking. More...
 
LineSymbolasLine ()
 Case to LineSymbol with type checking. More...
 
const AreaSymbolasArea () const
 Case to AreaSymbol with type checking. More...
 
AreaSymbolasArea ()
 Case to AreaSymbol with type checking. More...
 
const TextSymbolasText () const
 Case to TextSymbol with type checking. More...
 
TextSymbolasText ()
 Case to TextSymbol with type checking. More...
 
const CombinedSymbolasCombined () const
 Case to CombinedSymbol with type checking. More...
 
CombinedSymbolasCombined ()
 Case to CombinedSymbol with type checking. More...
 
virtual TypeCombination getContainedTypes () const
 Returns the combined bitmask of all symbol types this symbol contains. More...
 
bool isTypeCompatibleTo (const Object *object) const
 Checks if the symbol can be applied to the given object. More...
 
bool numberEquals (const Symbol *other) const
 Returns if the symbol numbers are exactly equal. More...
 
bool numberEqualsRelaxed (const Symbol *other) const
 Returns if the symbol numbers are equal, ignoring trailing zeros. More...
 
void save (QXmlStreamWriter &xml, const Map &map) const
 Saves the symbol in xml format. More...
 
virtual bool loadingFinishedEvent (Map *map)
 Called when loading the map is finished. More...
 
virtual void createRenderables (const PathObject *object, const PathPartVector &path_parts, ObjectRenderables &output, Symbol::RenderableOptions options) const
 Creates renderables for a path object. More...
 
virtual void createBaselineRenderables (const PathObject *object, const PathPartVector &path_parts, ObjectRenderables &output, const MapColor *color) const
 Creates baseline renderables for a path object. More...
 
virtual bool symbolChangedEvent (const Symbol *old_symbol, const Symbol *new_symbol)
 Called when a symbol was changed, replaced, or removed. More...
 
virtual bool containsSymbol (const Symbol *symbol) const
 Returns true if the given symbol is referenced by this symbol. More...
 
QImage getCustomIcon () const
 Returns the custom symbol icon. More...
 
void setCustomIcon (const QImage &image)
 Sets a custom symbol icon. More...
 
QImage getIcon (const Map *map) const
 Returns the symbol's icon. More...
 
QImage createIcon (const Map &map, int side_length, bool antialiasing=true, qreal zoom=0) const
 Creates a symbol icon with the given side length (pixels). More...
 
void resetIcon ()
 Clear the symbol's cached icon. More...
 
virtual qreal dimensionForIcon () const
 Returns the dimension which shall considered when scaling the icon. More...
 
virtual qreal calculateLargestLineExtent () const
 Returns the largest extent of all primitive lines which are part of the symbol. More...
 
const QStringgetName () const
 Returns the symbol name. More...
 
QString getPlainTextName () const
 Returns the symbol name with all HTML markup stripped. More...
 
void setName (const QString &new_name)
 Sets the symbol name. More...
 
QString getNumberAsString () const
 Returns the symbol number as string. More...
 
int getNumberComponent (int i) const
 Returns the i-th component of the symbol number as int. More...
 
void setNumberComponent (int i, int new_number)
 Sets the i-th component of the symbol number. More...
 
const QStringgetDescription () const
 Returns the symbol description. More...
 
void setDescription (const QString &new_description)
 Sets the symbol description. More...
 
bool isHelperSymbol () const
 Returns if this is a helper symbol (which is not printed in the final map). More...
 
void setIsHelperSymbol (bool value)
 Sets if this is a helper symbol, see isHelperSymbol(). More...
 
bool isHidden () const
 Returns if this symbol is hidden. More...
 
void setHidden (bool value)
 Sets the hidden state of this symbol. More...
 
bool isProtected () const
 Returns if this symbol is protected. More...
 
void setProtected (bool value)
 Sets the protected state of this symbol. More...
 
bool isRotatable () const
 Returns if objects with this symbol can be rotated in arbitrary directions. More...
 
- Static Public Member Functions inherited from OpenOrienteering::Symbol
template<class S >
static std::unique_ptr< S > duplicate (const S &s)
 Duplicates a symbol. More...
 
static std::unique_ptr< Symbolload (QXmlStreamReader &xml, const Map &map, SymbolDictionary &symbol_dict, int version)
 Load the symbol in xml format. More...
 
static std::unique_ptr< SymbolmakeSymbolForType (Type type)
 Returns a newly created symbol of the given type. More...
 
static bool areTypesCompatible (Type a, Type b)
 Returns if the symbol types can be applied to the same object types. More...
 
static TypeCombination getCompatibleTypes (Type type)
 Returns a bitmask of all types which can be applied to the same objects as the given type. More...
 
static bool lessByNumber (const Symbol *s1, const Symbol *s2)
 Compares two symbols by number. More...
 
static bool lessByColorPriority (const Symbol *s1, const Symbol *s2)
 Compares two symbols by the dominant colors' priorities. More...
 
- Static Public Attributes inherited from OpenOrienteering::TextSymbol
static constexpr qreal internal_point_size = 256
 
- Static Public Attributes inherited from OpenOrienteering::Symbol
static constexpr auto number_components = 3u
 Number of components of symbol numbers. More...
 
- Protected Member Functions inherited from OpenOrienteering::TextSymbol
 TextSymbol (const TextSymbol &proto)
 
TextSymbolduplicate () const override
 
void saveImpl (QXmlStreamWriter &xml, const Map &map) const override
 Must be overridden to save type-specific symbol properties. More...
 
bool loadImpl (QXmlStreamReader &xml, const Map &map, SymbolDictionary &symbol_dict, int version) override
 Must be overridden to load type-specific symbol properties. More...
 
bool equalsImpl (const Symbol *other, Qt::CaseSensitivity case_sensitivity) const override
 Must be overridden to compare specific attributes. More...
 
- Protected Member Functions inherited from OpenOrienteering::Symbol
 Symbol (const Symbol &proto)
 
void setRotatable (bool value)
 Sets the rotatability state of the symbol. More...
 
- Protected Attributes inherited from OpenOrienteering::TextSymbol
QFont qfont
 
QFontMetricsF metrics
 
QString font_family
 
QString icon_text
 
const MapColorcolor
 
const MapColorframing_color
 
const MapColorline_below_color
 
std::vector< int > custom_tabs
 
double tab_interval
 
float line_spacing
 default tab interval length in text coordinates More...
 
float character_spacing
 
int font_size
 
int paragraph_spacing
 
int framing_mode
 
int framing_line_half_width
 
int framing_shadow_x_offset
 
int framing_shadow_y_offset
 
int line_below_width
 
int line_below_distance
 
bool bold
 
bool italic
 
bool underline
 
bool kerning
 
bool framing
 
bool line_below
 

Friends And Related Function Documentation

◆ OcdFileImport

friend class OcdFileImport
friend

The documentation for this class was generated from the following file: