git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
	2	%% Name: fileevt.tex
	3	%% Purpose: wxFileCtrlEvent documentation
	4	%% Author: Diaa M. Sami
	5	%% Created: 2007-07-25
	6	%% RCS-ID: $Id: $
	7	%% Copyright: (c) 2007 Diaa M. Sami
	8	%% License: wxWindows license
	9	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
	10
	11	\section{\class{wxFileCtrlEvent}}\label{wxfilectrlevent}
	12
	13	A file control event holds information about events associated with
	14	\helpref{wxFileCtrl}{wxfilectrl} objects.
	15
	16	\wxheading{Derived from}
	17
	18	\helpref{wxCommandEvent}{wxcommandevent}\\
	19	\helpref{wxEvent}{wxevent}\\
	20	\helpref{wxObject}{wxobject}
	21
	22	\wxheading{Include files}
	23
	24	<wx/filectrl.h>
	25
	26	\wxheading{Event table macros}
	27
	28	To process input from a file control, use these event handler macros to direct input to member
	29	functions that take a wxFileCtrlEvent argument.
	30
	31	\twocolwidtha{7cm}
	32	\begin{twocollist}\itemsep=0pt
	33	\twocolitem{{\bf EVT\_FILECTRL\_FILEACTIVATED(id, func)}}{The user activated a file(by double-clicking or pressing Enter)}
	34	\twocolitem{{\bf EVT\_FILECTRL\_SELECTIONCHANGED(id, func)}}{The user changed the current selection(by selecting or deselecting a file)}
	35	\twocolitem{{\bf EVT\_FILECTRL\_FOLDERCHANGED(id, func)}}{The current folder of the file control has been changed}
	36	\end{twocollist}%
	37
	38	\latexignore{\rtfignore{\wxheading{Members}}}
	39
	40	\membersection{wxFileCtrlEvent::wxFileCtrlEvent}\label{wxfilectrleventctor}
	41
	42	\func{}{wxFileCtrlEvent}{\param{wxEventType }{type}, \param{wxObject }{evtObject}, \param{int }{id}}
	43
	44	Constructor.
	45
	46	\membersection{wxFileCtrlEvent::GetFiles}\label{wxfilectrleventgetfiles}
	47
	48	\constfunc{wxArrayString}{GetFiles}{\void}
	49
	50	Returns the files selected.
	51	In case of a {\bf EVT\_FILECTRL\_SELECTIONCHANGED}, this method returns the
	52	files selected after the event.
	53
	54	\membersection{wxFileCtrlEvent::GetDirectory}\label{wxfilectrleventgetdirectory}
	55
	56	\constfunc{wxString}{GetDirectory}{\void}
	57
	58	Returns the current directory.
	59	In case of a {\bf EVT\_FILECTRL\_FOLDERCHANGED}, this method returns the new directory.
	60
	61	\membersection{wxFileCtrlEvent::GetFile}\label{wxfilectrleventgetfile}
	62
	63	\constfunc{wxString}{GetFile}{\void}
	64
	65	Returns the file selected(assuming it is only one file).
	66
	67	\membersection{wxFileCtrlEvent::SetFiles}\label{wxfilectrleventsetfiles}
	68
	69	\func{}{wxFileCtrlEvent::SetFiles}{\param{const wxArrayString &}{files}}
	70
	71	Sets the files changed by this event.
	72
	73	\membersection{wxFileCtrlEvent::SetDirectory}\label{wxfilectrleventsetdirectory}
	74
	75	\func{}{wxFileCtrlEvent::SetDirectory}{\param{const wxString &}{directory}}
	76
	77	Sets the current directory of this event.