Bidi Class Reference

Static Public Member Functions
static bool	IsAvailable ()
	True if libfribidi is compiled in, so GetRuns() reorders mixed-direction lines correctly.
static wxString	Version ()
	The version of libfribidi actually loaded at run time, e.g.
static wxString	Diagnosis ()
	A sentence for Help > Troubleshooting saying how mixed-direction lines are handled.
static std::vector< BidiRun >	GetRuns (const wxString &line, bool paragraphIsRightToLeft)
	The runs that make up line, in visual (left-to-right on screen) order.
static std::vector< BidiRun >	GetRuns (const std::vector< uint32_t > &codepoints, bool paragraphIsRightToLeft)
	The same computation as GetRuns(), but on raw Unicode code points - the part that doesn't need wxWidgets, kept separate so it can be tested on its own.

Member Function Documentation

Diagnosis()

wxString Bidi::Diagnosis ( )

static

A sentence for Help > Troubleshooting saying how mixed-direction lines are handled.

Uses the same words as the "Accurate right-to-left text editing" line of the configure summary (cmake/WxmFeatureSummary.cmake), so that the two agree on what the feature is called.

GetRuns()

std::vector< BidiRun > Bidi::GetRuns ( const wxString &  line, bool  paragraphIsRightToLeft  )

static

The runs that make up line, in visual (left-to-right on screen) order.

Parameters

line	The text of a single display line (no ' ' or soft breaks in it).
paragraphIsRightToLeft	The direction to resolve the line's overall direction to if it contains no strongly-directional character at all - normally Configuration::RightToLeftDocument().

Never returns an empty vector for a non-empty line: on any error (or when libfribidi isn't compiled in) the whole line comes back as one run in paragraphIsRightToLeft's direction.

Version()

wxString Bidi::Version ( )

static

The version of libfribidi actually loaded at run time, e.g.

"1.0.13"

Read from the library rather than from its headers, so that it names the library the program found, which is what a bug report needs. Empty if libfribidi isn't compiled in.

---

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

• src/Bidi.h
• src/Bidi.cpp