---

wxHandheldInstallCtrl Class Reference

A control to allow install to Palm handheld usernames or directories. More...

#include <hhictrl.h>

List of all members.

Public Methods
	wxHandheldInstallCtrl (wxWindow *parent, wxWindowID id, const wxString &users_message=_("Install files to these handhelds"), const wxString &directories_message=_("Install files to these directories"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, const wxString &name=wxT("handheldInstallCtrl"))
	Constructor.
	wxHandheldInstallCtrl ()
	~wxHandheldInstallCtrl ()
	Destructor.
void	SetImageList (wxImageList *imageList)
	Optionally, set a wxImageList to be used by the 2 listctrls in the object.
void	SetUsersImageListImageId (int imageId)
	Set a specific icon index in the image list to use for the m_usersListCtrl.
void	InsertUserDestinations (handheld_dest_array_type &handheld_dest_array)
	Load the m_usersListCtrl with users.
void	GetUserDestinations (handheld_dest_array_type &handheld_dest_array)
	Get the array of handheld user destinations from the m_usersListCtrl.
void	SetDirectoriesImageListImageId (int imageId)
	Set a specific icon index in the image list to use for the m_usersListCtrl.
void	InsertDirectoryDestinations (wxArrayString &directories)
	Load the m_directoriesListCtrl with users.
void	GetDirectoryDestinations (wxArrayString &directoryDestinations)
	Get the array of directory destinations from the m_directoriesListCtrl.
bool	InstallFilesToDestinations (wxArrayString &install_fullnames)
	Install a list of files to the user and directory destinations.
bool	IsAllDestinationsEmpty ()
	Check to see if there are no destinations in either control.
Protected Methods
void	OnRemoveButtons (wxCommandEvent &event)
void	OnUpdateUiUsersListCtrl (wxUpdateUIEvent &event)
void	OnUsersAddButton ()
void	OnUpdateUiDirectoriesListCtrl (wxUpdateUIEvent &event)
void	OnDirectoriesAddButton ()
Protected Attributes
palm_installer *	m_palmInstaller
pda_listctrl *	m_usersListCtrl
int	m_usersListCtrlImageId
wxButton *	m_usersAddButton
wxButton *	m_usersRemoveButton
wxListCtrl *	m_directoriesListCtrl
int	m_directoriesListCtrlImageId
wxButton *	m_directoriesAddButton
wxButton *	m_directoriesRemoveButton

---

Detailed Description

A control to allow install to Palm handheld usernames or directories.

There are two listctrls one, one for handheld destinations, one for directory desinations. Buttons to the left of each listctrl allow entries to be added or deleted.

The choices for handheld destinations are populated via a palm_installer .

---

Constructor & Destructor Documentation

wxHandheldInstallCtrl::wxHandheldInstallCtrl (  wxWindow *    parent, wxWindowID    id, const wxString &    users_message = _("Install files to these handhelds"), const wxString &    directories_message = _("Install files to these directories"), const wxPoint &    pos = wxDefaultPosition, const wxSize &    size = wxDefaultSize, const wxString &    name = wxT("handheldInstallCtrl") )

Constructor. Parameters: parent  The parent window. May be NULL. id  The id of the control. users_message  Message that appears at the top of the m_usersListCtrl. directories_message  Message that appears at the top of the m_directoriesListCtrl. pos  The pixel position of the listctrl on its parent window size  The pixel size of the listctrl name  Windows name (rarely used).

---

Member Function Documentation

void wxHandheldInstallCtrl::GetDirectoryDestinations (  wxArrayString &    directoryDestinations )

Get the array of directory destinations from the m_directoriesListCtrl. Parameters: directoryDestinations  An array to hold the directory destinations.

void wxHandheldInstallCtrl::GetUserDestinations (  handheld_dest_array_type &    handheld_dest_array )

Get the array of handheld user destinations from the m_usersListCtrl. Parameters: handheld_dest_array  An array to hold the handheld user destinations.

void wxHandheldInstallCtrl::InsertDirectoryDestinations (  wxArrayString &    directories )

Load the m_directoriesListCtrl with users. Parameters: directories  An array of directory destinations to be loaded.

void wxHandheldInstallCtrl::InsertUserDestinations (  handheld_dest_array_type &    handheld_dest_array )

Load the m_usersListCtrl with users. Parameters: handheld_dest_array  An array of handheld user destinations to be loaded.

bool wxHandheldInstallCtrl::InstallFilesToDestinations (  wxArrayString &    install_fullnames )

Install a list of files to the user and directory destinations. Uses a palm_installer for its work. Returns : TRUE if there was no problems with the installation.

bool wxHandheldInstallCtrl::IsAllDestinationsEmpty (    )

Check to see if there are no destinations in either control. This is a convenience function to do quickly check that there are no destinations, and do some behaviour to say, remind the user to add one. For example, see destinations_wizardpage::on_wizardpage_changing() . Returns : TRUE if neither the m_usersListCtrl and m_directoriesListCtrl have an entry.

void wxHandheldInstallCtrl::SetImageList (  wxImageList *    imageList )

Optionally, set a wxImageList to be used by the 2 listctrls in the object. This will make icons appear in the listctrls, use the SetUsersImageListImageId() SetDirectoriesImageListImageId() to get the ones that you want. param imageList The wxImageList object to use