Standard Classes. More...
Data Structures | |
class | BasicString |
Generic String. More... | |
class | iRContainer |
Container Interface. More... | |
class | QRAboutDialog |
About Dialog Box. More... | |
class | QRGUIApplication |
Generic QT-based GUI Application. More... | |
class | QRPainter |
Qt Painter. More... | |
class | QRXMLStruct |
XML Structure Widget. More... | |
class | RApplication |
Generic Application. More... | |
class | RBinaryFile |
Binary File. More... | |
class | RBlockFile |
Block File. More... | |
class | RBlockFileAccess |
Block File Access. More... | |
class | RBlockFileData |
File Data Block. More... | |
class | RBoolCursor |
Boolean Vector Cursor. More... | |
class | RBoolVector |
Boolean Vector. More... | |
class | RCastCursor |
Container Child Cursor. More... | |
class | RChar |
Unicode Character. More... | |
class | RCharCursor |
Characters Cursor. More... | |
class | RConditionVar |
Conditional Variable. More... | |
class | RConfig |
XML Configuration Structure. More... | |
class | RConstCastCursor |
Constant Container Child Cursor. More... | |
class | RConstCursor |
Constant Container Cursor. More... | |
class | RContainer |
Container. More... | |
class | RCString |
C String. More... | |
class | RCSVFile |
CVS File. More... | |
class | RCursor |
Container Cursor. More... | |
class | RDate |
Date. More... | |
class | RDb |
Generic Database. More... | |
class | RDbException |
Database Error. More... | |
class | RDbMySQL |
MySQL Database. More... | |
class | RDbPostgreSQL |
PostgreSQL Database. More... | |
class | RDbSQLite |
SQLite Database. More... | |
class | RDir |
Directory. More... | |
class | RDownload |
Downloader. More... | |
class | RDownloadFile |
File Downloader. More... | |
class | REncodingException |
Encoding Exception. More... | |
class | RException |
Basic Exception. More... | |
class | RFile |
Generic File. More... | |
class | RHashContainer |
Hash Table Container. More... | |
class | RHTMLFile |
HTML File. More... | |
class | RIncompleteByteException |
Incomplete Byte Exception. More... | |
class | RIntKey |
Integer-based Key. More... | |
class | RIntsKey |
Integers-based Key. More... | |
class | RInvalidByteException |
Invalid Byte Sequence Exception. More... | |
class | RIO |
I/O Types. More... | |
class | RIOException |
IO Exception. More... | |
class | RIOFile |
Generic File for Input/Output. More... | |
class | RKeyValueFile |
Generic Key-Value File. More... | |
class | RLang |
Language. More... | |
class | RLine |
Line. More... | |
class | RLines |
Container of lines. More... | |
class | RLocale |
Locale. More... | |
class | RMutex |
Mutex. More... | |
singleton | RNode |
Generic Node. More... | |
singleton | RNodeCursor |
Node Cursor. More... | |
class | RNotification |
Notification. More... | |
class | RNotificationCenter |
Notification Center. More... | |
class | RNotificationData |
Notification with Data. More... | |
class | RNumContainer |
Container of Numbers. More... | |
class | RNumCursor |
Container of Numbers Cursor. More... | |
class | RObject |
Object. More... | |
class | RObjectContainer |
Object Container. More... | |
class | RObjectHashContainer |
Object Container. More... | |
class | RParam |
Parameter. More... | |
class | RParamList |
List of parameter's values. More... | |
class | RParamStruct |
Structure of Parameters. More... | |
class | RParamValue |
Only-one value of parameter. More... | |
class | RPoint |
Point class. More... | |
class | RPoints |
Container of points. More... | |
class | RPolygon |
Polygon class. More... | |
class | RPolygons |
Container of polygons. More... | |
class | RQuery |
Query. More... | |
class | RQuickSort |
Quicksort template. More... | |
class | RRandom |
Random Generator. More... | |
class | RRecFile |
Fixed-length Records File. More... | |
class | RRect |
Rectangle. More... | |
class | RRects |
Rectangles container. More... | |
class | RRWLock |
Reader/Writer Lock. More... | |
class | RSharedData |
Generic Shared Data. More... | |
class | RSize |
Size. More... | |
class | RSmartMutexPtr |
Smart Mutex Pointer. More... | |
class | RSmartPtr |
Smart Pointer. More... | |
class | RSmartRLockPtr |
Smart Read Lock Pointer. More... | |
class | RSmartTempFile |
Smart Temporary File. More... | |
class | RSmartWLockPtr |
Smart Write Lock Pointer. More... | |
class | RStack |
Stack template. More... | |
class | RString |
Unicode String. More... | |
class | RStringBuilder |
String Builder. More... | |
class | RTextEncoding |
Generic Text Encoding Scheme. More... | |
class | RTextFile |
Text File. More... | |
class | RThread |
Thread. More... | |
class | RThreadLocalStorage |
Thread Local Storage. More... | |
class | RTmpString |
Temporary String. More... | |
class | RTrace |
Trace System. More... | |
class | RTransactionTable |
Transaction Table. More... | |
class | RTree |
Generic Tree. More... | |
class | RTriangle |
Triangle. More... | |
class | RURI |
Uniform Resource Identifier. More... | |
class | RValue |
Value Associated to a Identifier. More... | |
class | RXMLAttr |
XML Tag. More... | |
class | RXMLFile |
XML File. More... | |
class | RXMLParser |
XML Stream Parser. More... | |
class | RXMLStruct |
XML Structure. More... | |
class | RXMLTag |
XML Tag. More... | |
class | StringMethods |
Generic String Methods. More... | |
Typedefs | |
typedef void * | hNotification |
Notification Handle. More... | |
typedef void(RObject::* | tNotificationHandler )(const RNotification &msg) |
Message handler. More... | |
typedef unsigned long long | size_raw |
typedef unsigned short | UChar |
typedef double | tCoord |
Enumerations | |
enum | tOrientation { oNormal, oNormalX, oNormalY, oNormalYX, oRota90, oRota90X, oRota90Y, oRota90YX } |
enum | tDirection { dNoDirection, dLeft, dRight, dDown, dUp, dBehind, dBeyond, dOrigin, dDestination, dBetween, dLeftDown, dLeftUp, dRightDown, dRightUp } |
Functions | |
template<class T > | |
T | GetData (const RNotification ¬ification) |
Data extracted of notification. More... | |
QString | ToQString (const RString &str) |
RString | FromQString (const QString &str) |
QString | ToPlainText (const R::RString &str, int maxlen=100) |
QString | ToPlainText (const QString &str, int maxlen=100) |
R::RString | ExtractHTMLBody (const QTextEdit *edit) |
R::RString | ToSimpleHTML (const QTextEdit *edit) |
void | AdaptXY (tCoord &x, tCoord &y, const tDirection from) |
void | AdaptTestXY (tCoord &x, tCoord &y, const tDirection from) |
RPoint | operator+ (const RPoint &arg1, const RPoint &arg2) |
RPoint | operator- (const RPoint &arg1, const RPoint &arg2) |
RSize | operator+ (const RSize &arg1, const RSize &arg2) |
RSize | operator- (const RSize &arg1, const RSize &arg2) |
RCString | operator+ (const RCString &arg1, const RCString &arg2) |
RCString | operator+ (const RCString &arg1, const char *arg2) |
RCString | operator+ (const char *arg1, const RCString &arg2) |
const RCString | operator+ (char arg1, const RCString &arg2) |
const RCString | operator+ (const RCString &arg1, char arg2) |
const RString | operator+ (const RString &arg1, const RString &arg2) |
const RString | operator+ (const RString &arg1, const char *arg2) |
const RString | operator+ (const char *arg1, const RString &arg2) |
const RString | operator+ (char arg1, const RString &arg2) |
const RString | operator+ (RChar arg1, const RString &arg2) |
const RString | operator+ (const RString &arg1, char arg2) |
const RString | operator+ (const RString &arg1, RChar arg2) |
template<class D > | |
D * | RIncRef (D *data) |
template<class D > | |
void | RDecRef (D *&data) |
tCoord | Abs (tCoord x) |
int | CompareIds (size_t id1, size_t id2) |
int | CompareDoubles (double num1, double num2) |
template<class C > | |
int | ComparePtrs (C *ptr1, C *ptr2) |
Variables | |
RApplication * | App |
RNotificationCenter | NotificationCenter |
QRGUIApplication * | GUIApp |
const off_t | MaxOffT =MAX_INT_VAL(off_t) |
const size_t | cNoRef =std::numeric_limits<size_t>::max() |
const tCoord | cNoCoord =std::numeric_limits<tCoord>::max() |
const tCoord | cMaxCoord =std::numeric_limits<tCoord>::max() |
const tCoord | cMinCoord =std::numeric_limits<tCoord>::min() |
const double | cEpsi =0.000001 |
Detailed Description
Standard Classes.
This namespace declares some generic classes.
Typedef Documentation
typedef void* hNotification |
Notification Handle.
The hNotification provides a handle for a given notification.
typedef void(RObject::* tNotificationHandler)(const RNotification &msg) |
Message handler.
The tNotificationHandler type provides a representation for a method of an object deriving from RObject and taking a notification as parameter.
It is necessary to use the HANDLER macro to define a handler.
typedef unsigned long long size_raw |
Type representing an identifier in a database row.
typedef unsigned short UChar |
Unicode code for a character.
typedef double tCoord |
The tCoord type represents a coordinate.
Enumeration Type Documentation
enum tOrientation |
Represent the different orientation of a given polygon.
enum tDirection |
Represent different directions.
Function Documentation
T R::GetData | ( | const RNotification & | notification | ) |
Data extracted of notification.
Get the data associated with a given notification.
- Template Parameters
-
T Type of the parameter.
- Parameters
-
notification Notification.
QString R::ToQString | ( | const RString & | str | ) |
This function returns a QString (Qt toolkit) corresponding to RString.
- Parameters
-
str String to transform.
- Returns
- QString.
RString R::FromQString | ( | const QString & | str | ) |
QString R::ToPlainText | ( | const R::RString & | str, |
int | maxlen = 100 |
||
) |
Convert a string that contains HTML codes and multiple end of lines into a single line string (eventually limited to a maximum number of characters).
This function can be useful when a given rich content editable by a QTextEdit must be shown in a list (such as in a QListWidget).
- Parameters
-
str String to convert. maxlen Maximum length of the resulted string.
- Returns
- a QString.
QString R::ToPlainText | ( | const QString & | str, |
int | maxlen = 100 |
||
) |
Convert a string that contains HTML codes and multiple end of lines into a single line string (eventually limited to a maximum number of characters).
This function can be useful when a given rich content editable by a QTextEdit must be shown in a list (such as in a QListWidget).
- Parameters
-
str String to convert. maxlen Maximum length of the resulted string.
- Returns
- a QString.
R::RString R::ExtractHTMLBody | ( | const QTextEdit * | edit | ) |
When QTextEdit manipulates a rich content (using HTML tags), the resulting string represents a whole HTML document (starting with the <html> tag). This function construct a string with the content extract from the <body> tag (excluding the tag).
- Parameters
-
edit QTextEdit from which the string must be extracted.
- Returns
- a R::RString.
R::RString R::ToSimpleHTML | ( | const QTextEdit * | edit | ) |
When QTextEdit manipulates a rich content (using HTML tags), the resulting string represents a whole HTML document (starting with the <html> tag). This function construct a string with the content that contains only basic HTML tags (in particular <style> is excluded).
- Parameters
-
edit QTextEdit from which the string must be extracted.
- Returns
- a R::RString.
void R::AdaptXY | ( | tCoord & | x, |
tCoord & | y, | ||
const tDirection | from | ||
) |
Affect the coordinates in function of a given direction.
- Parameters
-
x X Coordinate. y Y Coordinate. from The direction from where "it" is coming.
void R::AdaptTestXY | ( | tCoord & | x, |
tCoord & | y, | ||
const tDirection | from | ||
) |
Calculate the coordinates to test in function of a given direction.
- Parameters
-
x X Coordinate. y Y Coordinate. from The direction from where "it" is coming.
RPoint R::operator+ | ( | const RPoint & | arg1, |
const RPoint & | arg2 | ||
) |
Add two points.
- Parameters
-
arg1 First point. arg2 Second point.
- Returns
- the addition.
RPoint R::operator- | ( | const RPoint & | arg1, |
const RPoint & | arg2 | ||
) |
Subtract two points.
- Parameters
-
arg1 First point. arg2 Second point.
- Returns
- the subtraction.
RSize R::operator+ | ( | const RSize & | arg1, |
const RSize & | arg2 | ||
) |
Add two sizes.
RSize R::operator- | ( | const RSize & | arg1, |
const RSize & | arg2 | ||
) |
Subtract two sizes.
RCString R::operator+ | ( | const RCString & | arg1, |
const RCString & | arg2 | ||
) |
Add two strings.
- Parameters
-
arg1 First string. arg2 Second string.
RCString R::operator+ | ( | const RCString & | arg1, |
const char * | arg2 | ||
) |
Add two strings.
- Parameters
-
arg1 First string. arg2 Second string.
RCString R::operator+ | ( | const char * | arg1, |
const RCString & | arg2 | ||
) |
Add two strings.
- Parameters
-
arg1 First string. arg2 Second string.
const RCString R::operator+ | ( | char | arg1, |
const RCString & | arg2 | ||
) |
Add a string and a character.
- Parameters
-
arg1 Character. arg2 String.
const RCString R::operator+ | ( | const RCString & | arg1, |
char | arg2 | ||
) |
Add a character and a string.
- Parameters
-
arg1 String. arg2 Character.
const RString R::operator+ | ( | const RString & | arg1, |
const RString & | arg2 | ||
) |
Add two strings.
- Parameters
-
arg1 First string. arg2 Second string.
const RString R::operator+ | ( | const RString & | arg1, |
const char * | arg2 | ||
) |
Add two strings.
- Parameters
-
arg1 First string. arg2 Second string.
const RString R::operator+ | ( | const char * | arg1, |
const RString & | arg2 | ||
) |
Add two strings.
- Parameters
-
arg1 First string. arg2 Second string.
const RString R::operator+ | ( | char | arg1, |
const RString & | arg2 | ||
) |
Add a string and a character.
- Parameters
-
arg1 Character. arg2 String.
const RString R::operator+ | ( | RChar | arg1, |
const RString & | arg2 | ||
) |
Add a string and a character.
- Parameters
-
arg1 Character. arg2 String.
const RString R::operator+ | ( | const RString & | arg1, |
char | arg2 | ||
) |
Add a character and a string.
- Parameters
-
arg1 String. arg2 Character.
const RString R::operator+ | ( | const RString & | arg1, |
RChar | arg2 | ||
) |
Add a string and a character.
- Parameters
-
arg1 Character. arg2 String.
D* R::RIncRef | ( | D * | data | ) |
Function the increase the number of references of a RSharedData object.
- Template Parameters
-
D Type of the shared data.
- Parameters
-
data Pointer to the data.
void R::RDecRef | ( | D *& | data | ) |
Function the decrease the number of references of a RSharedData object. If there are no more references, the data is destroy and the pointer is set to 0.
- Template Parameters
-
D Type of the shared data.
- Parameters
-
data Reference to a pointer to the data.
tCoord R::Abs | ( | tCoord | x | ) |
The function returns the absolute value of a coordinate.
int R::CompareIds | ( | size_t | id1, |
size_t | id2 | ||
) |
The function compares two identifiers. Useful for R::RContainer.
- Parameters
-
id1 First identifier. id2 Second identifier.
- Returns
int R::CompareDoubles | ( | double | num1, |
double | num2 | ||
) |
The function compares two doubles. Useful for R::RContainer.
- Parameters
-
num1 First double. num2 Second double.
- Returns
- <0 if num1<num2
- 0 if num1=num2
- >0 if num1>num2
int R::ComparePtrs | ( | C * | ptr1, |
C * | ptr2 | ||
) |
The function compares two pointers. Useful for R::RContainer.
- Template Parameters
-
C Class to compare.
- Parameters
-
ptr1 First pointer. ptr2 Second pointer.
Variable Documentation
RApplication* App |
Pointer to the current application. Only one application can be run at once.
RNotificationCenter NotificationCenter |
Pointer to the current notification center.
QRGUIApplication* GUIApp |
Pointer to the current application. Only one application can be run at once.
const off_t MaxOffT =MAX_INT_VAL(off_t) |
Constant representing the maximum size of off_t variable.
const size_t cNoRef =std::numeric_limits<size_t>::max() |
The cNoRef constant represented an undefined identifier reference.
The cNoCoord constant represent an invalid coordinate. It practice, it is the maximal positive value that a coordinate can have.
The cMaxCoord represent the maximal acceptable value for a coordinate.
The cMinCoord represent the minimal acceptable value for a coordinate.
const double cEpsi =0.000001 |
This variable represents a tolerance for calculations. if a calculation (for example the difference between two coordinates) is less than cEpsi, it is considered as zero.