Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

add_channel_wizard Class Reference

A wizard for adding a channel. More...

#include <add_channel_wizard.h>

Inheritance diagram for add_channel_wizard:

plucker_wizard_base wxWizard List of all members.

Public Methods

  add_channel_wizard (wxWindow *parent=NULL, int id=-1, const wxString &title=wxEmptyString, const wxBitmap &bitmap=wxNullBitmap, const wxString &cancel_message=_("Abort the add channel wizard?"))
  Constructor.

  ~add_channel_wizard ()
  Destructor.

wxString  get_generated_channel_section ()
  Accessor of the channel section that was created by the wizard.

bool  get_is_channel_dialog_requested ()
  Accessor of whether user asked to open a channel dialog for more editing.


Detailed Description

A wizard for adding a channel.

When the user selects 'Add new channel using wizard' from a menu or toolbar, this wizard will ask questions and add a resulting new channel to the main_listctrl .


Constructor & Destructor Documentation

add_channel_wizard::add_channel_wizard wxWindow *    parent = NULL,
int    id = -1,
const wxString &    title = wxEmptyString,
const wxBitmap &    bitmap = wxNullBitmap,
const wxString &    cancel_message = _("Abort the add channel wizard?")
 

Constructor.

Parameters:
parent  The parent window. May be NULL.
id  The id of the wizard. Will usually be just -1 .
Todo:
SOURCE: Should all the int id's should be WindowIDs instead?
Parameters:
title  The title of the wizard.
bitmap  The default bitmap used in the wizard. May be overriden by a page.
cancel_message  The message that appears when user clicks Cancel button.

Member Function Documentation

wxString add_channel_wizard::get_generated_channel_section  
 

Accessor of the channel section that was created by the wizard.

Returns :
The generated channel section string.
bool add_channel_wizard::get_is_channel_dialog_requested  
 

Accessor of whether user asked to open a channel dialog for more editing.

Returns :
TRUE if user wants to open a channel dialog after wizard closes.