Public Member Functions

db_query_QueryBuffer Class Reference

a proxy to a SQL script editor buffer. More...

#include <structs.db.query.h>

Inheritance diagram for db_query_QueryBuffer:
GrtObject

List of all members.

Public Member Functions

grt::StringRef script () const
 Getter for attribute script (read-only).
grt::StringRef selectedText () const
 Getter for attribute selectedText (read-only).
grt::IntegerRef selectionEnd () const
 Getter for attribute selectionEnd.
virtual void selectionEnd (const grt::IntegerRef &value)
 Setter for attribute selectionEnd.
grt::IntegerRef selectionStart () const
 Getter for attribute selectionStart.
virtual void selectionStart (const grt::IntegerRef &value)
 Setter for attribute selectionStart.
virtual grt::IntegerRef replaceContents (const std::string &text)
 replace the contents of the query buffer with the provided text
virtual grt::IntegerRef replaceSelection (const std::string &text)
 replace the currently selected text with the provided one, also selecting it

Detailed Description

a proxy to a SQL script editor buffer.


This object cannot be instantiated directly.


Member Function Documentation

virtual grt::IntegerRef replaceContents ( const std::string &  text  )  [virtual]

replace the contents of the query buffer with the provided text

Parameters:
text 
Returns:
virtual grt::IntegerRef replaceSelection ( const std::string &  text  )  [virtual]

replace the currently selected text with the provided one, also selecting it

Parameters:
text 
Returns:
grt::StringRef script (  )  const

Getter for attribute script (read-only).

full contents of the script editor buffer

In Python:
value = obj.script
grt::StringRef selectedText (  )  const

Getter for attribute selectedText (read-only).

selected text

In Python:
value = obj.selectedText
grt::IntegerRef selectionEnd (  )  const

Getter for attribute selectionEnd.

ending index of text selection

In Python:
value = obj.selectionEnd
virtual void selectionEnd ( const grt::IntegerRef &  value  )  [virtual]

Setter for attribute selectionEnd.

ending index of text selection

In Python:
obj.selectionEnd = value
virtual void selectionStart ( const grt::IntegerRef &  value  )  [virtual]

Setter for attribute selectionStart.

starting index of text selection

In Python:
obj.selectionStart = value
grt::IntegerRef selectionStart (  )  const

Getter for attribute selectionStart.

starting index of text selection

In Python:
value = obj.selectionStart