owl::TDvOpenSaveData Class Reference

TDvOpenSaveData encapsulates the information used to initialized the Open or Save As dialog box by ObjectWindows' DocView manager. More...

#include <owl/docmanag.h>

Inheritance diagram for owl::TDvOpenSaveData:

Public Member Functions
	TDvOpenSaveData (uint32 flags, tchar *filter, tchar *initialDir, tchar *defExt, int filterIndex, TDocTemplate **tmplList, int tmplCount)
	Constructor of class representing the data to be displayed in the Open/Save dialogs used by the DocManager.
TDocTemplate **	GetTmplList () const
	Returns the list of templates displayed in the Open or Save dialogs used by the DocManager.
int	GetTmplCount () const
	Returns the number of DocView templates currently displayed in the Open or Save dialogs used by the DocManager.
Public Member Functions inherited from owl::TOpenSaveDialog::TData
	TData (uint32 flags=0, LPCTSTR filter=nullptr, TCHAR *customFilter=nullptr, LPCTSTR initialDir=nullptr, LPCTSTR defExt=nullptr, int maxPath=0, int filterIndex=0, uint32 flagsEx=0)
	Constructs a TOpenSaveDialog::TData structure.
	TData (uint32 flags, const tstring &filter, TCHAR *customFilter=nullptr, LPCTSTR initialDir=nullptr, LPCTSTR defExt=nullptr, int maxPath=0, int filterIndex=0, uint32 flagsEx=0)
	String-aware overload TODO: Add string support for all parameters.
	TData (const TData &src)
	~TData ()
	Destructs a TOpenSaveDialog::TData structure.
TData &	operator= (const TData &src)
void	SetFilter (LPCTSTR filter=nullptr)
	Makes a copy of the filter list used to display the file names.
void	SetFilter (const tstring &filter)
void	Write (opstream &os)
void	Read (ipstream &is)
auto	GetFileNames () const -> std::vector< tstring >
	Returns a vector containing the full paths of every file entry in member FileName.

Protected Attributes
int	TmplCount
	Number of Doc/View templates in 'TmplList'.
int	TmplIndex
	Index of the default template.
TDocTemplate **	TmplList
	List of Doc/View templates displayed in Common Dialog during a File|Open or File|SaveAs operation.

Additional Inherited Members
Public Attributes inherited from owl::TOpenSaveDialog::TData
uint32	Flags
	Flag contains one or more of the following constants:
uint32	Error
	This is the return value from calling CommDlgExtendedError after executing the dialog in the implementation of TOpenSaveDialog::Execute.
TCHAR *	FileName
	Holds the name of the file to be saved or opened.
TCHAR *	Filter
	Filter holds the filter to use initially when displaying file names.
int	FilterIndex
	FilterIndex indicates which filter to use initially when displaying file names.
LPCTSTR	InitialDir
	Directory to use initially when displaying file names.
LPCTSTR	DefExt
	Default extension to use when saving file names.
int	MaxPath
uint32	FlagsEx

Detailed Description

TDvOpenSaveData encapsulates the information used to initialized the Open or Save As dialog box by ObjectWindows' DocView manager.

Besides the typically 'OPENFILENAME' related information, it also provides methods to retrieve the template list and template count of the current Document Manager.

Definition at line 278 of file docmanag.h.

Constructor & Destructor Documentation

TDvOpenSaveData()

owl::TDvOpenSaveData::TDvOpenSaveData	(	uint32	flags,
		tchar *	filter,
		tchar *	initialDir,
		tchar *	defExt,
		int	filterIndex,
		TDocTemplate **	tmplList,
		int	tmplCount )

Constructor of class representing the data to be displayed in the Open/Save dialogs used by the DocManager.

Definition at line 58 of file docmanag.cpp.

Member Function Documentation

GetTmplCount()

int owl::TDvOpenSaveData::GetTmplCount ( ) const

inline

Returns the number of DocView templates currently displayed in the Open or Save dialogs used by the DocManager.

Definition at line 545 of file docmanag.h.

References TmplCount.

GetTmplList()

TDocTemplate ** owl::TDvOpenSaveData::GetTmplList ( ) const

inline

Returns the list of templates displayed in the Open or Save dialogs used by the DocManager.

Definition at line 536 of file docmanag.h.

References TmplList.

Member Data Documentation

TmplCount

int owl::TDvOpenSaveData::TmplCount

protected

Number of Doc/View templates in 'TmplList'.

Definition at line 288 of file docmanag.h.

TmplIndex

int owl::TDvOpenSaveData::TmplIndex

protected

Index of the default template.

Definition at line 289 of file docmanag.h.

TmplList

TDocTemplate** owl::TDvOpenSaveData::TmplList

protected

List of Doc/View templates displayed in Common Dialog during a File|Open or File|SaveAs operation.

Definition at line 290 of file docmanag.h.

---

The documentation for this class was generated from the following files:

• include/owl/docmanag.h
• source/owlcore/docmanag.cpp