Namespaces | Classes | Macros | Typedefs | Functions | Variables

Detailed Description

Namespaces

 juce
 

Classes

struct  Base64
 Contains some static methods for converting between binary and the standard base-64 encoding format. More...
 
class  CharacterFunctions
 A collection of functions for manipulating characters and character strings. More...
 
struct  CharacterFunctions::HexParser< ResultType >
 Parses a character string, to read a hexadecimal value. More...
 
class  CharPointer_ASCII
 Wraps a pointer to a null-terminated ASCII character string, and provides various methods to operate on the data. More...
 
class  CharPointer_UTF16
 Wraps a pointer to a null-terminated UTF-16 character string, and provides various methods to operate on the data. More...
 
class  CharPointer_UTF32
 Wraps a pointer to a null-terminated UTF-32 character string, and provides various methods to operate on the data. More...
 
class  CharPointer_UTF8
 Wraps a pointer to a null-terminated UTF-8 character string, and provides various methods to operate on the data. More...
 
class  Identifier
 Represents a string identifier, designed for accessing properties by name. More...
 
class  LocalisedStrings
 Used to convert strings to localised foreign-language versions. More...
 
class  NewLine
 This class is used for represent a new-line character sequence. More...
 
class  juce::String
 The JUCE String class! More...
 
class  StringArray
 A special array for holding a list of strings. More...
 
class  StringPairArray
 A container for holding a set of strings which are keyed by another string. More...
 
class  StringPool
 A StringPool holds a set of shared strings, which reduces storage overheads and improves comparison speed when dealing with many duplicate strings. More...
 
class  StringRef
 A simple class for holding temporary references to a string literal or String. More...
 
class  TextDiff
 Calculates and applies a sequence of changes to convert one text string into another. More...
 
struct  TextDiff::Change
 Describes a change, which can be either an insertion or deletion. More...
 

Macros

#define JUCE_NATIVE_WCHAR_IS_UTF8   0
 This macro will be set to 1 if the compiler's native wchar_t is an 8-bit type. More...
 
#define JUCE_NATIVE_WCHAR_IS_UTF16   0
 This macro will be set to 1 if the compiler's native wchar_t is a 16-bit type. More...
 
#define JUCE_NATIVE_WCHAR_IS_UTF32   1
 This macro will be set to 1 if the compiler's native wchar_t is a 32-bit type. More...
 
#define TRANS(stringLiteral)   juce::translate (stringLiteral)
 Uses the LocalisedStrings class to translate the given string literal. More...
 
#define NEEDS_TRANS(stringLiteral)   (stringLiteral)
 A dummy version of the TRANS macro, used to indicate a string literal that should be added to the translation file by source-code scanner tools. More...
 
#define JUCE_CF_BRIDGED_TYPE(T)
 

Typedefs

using juce_wchar = wchar_t
 A platform-independent 32-bit unicode character type. More...
 

Functions

JUCE_API String translate (const String &stringLiteral)
 Uses the LocalisedStrings class to translate the given string literal. More...
 
JUCE_API String translate (const char *stringLiteral)
 Uses the LocalisedStrings class to translate the given string literal. More...
 
JUCE_API String translate (CharPointer_UTF8 stringLiteral)
 Uses the LocalisedStrings class to translate the given string literal. More...
 
JUCE_API String translate (const String &stringLiteral, const String &resultIfNotFound)
 Uses the LocalisedStrings class to translate the given string literal. More...
 
String & operator<< (String &string1, const NewLine &)
 Writes a new-line sequence to a string. More...
 
String & operator+= (String &s1, const NewLine &)
 
String operator+ (const NewLine &, const NewLine &)
 
String operator+ (String s1, const NewLine &)
 
String operator+ (const NewLine &, const char *s2)
 
const struct JUCE_CF_BRIDGED_TYPE (NSString) __CFString *CFStringRef
 
JUCE_API bool JUCE_CALLTYPE operator== (const String &string1, StringRef string2) noexcept
 Case-sensitive comparison of two strings. More...
 
JUCE_API bool JUCE_CALLTYPE operator!= (const String &string1, StringRef string2) noexcept
 Case-sensitive comparison of two strings. More...
 
JUCE_API bool JUCE_CALLTYPE operator< (const String &string1, StringRef string2) noexcept
 Case-sensitive comparison of two strings. More...
 
JUCE_API bool JUCE_CALLTYPE operator<= (const String &string1, StringRef string2) noexcept
 Case-sensitive comparison of two strings. More...
 
JUCE_API bool JUCE_CALLTYPE operator> (const String &string1, StringRef string2) noexcept
 Case-sensitive comparison of two strings. More...
 
JUCE_API bool JUCE_CALLTYPE operator>= (const String &string1, StringRef string2) noexcept
 Case-sensitive comparison of two strings. More...
 
String operator+ (String s1, StringRef s2)
 
String operator+ (StringRef s1, const String &s2)
 
String operator+ (const char *s1, StringRef s2)
 
String operator+ (StringRef s1, const char *s2)
 

Variables

NewLine newLine
 A predefined object representing a new-line, which can be written to a string or stream. More...
 

Macro Definition Documentation

◆ JUCE_NATIVE_WCHAR_IS_UTF8

#define JUCE_NATIVE_WCHAR_IS_UTF8   0

This macro will be set to 1 if the compiler's native wchar_t is an 8-bit type.

◆ JUCE_NATIVE_WCHAR_IS_UTF16

#define JUCE_NATIVE_WCHAR_IS_UTF16   0

This macro will be set to 1 if the compiler's native wchar_t is a 16-bit type.

◆ JUCE_NATIVE_WCHAR_IS_UTF32

#define JUCE_NATIVE_WCHAR_IS_UTF32   1

This macro will be set to 1 if the compiler's native wchar_t is a 32-bit type.

◆ TRANS

#define TRANS (   stringLiteral)    juce::translate (stringLiteral)

Uses the LocalisedStrings class to translate the given string literal.

This macro is provided for backwards-compatibility, and just calls the translate() function. In new code, it's recommended that you just call translate() directly instead, and avoid using macros.

See also
translate(), LocalisedStrings

◆ NEEDS_TRANS

#define NEEDS_TRANS (   stringLiteral)    (stringLiteral)

A dummy version of the TRANS macro, used to indicate a string literal that should be added to the translation file by source-code scanner tools.

Wrapping a string literal in this macro has no effect, but by using it around strings that your app needs to translate at a later stage, it lets automatic code-scanning tools find this string and add it to the list of strings that need translation.

◆ JUCE_CF_BRIDGED_TYPE

#define JUCE_CF_BRIDGED_TYPE (   T)

Typedef Documentation

◆ juce_wchar

using juce_wchar = wchar_t

A platform-independent 32-bit unicode character type.

Function Documentation

◆ translate() [1/4]

JUCE_API String translate ( const String &  stringLiteral)

Uses the LocalisedStrings class to translate the given string literal.

See also
LocalisedStrings

◆ translate() [2/4]

JUCE_API String translate ( const char *  stringLiteral)

Uses the LocalisedStrings class to translate the given string literal.

See also
LocalisedStrings

◆ translate() [3/4]

JUCE_API String translate ( CharPointer_UTF8  stringLiteral)

Uses the LocalisedStrings class to translate the given string literal.

See also
LocalisedStrings

◆ translate() [4/4]

JUCE_API String translate ( const String &  stringLiteral,
const String &  resultIfNotFound 
)

Uses the LocalisedStrings class to translate the given string literal.

See also
LocalisedStrings

◆ operator<<()

String& operator<< ( String &  string1,
const NewLine  
)

Writes a new-line sequence to a string.

You can use the predefined object 'newLine' to invoke this, e.g.

myString << "Hello World" << newLine << newLine;

References NewLine::getDefault().

◆ operator+=()

String& operator+= ( String &  s1,
const NewLine  
)

References NewLine::getDefault().

◆ operator+() [1/7]

String operator+ ( const NewLine ,
const NewLine  
)

References NewLine::getDefault().

◆ operator+() [2/7]

String operator+ ( String  s1,
const NewLine  
)

References NewLine::getDefault().

◆ operator+() [3/7]

String operator+ ( const NewLine ,
const char *  s2 
)

References NewLine::getDefault().

◆ JUCE_CF_BRIDGED_TYPE()

const struct JUCE_CF_BRIDGED_TYPE ( NSString  )

◆ operator==()

JUCE_API bool JUCE_CALLTYPE operator== ( const String &  string1,
StringRef  string2 
)
noexcept

Case-sensitive comparison of two strings.

◆ operator!=()

JUCE_API bool JUCE_CALLTYPE operator!= ( const String &  string1,
StringRef  string2 
)
noexcept

Case-sensitive comparison of two strings.

◆ operator<()

JUCE_API bool JUCE_CALLTYPE operator< ( const String &  string1,
StringRef  string2 
)
noexcept

Case-sensitive comparison of two strings.

◆ operator<=()

JUCE_API bool JUCE_CALLTYPE operator<= ( const String &  string1,
StringRef  string2 
)
noexcept

Case-sensitive comparison of two strings.

◆ operator>()

JUCE_API bool JUCE_CALLTYPE operator> ( const String &  string1,
StringRef  string2 
)
noexcept

Case-sensitive comparison of two strings.

◆ operator>=()

JUCE_API bool JUCE_CALLTYPE operator>= ( const String &  string1,
StringRef  string2 
)
noexcept

Case-sensitive comparison of two strings.

◆ operator+() [4/7]

String operator+ ( String  s1,
StringRef  s2 
)

References StringRef::text.

◆ operator+() [5/7]

String operator+ ( StringRef  s1,
const String &  s2 
)

References StringRef::text.

◆ operator+() [6/7]

String operator+ ( const char *  s1,
StringRef  s2 
)

References StringRef::text.

◆ operator+() [7/7]

String operator+ ( StringRef  s1,
const char *  s2 
)

References StringRef::text.

Variable Documentation

◆ newLine

NewLine newLine

A predefined object representing a new-line, which can be written to a string or stream.

To write a new-line to a stream, you can use the predefined 'newLine' variable like this:

myOutputStream << "Hello World" << newLine << newLine;

Referenced by CppTokeniserFunctions::writeEscapeChars().

newLine
NewLine newLine
A predefined object representing a new-line, which can be written to a string or stream.