Maeomm Reference Documentation: hildonsmm
Main Page   Namespaces   Book  

Hildon::Note Class Reference

Inheritance diagram for Hildon::Note:

Gtk::Dialog Gtk::Window Gtk::Bin Gtk::Container Gtk::Widget Gtk::Object Atk::Implementor Glib::Object Glib::Interface Glib::ObjectBase Glib::ObjectBase sigc::trackable sigc::trackable List of all members.

Detailed Description

Notes are used to for confirmation (OK/Cancel/etc.

) from the user. A simple note contains information text and an OK button to be clicked. Additional features such as progress bars or animation can also be included.


Public Member Functions

const HildonNote* gobj () const
 Provides access to the underlying C GtkObject.
HildonNote* gobj ()
 Provides access to the underlying C GtkObject.
 Note (const Glib::ustring& description, const Gtk::StockID& stock_id, const Gtk::ProgressBar& progress_bar)
 Note (NoteType note_type, const Glib::ustring& description=Glib::ustring(), const Gtk::StockID& stock_id=Gtk::StockID())
 Note (NoteType note_type, Gtk::Window& parent, const Glib::ustring& description=Glib::ustring(), const Gtk::StockID& stock_id=Gtk::StockID())
 Note (const Glib::ustring& description, const Gtk::StockID& stock_id=Gtk::StockID())
 Note (Gtk::Window& parent, const Glib::ustring& description, const Glib::ustring& icon_name)
 Note (Gtk::Window& parent, const Glib::ustring& description)
 Note ()
void set_button_text (const Glib::ustring& textOk, const Glib::ustring& textCancel)
 Sets the button texts to be used by this hildon_note widget.
void set_button_text (const Glib::ustring& text)
 Sets the button text to be used by the hildon_note widget.
virtual ~Note ()

Related Functions

(Note that these are not member functions.)

Hildon::Notewrap (HildonNote* object, bool take_copy=false)
 
Parameters:
object The C instance


Constructor & Destructor Documentation

virtual Hildon::Note::~Note (  )  [virtual]

Hildon::Note::Note (  ) 

Hildon::Note::Note ( Gtk::Window parent,
const Glib::ustring description 
) [explicit]

Hildon::Note::Note ( Gtk::Window parent,
const Glib::ustring description,
const Glib::ustring icon_name 
) [explicit]

Hildon::Note::Note ( const Glib::ustring description,
const Gtk::StockID stock_id = Gtk::StockID() 
) [explicit]

Hildon::Note::Note ( NoteType  note_type,
Gtk::Window parent,
const Glib::ustring description = Glib::ustring(),
const Gtk::StockID stock_id = Gtk::StockID() 
)

Hildon::Note::Note ( NoteType  note_type,
const Glib::ustring description = Glib::ustring(),
const Gtk::StockID stock_id = Gtk::StockID() 
) [explicit]

Hildon::Note::Note ( const Glib::ustring description,
const Gtk::StockID stock_id,
const Gtk::ProgressBar progress_bar 
)


Member Function Documentation

const HildonNote* Hildon::Note::gobj (  )  const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Dialog.

HildonNote* Hildon::Note::gobj (  )  [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Dialog.

void Hildon::Note::set_button_text ( const Glib::ustring textOk,
const Glib::ustring textCancel 
)

Sets the button texts to be used by this hildon_note widget.

Parameters:
textOk The new text of the default OK button.
textCancel The new text of the default cancel button.

void Hildon::Note::set_button_text ( const Glib::ustring text  ) 

Sets the button text to be used by the hildon_note widget.

Parameters:
text Sets the button text and if there is two buttons in dialog, the button texts will be <text>, "Cancel".


Friends And Related Function Documentation

Hildon::Note* wrap ( HildonNote *  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 hildonmm by Doxygen 1.5.1 © 1997-2001