libgnomedbmm Reference Documentation
Main Page   Namespaces   Book  

Gnome::Db::Selector Class Reference
[Extras]

Individual selection of objects (data types, functions, . More...

Inheritance diagram for Gnome::Db::Selector:

Inheritance graph
[legend]
List of all members.

Public Member Functions

void collapse_all ()
 Recursively collapse all nodes in the mgsel widget.
void expand_all ()
 Recursively expands all nodes in the mgsel widget.
Glib::RefPtr<const Glib::Objectget_selected_object () const
 Get the currently selected object.
Glib::RefPtr<Glib::Objectget_selected_object ()
 Get the currently selected object.
Glib::RefPtr<const Glib::Objectget_selected_object_parent () const
 FIXME.
Glib::RefPtr<Glib::Objectget_selected_object_parent ()
 FIXME.
const GnomeDbSelector* gobj () const
 Provides access to the underlying C GtkObject.
GnomeDbSelector* gobj ()
 Provides access to the underlying C GtkObject.
 Selector (const Glib::RefPtr<Gda::Dict>& dict, SelectorMode mode, SelectorColumn columns)
 Creates a new Selector widget.
 Selector (const Glib::RefPtr<Gda::Dict>& dict, const Glib::RefPtr<Glib::Object>& ref_obj, SelectorMode mode, SelectorColumn columns)
void set_column_label (guint column, const Glib::ustring& label)
 Sets the label of a column's header.
void set_headers_visible (bool visible=true)
 Show or hide the headers.
void set_mode_columns (SelectorMode mode, SelectorColumn columns)
 Changes what data gets displayed in the widget and which columns are displayed.
void set_mode_columns (const Glib::RefPtr<Glib::Object>& ref_object, SelectorMode mode, SelectorColumn columns)
 Changes what data gets displayed in mgsel and which columns are displayed.
bool set_selected_object (const Glib::RefPtr<Glib::Object>& selection)
 Force the widget to select a given object, and to display it in its visible area (unfolding nodes on the way if necessary).
Glib::SignalProxy1< void,
const Glib::RefPtr<Glib::Object >&> 
signal_row_activated ()
 
Prototype:
void row_activated(const Glib::RefPtr<Glib::Object>& ref_obj)

Glib::SignalProxy1< void,
const Glib::RefPtr<Glib::Object >&> 
signal_selection_changed ()
 
Prototype:
void selection_changed(const Glib::RefPtr<Glib::Object>& ref_obj)

virtual ~Selector ()

Protected Member Functions

virtual void on_row_activated (const Glib::RefPtr<Glib::Object>& ref_obj)
virtual void on_selection_changed (const Glib::RefPtr<Glib::Object>& ref_obj)

Related Functions

(Note that these are not member functions.)

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


Detailed Description

Individual selection of objects (data types, functions, .

..).

This widget presents the user with a (configurable) list of objects to choose from: Data types, functions, aggregates, ...

What really gets displayed in the widget (columns and rows) depends on the parameters passed to the constructor.


Constructor & Destructor Documentation

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

Gnome::Db::Selector::Selector ( const Glib::RefPtr< Gda::Dict > &  dict,
const Glib::RefPtr< Glib::Object > &  ref_obj,
SelectorMode  mode,
SelectorColumn  columns 
) [explicit]

Gnome::Db::Selector::Selector ( const Glib::RefPtr< Gda::Dict > &  dict,
SelectorMode  mode,
SelectorColumn  columns 
)

Creates a new Selector widget.

This version of the method may not be used if implies a list where the displayed items depend on a specific object, namely SELECTOR_FIELDS (when not used in conjunction with SELECTOR_TABLES), SELECTOR_TARGETS, SELECTOR_JOINS, SELECTOR_QVIS_FIELDS, SELECTOR_QALL_FIELDS and SELECTOR_SUB_QUERIES (when not used in conjunction with SELECTOR_QUERIES).

Parameters:
dict A Dict object.
mode An OR'ed value of the possible items to display in the widget.
columns An OR'ed value describing which columns will be displayed.


Member Function Documentation

void Gnome::Db::Selector::collapse_all (  ) 

Recursively collapse all nodes in the mgsel widget.

void Gnome::Db::Selector::expand_all (  ) 

Recursively expands all nodes in the mgsel widget.

Glib::RefPtr<const Glib::Object> Gnome::Db::Selector::get_selected_object (  )  const

Get the currently selected object.

Returns:
The selected object or 0 if nothing is selected or the current selection is on a "category" of objects (such as the "Functions" category for example).

Glib::RefPtr<Glib::Object> Gnome::Db::Selector::get_selected_object (  ) 

Get the currently selected object.

Returns:
The selected object or 0 if nothing is selected or the current selection is on a "category" of objects (such as the "Functions" category for example).

Glib::RefPtr<const Glib::Object> Gnome::Db::Selector::get_selected_object_parent (  )  const

FIXME.

Glib::RefPtr<Glib::Object> Gnome::Db::Selector::get_selected_object_parent (  ) 

FIXME.

const GnomeDbSelector* Gnome::Db::Selector::gobj (  )  const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::VBox.

GnomeDbSelector* Gnome::Db::Selector::gobj (  )  [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::VBox.

virtual void Gnome::Db::Selector::on_row_activated ( const Glib::RefPtr< Glib::Object > &  ref_obj  )  [protected, virtual]

virtual void Gnome::Db::Selector::on_selection_changed ( const Glib::RefPtr< Glib::Object > &  ref_obj  )  [protected, virtual]

void Gnome::Db::Selector::set_column_label ( guint  column,
const Glib::ustring label 
)

Sets the label of a column's header.

void Gnome::Db::Selector::set_headers_visible ( bool  visible = true  ) 

Show or hide the headers.

void Gnome::Db::Selector::set_mode_columns ( SelectorMode  mode,
SelectorColumn  columns 
)

Changes what data gets displayed in the widget and which columns are displayed.

The parameters have the same meaning as for the constructors.

Parameters:
mode An OR'ed value of the possible items to display in the widget.
columns An OR'ed value describing which columns will be displayed.

void Gnome::Db::Selector::set_mode_columns ( const Glib::RefPtr< Glib::Object > &  ref_object,
SelectorMode  mode,
SelectorColumn  columns 
)

Changes what data gets displayed in mgsel and which columns are displayed.

The mode and columns have the same meaning as for the gnome_db_selector_new() function.

The usage of the ref_object parameter is the same as for gnome_db_selector_new().

Parameters:
ref_object A G::Object, or 0.
mode An OR'ed value of the possible items to display in the widget.
columns An OR'ed value describing which columns will be displayed.

bool Gnome::Db::Selector::set_selected_object ( const Glib::RefPtr< Glib::Object > &  selection  ) 

Force the widget to select a given object, and to display it in its visible area (unfolding nodes on the way if necessary).

Returns:
true if the specified object was found, and false otherwise.

Glib::SignalProxy1< void,const Glib::RefPtr<Glib::Object>& > Gnome::Db::Selector::signal_row_activated (  ) 

Prototype:
void row_activated(const Glib::RefPtr<Glib::Object>& ref_obj)

Glib::SignalProxy1< void,const Glib::RefPtr<Glib::Object>& > Gnome::Db::Selector::signal_selection_changed (  ) 

Prototype:
void selection_changed(const Glib::RefPtr<Glib::Object>& ref_obj)


Friends And Related Function Documentation

Gnome::Db::Selector* wrap ( GnomeDbSelector *  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