KTextTemplate Namespace

Function Documentation

std::pair<qreal, QString> KTextTemplate::calcFileSize(qreal size, int unitSystem = 10, qreal multiplier = 1.0)

Converts size into the nearest file size unit like MB or MiB, based on the unitSystem value. Use 2 for the unitSystem to get binary units, use 10 to get decimal units - by default, decimal units will be returned. The multiplier can be used if the input size is not in pure bytes. If size is for example given in KiB, use a multiplier of 1024. The returned pair will have the converted size as first and the unit as second.

bool KTextTemplate::equals(const QVariant &lhs, const QVariant &rhs)

Compares lhs and rhs for equality. SafeStrings are compared as raw QStrings. Their safeness is not part of the comparison.

KTextTemplate::SafeString KTextTemplate::getSafeString(const QVariant &input)

Retrieves and returns a SafeString from the input.

bool KTextTemplate::isSafeString(const QVariant &input)

Returns whether input contains a SafeString.

KTextTemplate::SafeString KTextTemplate::markForEscaping(const KTextTemplate::SafeString &input)

Marks the input as requiring escaping.

KTextTemplate::SafeString KTextTemplate::markSafe(const KTextTemplate::SafeString &input)

Marks the input as safe.

template <typename RealType, typename HandleAs> int registerMetaType()

Registers the type RealType with the metatype system.

This method can take a second template parameter to specify a cast that should be invoked during registration. This is useful if a base type is already supported.

  class SomeType
  {
  public:
    QString someProp() const;
  };

  // define some introspectable API for SomeType

  KTEXTTEMPLATE_BEGIN_LOOKUP(SomeType)
    if (property == "someProp")
      return object.someProp();
  KTEXTTEMPLATE_END_LOOKUP


  class OtherType : public SomeType
  {
    // ...
  };

  registerMetaType<SomeType>();

  // Only the introspectable API from SomeType is needed, so we can reuse that
registration.
  registerMetaType<OtherType, SomeType>();

bool KTextTemplate::supportedOutputType(const QVariant &input)

Returns true if the type of input can be inserted into a rendered template directly.

Note that lists, hashes and QObject*s can not be.

QString KTextTemplate::unescapeStringLiteral(const QString &input)

Converts the input into its unescaped form.

Double slashes are converted to single slashes, \&quot is converted to &quot etc.

bool KTextTemplate::variantIsTrue(const QVariant &variant)

Returns whether the variant is evaluated to true.