tora Globals

# tora Globals |
Annotated List
Files
Globals
Hierarchy
Index

### toconnection.h

- typedef toQuery::queryDescribe toQDescribe
- typedef std::list toQDescList

### tomain.h

- toMain * toMainWidget (void)

### toqvalue.h

- typedef std::list toQList

### toreport.h

- QString toGenerateReport (toConnection &conn,std::list<QString> &desc)

### utils.h

- void toStatusMessage (const QString &str,bool save=false,bool log=true)
- QString toSQLToAddress (toConnection &conn,const QString &sql)
- QString toSQLString (toConnection &conn,const QString &address)
- void toReadableColumn (QString &col)
- QString toNow (toConnection &conn)
- void toSetSessionType (const QString &str)
- QString toGetSessionType (void)
- QStringList toGetSessionTypes (void)
- QComboBox * toRefreshCreate (QWidget *parent,const char *name=NULL,const QString &def=QString::null, QComboBox *item=NULL)
- void toRefreshParse (toTimer *timer,const QString &str=QString::null)
- bool toMonolithic (void)
- QString toDeepCopy (const QString &str)
- QToolBar * toAllocBar (QWidget *parent,const QString &name)
- TODock * toAllocDock (const QString &name, const QString &db, const QPixmap &icon)
- void toAttachDock (TODock *dock,QWidget *container,QMainWindow::ToolBarDock place)
- int toSizeDecode (const QString &str)
- QKeySequence toKeySequence (const QString &keysequence)
- bool toCheckKeyEvent (QKeyEvent *event,const QKeySequence &key)
- template T toShift (std::list &lst)
- template void toUnShift (std::list &lst,const T &str)
- template T toPop (std::list &lst)
- template void toPush (std::list &lst,const T &str)
- QFont toStringToFont (const QString &str)
- QString toFontToString (const QFont &fnt)
- QString toHelpPath (void)
- QCString toReadFile (const QString &filename)
- bool toWriteFile (const QString &filename,const QCString &data)
- bool toWriteFile (const QString &filename,const QString &data)
- bool toCompareLists (QStringList &l1,QStringList &l2,unsigned int len)
- void toSetEnv (const QCString &var,const QCString &val)
- void toUnSetEnv (const QCString &var)
- QString toOpenFilename (const QString &filename,const QString &filter,QWidget *parent)
- QString toSaveFilename (const QString &filename,const QString &filter,QWidget *parent)
- int toToolMenuIndex (void)
- inline bool toIsIdent (QChar c)
- QString toPluginPath (void)
- std::list<QString> toStatusMessages (void)
- QBrush toChartBrush (int index)
- toConnection & toCurrentConnection (QObject *widget)
- toToolWidget * toCurrentTool (QObject *widget)
- bool toIsOracle (const toConnection &)
- bool toIsSapDB (const toConnection &)
- bool toIsMySQL (const toConnection &)
- bool toIsPostgreSQL (const toConnection &)
- QString toSQLStripSpecifier (const QString &sql)
- QString toSQLStripBind (const QString &sql)
- QString toExpandFile (const QString &file)
- toQValue toUnnull (const toQValue &str)
- toQValue toNull (const toQValue &str)
- QString toObfuscate (const QString &str)
- QString toUnobfuscate (const QString &str)
- bool toCheckModal (QWidget *widget)
- void toMapExport (std::map<QCString,QString> &data,const QCString &prefix, std::map<QCString,QString> &src)
- void toMapImport (std::map<QCString,QString> &data,const QCString &prefix, std::map<QCString,QString> &dst)
- QListViewItem * toFindItem (QListView *list,const QString &str)
- void toToolCaption (toToolWidget *tool,const QString &caption)
- QString toTranslateMayby (const QString &context,const QString &text)
- template T max (T a, T b)
- template T min (T a, T b)

## Global member Documentation

typedef toQuery::queryDescribe toQDescribe | ### toQDescribe

`#include <toconnection.h>`

A short representation of a toQuery::queryDescribe

typedef std::list<toQDescribe> toQDescList | ### toQDescList

`#include <toconnection.h>`

A short representation of list

toMain * toMainWidget (void) | ### toMainWidget

`#include <tomain.h>`

Get a pointer to the main window

Returns: Pointer to main window.

typedef std::list<toQValue> toQList | ### toQList

`#include <toqvalue.h>`

A short representation of list

QString toGenerateReport (toConnection &conn,std::list<QString> &desc) | ### toGenerateReport

`#include <toreport.h>`

Generate an HTML based report on a description of database objects from toExtract.

Parameters:

conn | Connection description list was generated from.
desc | Description list to create report on.

Returns: An HTML formatted report on the contents of desc.

void toStatusMessage (const QString &str,bool save=false,bool log=true) | ### toStatusMessage

`#include <utils.h>`

Display a message in the statusbar of the main window.

Parameters:

str | Message to display
save | If true don't remove the message after a specified interval.
log | Log message. Will never log saved messages.

QString toSQLToAddress (toConnection &conn,const QString &sql) | ### toSQLToAddress

`#include <utils.h>`

Get an address to a SQL statement in the SGA. The address has the form 'address:hash_value' which are resolved from the v$sqltext_with_newlines view in Oracle.

Parameters:

conn | Connection to get address from
sql | Statement to get address for.

Returns: String with address in.

Throws: QString, if, address, not, found.

QString toSQLString (toConnection &conn,const QString &address) | ### toSQLString

`#include <utils.h>`

Get the full SQL of an address (See toSQLToAddress) from the SGA.

Parameters:

conn | Connection to get address from
sql | Address of SQL.

Returns: String with SQL of statement.

Throws: QString, if, address, not, found.

void toReadableColumn (QString &col) | ### toReadableColumn

`#include <utils.h>`

Make a column name more readable.

Parameters:

col | Name of column name, will be modified.

QString toNow (toConnection &conn) | ### toNow

`#include <utils.h>`

Get the current database time in the current sessions dateformat.

Parameters:

conn | Connection to get address from.

Returns: String with the current date and time.

void toSetSessionType (const QString &str) | ### toSetSessionType

`#include <utils.h>`

Set the current session type (Style)

Parameters:

str | Session to set, can be any of Motif, Motif Plus, SGI, CDE, Windows and Platinum

Throws: QString, if, style, not, available.

QString toGetSessionType (void) | ### toGetSessionType

`#include <utils.h>`

Get current session type (Style)

Returns: A string describing the current style.

See also: toSetSessionType

QStringList toGetSessionTypes (void) | ### toGetSessionTypes

`#include <utils.h>`

Get the available styles.

QComboBox * toRefreshCreate (QWidget *parent,const char *name=NULL,const QString &def=QString::null, QComboBox *item=NULL) | ### toRefreshCreate

`#include <utils.h>`

Create or fill a combobox with refresh intervals.

Parameters:

parent | Parent of created combobox.
name | Name of created combobox.
def | Default value of the combobox.
item | Combo box to fill. If not specified a new combobox is created.

void toRefreshParse (toTimer *timer,const QString &str=QString::null) | ### toRefreshParse

`#include <utils.h>`

Set a timer with the value from a refresh combobox (See toRefreshCreate).

Parameters:

timer | Timer to set timeout in.
str | String from currentText of combobox. If empty, set to default.

bool toMonolithic (void) | ### toMonolithic

`#include <utils.h>`

Get information about wether this TOra has plugin support or not.

Returns: True if plugin support is enabled.

QString toDeepCopy (const QString &str) | ### toDeepCopy

`#include <utils.h>`

Make a deep copy of a string. Usefull when sharing copying strings between threads.

Parameters:

str | String to copy

Returns: Copied string.

QToolBar * toAllocBar (QWidget *parent,const QString &name) | ### toAllocBar

`#include <utils.h>`

Allocate a toolbar. This is needed since Qt and KDE use different toolbars.

Parameters:

parent | Parent of toolbar.
name | Name of toolbar.

Returns: A newly created toolbar.

TODock * toAllocDock (const QString &name, const QString &db, const QPixmap &icon) | ### toAllocDock

`#include <utils.h>`

Allocate a new docked window. This is needed since Qt and KDE docks windows differently (Qt 2.x doesn't even have support for docked windows). Observe that you must attach a dock using toAttachDock after allocating it.

Parameters:

name | Name of window.
db | Database name or empty if N/A.
icon | Icon of new dock.

Returns: A newly allocated fock.

void toAttachDock (TODock *dock,QWidget *container,QMainWindow::ToolBarDock place) | ### toAttachDock

`#include <utils.h>`

Attach a dock to a specified position.

Parameters:

dock | Dock to attach
container | Whatever container is supposed to be in the dock window.
place | Where to place the dock.

int toSizeDecode (const QString &str) | ### toSizeDecode

`#include <utils.h>`

Decode a size string this basically converts "KB" to 1024, "MB" to 1024KB and everything else to 1.

Returns: Multiplier specified by string.

QKeySequence toKeySequence (const QString &keysequence) | ### toKeySequence

`#include <utils.h>`

Check that a key sequence is valid and return same sequence

bool toCheckKeyEvent (QKeyEvent *event,const QKeySequence &key) | ### toCheckKeyEvent

`#include <utils.h>`

Check if a key sequence and a key event represent the same key and return if that is the case. Only support single key keysequences.

Parameters:

event | Key event.
key | Key sequence.

template T toShift (std::list &lst) | ### toShift

`#include <utils.h>`

Shift the first value out of a list.

Parameters:

lst | List to shift value from (Also modified).

Returns: The first value in the list.

template void toUnShift (std::list &lst,const T &str) | ### toUnShift

`#include <utils.h>`

Push an object to the beginning of a list.

Parameters:

lst | List to push value in from of.
str | Object to push.

template T toPop (std::list &lst) | ### toPop

`#include <utils.h>`

Pop the last value out of a list.

Parameters:

lst | List to pop value from (Also modified).

Returns: The value in the list of objects.

template void toPush (std::list &lst,const T &str) | ### toPush

`#include <utils.h>`

Push an object to the end of a list.

Parameters:

lst | List to push value in from of.
str | Object to push.

QFont toStringToFont (const QString &str) | ### toStringToFont

`#include <utils.h>`

Convert a string representation to a font structure.

Parameters:

str | String representing the font.

Returns: Font structure represented by the string.

See also: toFontToString

QString toFontToString (const QFont &fnt) | ### toFontToString

`#include <utils.h>`

Convert a font to a string representation.

Parameters:

fnt | Font to convert.

Returns: String representation of font.

QString toHelpPath (void) | ### toHelpPath

`#include <utils.h>`

Get the path to the help directory.

Returns: Path to the help directory.

QCString toReadFile (const QString &filename) | ### toReadFile

`#include <utils.h>`

Read file from filename.

Parameters:

filename | Filename to read file from.

Returns: Contents of file.

Throws: QString, describing, I/O, problem.

bool toWriteFile (const QString &filename,const QCString &data) | ### toWriteFile

`#include <utils.h>`

Write file to filename.

Parameters:

filename | Filename to write file to.
data | Data to write to file.

bool toWriteFile (const QString &filename,const QString &data) | ### toWriteFile

`#include <utils.h>`

Write file to filename.

Parameters:

filename | Filename to write file to.
data | Data to write to file.

bool toCompareLists (QStringList &l1,QStringList &l2,unsigned int len) | ### toCompareLists

`#include <utils.h>`

Compare two string lists.

Parameters:

l1 | First list to compare.
l2 | Second list to compare.
len | Length of lists to compare.

Returns: True if all first len elements match.

void toSetEnv (const QCString &var,const QCString &val) | ### toSetEnv

`#include <utils.h>`

Set environment variable.

Parameters:

var | Variable name to set.
val | Value to set variable to.

void toUnSetEnv (const QCString &var) | ### toUnSetEnv

`#include <utils.h>`

Delete an environment variable.

Parameters:

var | Environment variable to delete.

QString toOpenFilename (const QString &filename,const QString &filter,QWidget *parent) | ### toOpenFilename

`#include <utils.h>`

Pop up a dialog and choose a file to open.

Parameters:

filename | Default filename to open.
filter | Filter of filenames (See QFileDialog)
parent | Parent of dialog.

Returns: Selected filename.

QString toSaveFilename (const QString &filename,const QString &filter,QWidget *parent) | ### toSaveFilename

`#include <utils.h>`

Pop up a dialog and choose a file to save to.

Parameters:

filename | Default filename to open.
filter | Filter of filenames (See QFileDialog)
parent | Parent of dialog.

Returns: Selected filename.

int toToolMenuIndex (void) | ### toToolMenuIndex

`#include <utils.h>`

Get index of menu to insert tool specific menu at.

Returns: Index of the tool menu entry.

inline bool toIsIdent (QChar c) | ### toIsIdent

`#include <utils.h>`

Check if a character is valid for an identifier in Oracle.

Parameters:

c | Character to check

Returns: True if it is a valid Oracle identifier.

QString toPluginPath (void) | ### toPluginPath

`#include <utils.h>`

Get installation directory of application (Plugin directory on unix, installation target on windows).

Returns: String containing directory

std::list<QString> toStatusMessages (void) | ### toStatusMessages

`#include <utils.h>`

Get a list of the latest status messages that have been shown.

QBrush toChartBrush (int index) | ### toChartBrush

`#include <utils.h>`

Get a brush for a chart item.

Parameters:

index | Indicating which chart item to get color for.

toConnection & toCurrentConnection (QObject *widget) | ### toCurrentConnection

`#include <utils.h>`

Return the connection most closely associated with a widget. Currently connections are only stored in toToolWidgets.

Returns: Reference toConnection object closest to the current.

toToolWidget * toCurrentTool (QObject *widget) | ### toCurrentTool

`#include <utils.h>`

Return the tool widget most closely associated with a widget.

Returns: Pointer to tool widget.

bool toIsOracle (const toConnection &) | ### toIsOracle

`#include <utils.h>`

Check if this connection is an oracle connection.

bool toIsSapDB (const toConnection &) | ### toIsSapDB

`#include <utils.h>`

Check if this connection is an sapdb connection.

bool toIsMySQL (const toConnection &) | ### toIsMySQL

`#include <utils.h>`

Check if this connection is an MySQL connection.

bool toIsPostgreSQL (const toConnection &) | ### toIsPostgreSQL

`#include <utils.h>`

Check if this connection is an PostgreSQL connection.

QString toSQLStripSpecifier (const QString &sql) | ### toSQLStripSpecifier

`#include <utils.h>`

Strip extra bind specifier from an SQL statement. (That means the extra <***> part after the bind variable.

Parameters:

sql | The sql to strip.

Returns: Return a string containing the same statement without qualifiers, which means the sql sent to Oracle and available in the SGA.

QString toSQLStripBind (const QString &sql) | ### toSQLStripBind

`#include <utils.h>`

Strip extra binds and replace with empty strings.

Parameters:

sql | The sql to strip.

Returns: Return a string containing the same statement without binds.

QString toExpandFile (const QString &file) | ### toExpandFile

`#include <utils.h>`

Expand filename with $HOME to be replaced with home directory or my documents.

toQValue toUnnull (const toQValue &str) | ### toUnnull

`#include <utils.h>`

Convert string read by readValue to value read by readValueNull

toQValue toNull (const toQValue &str) | ### toNull

`#include <utils.h>`

Convert string read by readValueNull to value to be read by readValue.

QString toObfuscate (const QString &str) | ### toObfuscate

`#include <utils.h>`

Take a string and make it illegible. Some security through obscurity here so you will need to check the source to see what is actually done.

Parameters:

str | String to be made unreadable.

Returns: Obfuscated string.

QString toUnobfuscate (const QString &str) | ### toUnobfuscate

`#include <utils.h>`

Unmake the actions of toObfuscate.

Parameters:

Obfuscated | string.

Returns: Original string.

bool toCheckModal (QWidget *widget) | ### toCheckModal

`#include <utils.h>`

Check if the current widget is within the active modal widget (Or no modal widget exists)

void toMapExport (std::map<QCString,QString> &data,const QCString &prefix, std::map<QCString,QString> &src) | ### toMapExport

`#include <utils.h>`

Export the contents of a map into another map.

Parameters:

data | The destination map.
prefix | Prefix to save map using.
src | The map to save.

void toMapImport (std::map<QCString,QString> &data,const QCString &prefix, std::map<QCString,QString> &dst) | ### toMapImport

`#include <utils.h>`

Import the contents of a map from another map.

Parameters:

data | The source map.
prefix | Prefix to use for restoring from map.
dst | The map to save into.

QListViewItem * toFindItem (QListView *list,const QString &str) | ### toFindItem

`#include <utils.h>`

Find an item in a listview.

Parameters:

list | The list to search for the item.
str | The string to search for. You can specify parent/child with : in the string.

void toToolCaption (toToolWidget *tool,const QString &caption) | ### toToolCaption

`#include <utils.h>`

Set or change title of a tool window.

Parameters:

tool | Widget of tool.
caption | Caption to set to the tool.

QString toTranslateMayby (const QString &context,const QString &text) | ### toTranslateMayby

`#include <utils.h>`

Translate string if the context and text is strictly ASCII7 and the context doesn't contain any spaces. Otherwise just return the text.

Parameters:

context | The context of the text.
text | The text to translate.

Returns: Translated text if appropriate, or original text otherwise.

template T max (T a, T b) | ### max

`#include <utils.h>`

Get maximum number of a and b.

template T min (T a, T b) | ### min

`#include <utils.h>`

Get minimum number of a and b.

Generated by: nneul on skyhawk on Wed Feb 23 19:49:58 2005, using kdoc 2.0a54.