libgnomedbmm Reference Documentation
Main Page   Namespaces   Book  

Gnome::Db::Editor Class Reference
[ExtrasDbWidgets]

A general purpose SQL editor. More...

Inheritance diagram for Gnome::Db::Editor:

Inheritance graph
[legend]
List of all members.

Public Member Functions

void copy_clipboard ()
 Moves currently selected text in the given editor widget to the clipboard.
void cut_clipboard ()
 Copy currently selected text in the given editor widget to the clipboard.
 Editor ()
Glib::ustring get_all_text () const
 Retrieve the full contents of the given editor widget.
bool get_editable () const
 Retrieve the editable status of the given editor widget.
bool get_highlight () const
 Retrieve the highlighting status of the given editor widget.
const GnomeDbEditor* gobj () const
 Provides access to the underlying C GtkObject.
GnomeDbEditor* gobj ()
 Provides access to the underlying C GtkObject.
bool load_from_file (const std::string& filename)
 Load the given filename into the editor widget.
void paste_clipboard ()
 Paste clipboard contents into editor widget, at the current position.
bool save_to_file (const std::string& filename)
 Save the current editor contents to the given file.
void set_editable (bool editable=true)
 Set the editable state of the given editor widget.
void set_highlight (bool highlight=true)
 Set the highlighting status on the given editor widget.
void set_text (const Glib::ustring& text)
 Set the contents of the given editor widget.
virtual ~Editor ()

Related Functions

(Note that these are not member functions.)

Gnome::Db::Editorwrap (GnomeDbEditor* object, bool take_copy=false)
 
Parameters:
object The C instance


Detailed Description

A general purpose SQL editor.


Constructor & Destructor Documentation

virtual Gnome::Db::Editor::~Editor (  )  [virtual]

Gnome::Db::Editor::Editor (  ) 


Member Function Documentation

void Gnome::Db::Editor::copy_clipboard (  ) 

Moves currently selected text in the given editor widget to the clipboard.

void Gnome::Db::Editor::cut_clipboard (  ) 

Copy currently selected text in the given editor widget to the clipboard.

Glib::ustring Gnome::Db::Editor::get_all_text (  )  const

Retrieve the full contents of the given editor widget.

Returns:
The current contents of the editor buffer. You must free the returned value when no longer needed.

bool Gnome::Db::Editor::get_editable (  )  const

Retrieve the editable status of the given editor widget.

Returns:
The editable status.

bool Gnome::Db::Editor::get_highlight (  )  const

Retrieve the highlighting status of the given editor widget.

Returns:
The highlighting status.

const GnomeDbEditor* Gnome::Db::Editor::gobj (  )  const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::VBox.

GnomeDbEditor* Gnome::Db::Editor::gobj (  )  [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::VBox.

bool Gnome::Db::Editor::load_from_file ( const std::string &  filename  ) 

Load the given filename into the editor widget.

Parameters:
filename The file to be loaded.
Returns:
true if successful, false otherwise.

void Gnome::Db::Editor::paste_clipboard (  ) 

Paste clipboard contents into editor widget, at the current position.

bool Gnome::Db::Editor::save_to_file ( const std::string &  filename  ) 

Save the current editor contents to the given file.

Parameters:
filename The file to save to.
Returns:
true if successful, false otherwise.

void Gnome::Db::Editor::set_editable ( bool  editable = true  ) 

Set the editable state of the given editor widget.

Parameters:
editable Editable state.

void Gnome::Db::Editor::set_highlight ( bool  highlight = true  ) 

Set the highlighting status on the given editor widget.

Parameters:
highlight Highlighting status.

void Gnome::Db::Editor::set_text ( const Glib::ustring text  ) 

Set the contents of the given editor widget.

Parameters:
text Text to display in the editor.


Friends And Related Function Documentation

Gnome::Db::Editor* wrap ( GnomeDbEditor *  object,
bool  take_copy = false 
) [related]

Parameters:
object The C instance

Parameters:
take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.


The documentation for this class was generated from the following file:
Generated for libgnomedbmm by Doxygen 1.5.1 © 1997-2001