Qt Cryptographic Architecture: QCA::Base64 Class Reference

# QCA::Base64 Class Reference
[QCA user API]

Base64 encoding / decoding More...

`#include <QtCrypto>`

Inheritance diagram for QCA::Base64:

Collaboration diagram for QCA::Base64:

[legend]

List of all members.

## Public Member Functions
| Base64 (Direction dir=Encode)
virtual void | clear ()
virtual MemoryRegion | final ()
int | lineBreaksColumn () const
bool | lineBreaksEnabled () const
virtual bool | ok () const
void | setLineBreaksColumn (int column)
void | setLineBreaksEnabled (bool b)
virtual MemoryRegion | update (const MemoryRegion &a)

## Detailed Description

Base64 encoding / decoding

Examples:

  base64test.cpp, publickeyexample.cpp, saslclient.cpp, and saslserver.cpp.

## Constructor & Destructor Documentation

QCA::Base64::Base64 | ( | Direction | dir = `Encode` | ) |

Standard constructor.

Parameters:

  | dir | the Direction that should be used.

Note:
  The direction can be changed using the setup() call.

## Member Function Documentation

virtual void QCA::Base64::clear | ( |  | ) | `[virtual]`

Reset the internal state.

This is useful to reuse an existing Base64 object

Implements QCA::Filter.

virtual MemoryRegion QCA::Base64::final | ( |  | ) | `[virtual]`

Complete the algorithm.

Returns:
  any remaining output. Because of the way Base64 encoding works, you will get either an empty array, or an array containing one or two "=" (equals, 0x3D) characters.

Implements QCA::Filter.

int QCA::Base64::lineBreaksColumn | ( |  | ) | const

Returns the line break column.

bool QCA::Base64::lineBreaksEnabled | ( |  | ) | const

Returns true if line breaks are enabled.

virtual bool QCA::Base64::ok | ( |  | ) | const`[virtual]`

Test if an update() or final() call succeeded.

Returns:
  true if the previous call succeeded

Implements QCA::Filter.

void QCA::Base64::setLineBreaksColumn | ( | int | column | ) |

Sets the column that linebreaks should be inserted at when encoding.

Parameters:

  | column | the column number that line breaks should be inserted at.

void QCA::Base64::setLineBreaksEnabled | ( | bool | b | ) |

Sets line break mode.

If enabled, linebreaks will be added to encoded output or accepted in encoded input. If disabled, linebreaks in encoded input will cause a failure to decode. The default is disabled.

Parameters:

  | b | whether to enable line breaks (true) or disable line breaks (false)

virtual MemoryRegion QCA::Base64::update | ( | const MemoryRegion & | a | ) | `[virtual]`

Process more data, returning the corresponding encoded or decoded (depending on the Direction set in the constructor or setup() call) representation.

If you find yourself with code that only calls this method once, you might be better off using encode() or decode(). Similarly, if the data is really a string, you might be better off using arrayToString(), encodeString(), stringToArray() or decodeString().

Parameters:

  | a | the array containing data to process

Implements QCA::Filter.

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

- qca_textfilter.h