Jaye Evins
318 lines
10 KiB
C++
318 lines
10 KiB
C++
// Barcode.hpp
|
|
//
|
|
// Copyright (C) 2013-2026 Jaye Evins <evins@snaught.com>
|
|
//
|
|
// This file is part of glbarcode++.
|
|
//
|
|
// glbarcode++ is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Lesser General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// glbarcode++ 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 Lesser General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public License
|
|
// along with glbarcode++. If not, see <http://www.gnu.org/licenses/>.
|
|
//
|
|
|
|
#ifndef glbarcode_Barcode_hpp
|
|
#define glbarcode_Barcode_hpp
|
|
|
|
|
|
#include <string>
|
|
|
|
#include "Enums.hpp"
|
|
#include "Renderer.hpp"
|
|
|
|
|
|
namespace glbarcode
|
|
{
|
|
|
|
/**
|
|
* @class Barcode Barcode.h glbarcode/Barcode.h
|
|
*
|
|
* The Barcode class is the base class for all barcode implementations. This class
|
|
* provides the public interfaces and basic infrastructure for all barcode implementations.
|
|
* Implementations would not typically directly implement this class, but instead would implement
|
|
* either Barcode1dBase (for 1D symbologies) or Barcode2dBase (for 2D symbologies).
|
|
*
|
|
* See Barcode1dBase or Barcode2dBase.
|
|
*
|
|
*/
|
|
class Barcode
|
|
{
|
|
|
|
protected:
|
|
/**
|
|
* Default constructor.
|
|
*/
|
|
Barcode();
|
|
|
|
|
|
public:
|
|
/**
|
|
* Destructor.
|
|
*/
|
|
virtual ~Barcode();
|
|
|
|
/*
|
|
* Non-copyable
|
|
*/
|
|
Barcode( const Barcode & ) = delete;
|
|
void operator=( const Barcode & ) = delete;
|
|
|
|
/**
|
|
* Set accessor for "showText" property.
|
|
*
|
|
* @param[in] value Boolean value
|
|
*
|
|
* @returns A reference to this Barcode object for property chaining
|
|
*
|
|
* @sa showText()
|
|
*/
|
|
Barcode& setShowText( bool value );
|
|
|
|
|
|
/**
|
|
* Get accessor for "showText" property.
|
|
*
|
|
* @returns Value of boolean "showText" property
|
|
*
|
|
* @sa setShowText()
|
|
*/
|
|
bool showText() const;
|
|
|
|
|
|
/**
|
|
* Set accessor for "checksum" property.
|
|
*
|
|
* @param[in] value Boolean value
|
|
*
|
|
* @returns A reference to this Barcode object for property chaining
|
|
*
|
|
* @sa checksum()
|
|
*/
|
|
Barcode& setChecksum( bool value );
|
|
|
|
|
|
/**
|
|
* Get accessor for "checksum" property.
|
|
*
|
|
* @returns Value of boolean "checksum" property
|
|
*
|
|
* @sa setChecksum()
|
|
*/
|
|
bool checksum() const;
|
|
|
|
|
|
/**
|
|
* Build barcode from data.
|
|
*
|
|
* @param[in] data Data to encode in barcode
|
|
* @param[in] w Requested width of barcode (0 = auto size)
|
|
* @param[in] h Requested height of barcode (0 = auto size)
|
|
*
|
|
* @returns A reference to this Barcode object for chaining methods
|
|
*/
|
|
virtual Barcode& build( const std::string& data,
|
|
double w = 0,
|
|
double h = 0 ) = 0;
|
|
|
|
|
|
/**
|
|
* Render barcode using given Renderer object.
|
|
*
|
|
* @param[in] renderer A Renderer object
|
|
*/
|
|
void render( Renderer& renderer );
|
|
|
|
|
|
/**
|
|
* Is barcode data empty?
|
|
*
|
|
* @return True if barcode data is empty
|
|
* @return False if barcode data is not empty
|
|
*
|
|
* @sa setIsEmpty()
|
|
*/
|
|
bool isEmpty() const;
|
|
|
|
|
|
/**
|
|
* Is barcode data valid?
|
|
*
|
|
* @return True if barcode data is valid
|
|
* @return False if barcode data is not valid for implemented barcode type
|
|
*
|
|
* @sa setIsDataValid()
|
|
*/
|
|
bool isDataValid() const;
|
|
|
|
|
|
/**
|
|
* Get actual width of barcode (may differ from requested width).
|
|
*
|
|
* @return Actual width of barcode (points)
|
|
*
|
|
* @sa setWidth()
|
|
*/
|
|
double width() const;
|
|
|
|
|
|
/**
|
|
* Get actual height of barcode (may differ from requested height).
|
|
*
|
|
* @return Actual height of barcode (points)
|
|
*
|
|
* @sa setHeight()
|
|
*/
|
|
double height() const;
|
|
|
|
|
|
protected:
|
|
/**
|
|
* Clear drawing primitives.
|
|
*/
|
|
void clear();
|
|
|
|
|
|
/**
|
|
* Add line drawing primitive
|
|
*
|
|
* To be used by build() implementations during vectorization.
|
|
*
|
|
* @image html figure-primitive-line.svg "Line primitive properties"
|
|
*
|
|
* @param[in] x X coordinate of line's origin (points)
|
|
* @param[in] y Y coordinate of line's origin (points)
|
|
* @param[in] w Bar width (points)
|
|
* @param[in] h Bar height (points)
|
|
*/
|
|
void addLine( double x, double y, double w, double h );
|
|
|
|
|
|
/**
|
|
* Add box drawing primitive
|
|
*
|
|
* To be used by build() implementations during vectorization.
|
|
*
|
|
* @image html figure-primitive-box.svg "Box primitive properties"
|
|
*
|
|
* @param[in] x X coordinate of box's origin (points)
|
|
* @param[in] y Y coordinate of box's origin (points)
|
|
* @param[in] w Width of box (points)
|
|
* @param[in] h Height of box (points)
|
|
*/
|
|
void addBox( double x, double y, double w, double h );
|
|
|
|
|
|
/**
|
|
* Add text drawing primitive
|
|
*
|
|
* To be used by build() implementations during vectorization.
|
|
*
|
|
* @image html figure-primitive-text.svg "Text primitive properties"
|
|
*
|
|
* @param[in] x X coordinate of text's origin (points)
|
|
* @param[in] y Y coordinate of text's origin (points)
|
|
* @param[in] size Font size of text (points)
|
|
* @param[in] text Text
|
|
* @param[in] halign Horizontal text alignment
|
|
*/
|
|
void addText( double x, double y, double size, const std::string& text, HAlign halign = H_ALIGN_CENTER );
|
|
|
|
|
|
/**
|
|
* Add ring drawing primitive
|
|
*
|
|
* To be used by build() implementations during vectorization.
|
|
*
|
|
* @image html figure-primitive-ring.svg "Ring primitive properties"
|
|
*
|
|
* @param[in] x X coordinate of ring's origin (points)
|
|
* @param[in] y Y coordinate of ring's origin (points)
|
|
* @param[in] r Radius of ring (points)
|
|
* @param[in] w Line width of ring (points)
|
|
*/
|
|
void addRing( double x, double y, double r, double w );
|
|
|
|
|
|
/**
|
|
* Add hexagon drawing primitive
|
|
*
|
|
* To be used by build() implementations during vectorization.
|
|
*
|
|
* @image html figure-primitive-hexagon.svg "Hexagon primitive properties"
|
|
*
|
|
* @param[in] x X coordinate of hexagon's origin (points)
|
|
* @param[in] y Y coordinate of hexagon's origin (points)
|
|
* @param[in] h Height of hexagon (points)
|
|
*/
|
|
void addHexagon( double x, double y, double h );
|
|
|
|
|
|
/**
|
|
* Set is empty property.
|
|
*
|
|
* To be used by build() implementations to indicate if input data is empty.
|
|
*
|
|
* @param[in] value Boolean value of flag
|
|
*
|
|
* @sa isEmpty()
|
|
*/
|
|
void setIsEmpty( bool value );
|
|
|
|
|
|
/**
|
|
* Set is data valid property.
|
|
*
|
|
* To be used by build() implementations to indicate if input data is valid or not.
|
|
*
|
|
* @param[in] value Boolean value of flag
|
|
*
|
|
* @sa isDataValid()
|
|
*/
|
|
void setIsDataValid( bool value );
|
|
|
|
|
|
/**
|
|
* Set new width of barcode.
|
|
*
|
|
* To be used by build() implementations to override requested width of barcode.
|
|
*
|
|
* @param[in] w Actual width of barcode (points)
|
|
*
|
|
* @sa width()
|
|
*/
|
|
void setWidth( double w );
|
|
|
|
|
|
/**
|
|
* Set new height of barcode.
|
|
*
|
|
* To be used by build() implementations to override requested height of barcode.
|
|
*
|
|
* @param[in] h Actual height of barcode (points)
|
|
*
|
|
* @sa height()
|
|
*/
|
|
void setHeight( double h );
|
|
|
|
|
|
private:
|
|
/**
|
|
* Barcode Private data
|
|
*/
|
|
struct PrivateData;
|
|
PrivateData *d;
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
|
#endif // glbarcode_Barcode_hpp
|