SaveFileDialog Class Reference

This is the Save Dialog that is brought up in responce to the saveas option. It will select the last used directory etc and is generally very fabby. More...

#include <filedlgs.h>

Inheritance diagram for SaveFileDialog:

List of all members.

Public Member Functions
	SaveFileDialog (LPCTSTR FilterString, const String_256 &, const String_256 &)
	Constructs a Save File Dialog. It sets the File Must Exist and Hide Read Only Flags. Call PrepareDialog() then DoModal() to use.
	SaveFileDialog (LPCTSTR FilterString, const String_256 &DefPath, const String_256 &DefName, const String_256 &DocumentName)
	Constructs a Save File Dialog. It sets the File Must Exist and Hide Read Only Flags. Call PrepareDialog() then DoModal() to use.
virtual BOOL	PrepareDialog ()
	Does anything the dialogs want doing after they have been created, but before they are displayed.
void	SetDefaultPath (const String_256 &NewPath)
	Sets the default path. The next Save As dialog will default to this path.
virtual void	AppendExtension (wxString *pFilename)
	Given a filename, this function will attach the .art file extension to the to it.
Protected Member Functions
virtual BOOL	ExplorerInitDialog (wxWindow *hDlg)
	Should be called when the explorer style dialog boxes need setting up. We can take this opportunity to add in any extra controls that we require.
virtual BOOL	HandleOptions ()
	Implements the options button installed for WEBSTER Save dlg opens up the .web save options.
BOOL	OnInitDialog ()
	Changes a few bits and bobs about in the Save Dialog.
BOOL	OnFileNameOK ()
	So we can do our own 'that file already exists' check, as the standard one used Y/N and that is officially forbidden (despite the fact that 99.999% of Windows programs use it). Its an MFC overridable.
void	DoDataExchange (CDataExchange *pDX)
	Gets the state of the "Compress file" check-box in the save file dialog.
	DECLARE_DYNAMIC (SaveFileDialog)
Protected Attributes
String_256	DefaultName
String_256	DefaultPath
String_256	DocName
wxButton *	CompressButton
wxButton *	Options
wxStaticText *	CurrentOptions

---

Detailed Description

This is the Save Dialog that is brought up in responce to the saveas option. It will select the last used directory etc and is generally very fabby.

Author:

Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com>

Date:

26/1/95

See also:

BaseFileDialog

Definition at line 365 of file filedlgs.h.

---

Constructor & Destructor Documentation

SaveFileDialog::SaveFileDialog (  LPCTSTR  FilterString, const String_256 &  DefPath, const String_256 &  DefName )

Constructs a Save File Dialog. It sets the File Must Exist and Hide Read Only Flags. Call PrepareDialog() then DoModal() to use. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 26/1/95 Parameters: FilterString  - The string of available filters [INPUTS] DefPath - The Default Path for the file DefName - The Default FileName for the file Definition at line 2551 of file filedlgs.cpp. : BaseFileDialog( FALSE, wxFILE_MUST_EXIST, FilterString ) // : BaseFileDialog(FALSE, OFN_HIDEREADONLY | OFN_PATHMUSTEXIST, FilterString) { // Make a note of this lot DefaultName = DefName; DefaultPath = DefPath; DocName = DefName; PORTNOTE("other", "Removed OFN_OVERWRITEPROMPT - not sure if needed" ) #if !defined(EXCLUDE_FROM_XARALX) // Under Windows 95 the OnFileNameOK system does not work, so use the default one // Disable for VC4.0/MFC 4.0 as they have fixed it. #if _MFC_VER < 0x400 if (IsWin32c()) m_ofn.Flags |= OFN_OVERWRITEPROMPT; #endif #endif }

SaveFileDialog::SaveFileDialog (  LPCTSTR  FilterString, const String_256 &  DefPath, const String_256 &  DefName, const String_256 &  DocumentName )

Constructs a Save File Dialog. It sets the File Must Exist and Hide Read Only Flags. Call PrepareDialog() then DoModal() to use. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 26/1/95 Parameters: FilterString  - The string of available filters [INPUTS] DefPath - The Default Path for the file DefName - The Default FileName for the file DocumentName - The name of the document to put in the dialog title Definition at line 2588 of file filedlgs.cpp. : BaseFileDialog( FALSE, ((CCamApp::IsNewWindowsUI()) ? OFN_ENABLETEMPLATE : 0) | OFN_HIDEREADONLY | OFN_PATHMUSTEXIST, FilterString) : BaseFileDialog( FALSE, wxFILE_MUST_EXIST, FilterString ) { // Make a note of this lot DefaultName = DefName; DefaultPath = DefPath; DocName = DocumentName; PORTNOTE("other", "Disabled template stuff" ) #if !defined(EXCLUDE_FROM_XARALX) if (CCamApp::IsNewWindowsUI()) { // Use our template to do the ammendment and addition of controls to the dialog box m_ofn.lpTemplateName = MAKEINTRESOURCE(_R(IDD_PREVIEWBITMAP)); } else m_ofn.lpTemplateName = NULL; #endif // Set the preview bitmap to be NULL pBitmapToUse = NULL; }

---

Member Function Documentation

void SaveFileDialog::AppendExtension (  wxString *  pFilename  )  [virtual]

Given a filename, this function will attach the .art file extension to the to it. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 14/6/95 Parameters: pFilename  - the filename to append an extension to [INPUTS] pFilename  - the input filename with the .art extension on the end (if needed) [OUTPUTS] Reimplemented from BaseFileDialog. Definition at line 2887 of file filedlgs.cpp. { // Make sure we were not passed rubbish if ((pFilename==NULL) || (pFilename->IsEmpty())) return; TRACEUSER( "Rik", _T("Append Extension in - %s\n"), (const TCHAR*)(*pFilename)); // First we will see if this filename has an extension already INT32 ExtensionLen = pFilename->length() - pFilename->Find( '.', true ); INT32 i = pFilename->Find( '.', true ); // See if we found a valid extension if( ExtensionLen > 3 || i < 0 ) { // No extension as yet, so add one in String_32 NewExtension(_R(IDS_DEFAULT_EXTENSION)); *pFilename += wxString( _T(".") ); *pFilename += wxString( (const TCHAR *)NewExtension ); } TRACEUSER( "Rik", _T("Append Extension out- %s\n\n"), (const TCHAR*)(*pFilename) ); }

SaveFileDialog::DECLARE_DYNAMIC (  SaveFileDialog   )  [protected]

void SaveFileDialog::DoDataExchange (  CDataExchange *  pDX  )  [protected]

Gets the state of the "Compress file" check-box in the save file dialog. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 27/5/95 Parameters: (a  standard MFC object) [INPUTS] Reimplemented in SaveTemplateDialog. Definition at line 2745 of file filedlgs.cpp. { BaseFileDialog::DoDataExchange(pDX); //{{AFX_DATA_MAP(CMyDialog) #ifdef _DEBUG DDX_Check(pDX, _R(IDC_COMPRESS_BUTTON), CamelotNativeEPSFilter::CompressNative); #endif // DDX_Check(pDX, _R(IDC_SAVEASWEB_BUTTON), SaveWebFile); //BaseCamelotFilter::ExportWebFile); if (CCamApp::IsNewWindowsUI()) { DDX_Check(pDX, _R(IDC_SHOWPREVIEW), BaseFileDialog::ShowPreviewBitmap); } //}}AFX_DATA_MAP }

BOOL SaveFileDialog::ExplorerInitDialog (  wxWindow *  hDlg  )  [protected, virtual]

Should be called when the explorer style dialog boxes need setting up. We can take this opportunity to add in any extra controls that we require. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 2/7/96 Returns: TRUE if it worked, FALSE if it failed See also: BaseFileDialog::ExplorerInitDialog; BaseFileDialog::OnHookMsg; BaseFileDialog::HookProc; Reimplemented from BaseFileDialog. Reimplemented in SaveTemplateDialog. Definition at line 2688 of file filedlgs.cpp. { PORTNOTE("other", "Remove MFC code" ) #if !defined(EXCLUDE_FROM_XARALX) // Do nothing of not on explorer type dialog boxes if (!CCamApp::IsNewWindowsUI()) return TRUE; // Set up and initialise the new buttons and controls // Give it the correct state according to the preference. CheckDlgButton(_R(IDC_SHOWPREVIEW), BaseFileDialog::ShowPreviewBitmap != FALSE); wxWindow* Icon = FindWindow( _R(IDC_PREVIEW)); ::EnableWindow(Icon, TRUE); // WEBSTER - markn 28/1/97 Icon = FindWindow( _R(IDC_FILEDLG_OPTIONS)); #ifndef WEBSTER ::ShowWindow(Icon, SW_HIDE); #else ::ShowWindow(Icon, SW_SHOWNORMAL); ::EnableWindow(Icon, TRUE); #endif // WEBSTER //Graham 27/10/97: And the "use as default" button Icon = FindWindow( _R(IDC_USEASDEFAULT)); ::ShowWindow(Icon, SW_HIDE); // Move the Preview box down a little, so that it lines up with the List box CWnd *wndDlg = GetParent(); wxWindow* pWndPreview = GetDlgItem(_R(IDC_PREVIEW)); wxRect rPreview, rList; pWndPreview->GetWindowRect(&rPreview); ScreenToClient(rPreview); wxWindow* pWndList = wndDlg->GetDlgItem(lst1); // lst1 is the ID for the main list box pWndList->GetWindowRect(&rList); ScreenToClient(rList); pWndPreview->SetWindowPos(NULL, rPreview.left, rList.top, rPreview.Width(), rPreview.Height(), 0); ExplorerInited = TRUE; #endif return TRUE; }

BOOL SaveFileDialog::HandleOptions (   )  [protected, virtual]

Implements the options button installed for WEBSTER Save dlg opens up the .web save options. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 24/1/97 Returns: - Reimplemented from BaseFileDialog. Definition at line 2925 of file filedlgs.cpp. { #ifndef WEBSTER return BaseFileDialog::HandleOptions(); #else if (CCamApp::IsNewWindowsUI()) { CamelotWebFilter* pWebFilter = NULL; { // Find the web filter Filter* pFilter = Filter::GetFirst(); while (pFilter != NULL && pFilter->FilterID != FILTERID_WEB) pFilter = Filter::GetNext(pFilter); // Try the next filter if (pFilter != NULL && IS_A(pFilter,CamelotWebFilter)) pWebFilter = (CamelotWebFilter*)pFilter; } // Make sure that we found the web Filter if (pWebFilter == NULL) { InformError(_R(IDT_CANT_FIND_FILTER)); return FALSE; } WebPrefsDlgParam Prefs; Prefs.SetSelType(pWebFilter->GetSelType()); // Use the preference option in the baseclass camelot filter; Prefs.SetBmpCompression( pWebFilter->GetBitmapCompression()); Prefs.SetExportPreviewBitmap( pWebFilter->GetPreviewBitmapExport()); Prefs.SetConvertTextToOutlines( pWebFilter->GetConvertTextToOutlines()); Prefs.SetConvertBlendsToOutlines( pWebFilter->GetConvertBlendsToOutlines()); Prefs.SetHTMLToClipboard( pWebFilter->ShouldExportHTMLTag()); // This is ok as we are using a modal dialog box BOOL Ok = WebPrefsDlg::InvokeDialog(&Prefs); // If ok, and the OK button was clicked to close the dlg if (OK && Prefs.GetWebOk()) { // Set up some returned variables as the user has oked them pWebFilter->SetBitmapCompression(Prefs.GetBmpCompression()); pWebFilter->SetPreviewBitmapExport(Prefs.GetExportPreviewBitmap()); pWebFilter->SetConvertTextToOutlines(Prefs.GetConvertTextToOutlines()); pWebFilter->SetConvertBlendsToOutlines(Prefs.GetConvertBlendsToOutlines()); pWebFilter->SetRemoveInvisibleLayers(TRUE); pWebFilter->SetRemoveUnusedColours(FALSE); pWebFilter->SetMinimalWebFormat(FALSE); pWebFilter->SetSelType(Prefs.GetSelType()); pWebFilter->SetHTMLToClipboard(Prefs.GetHTMLToClipboard()); } } return TRUE; #endif // WEBSTER }

BOOL SaveFileDialog::OnFileNameOK (   )  [protected]

So we can do our own 'that file already exists' check, as the standard one used Y/N and that is officially forbidden (despite the fact that 99.999% of Windows programs use it). Its an MFC overridable. Author: Andy_Pennell (Xara Group Ltd) <camelotdev@xara.com> Date: 21/9/94 Returns: TRUE if we didn't like it, FALSE if it was OK. (This is contrary to the MFC docs, but they seem to be wrong). See also: ExportFileDialog Definition at line 2863 of file filedlgs.cpp. { // ask the new function if the name is OK if (IsValidFilename()) return FALSE; else return TRUE; }

BOOL SaveFileDialog::OnInitDialog (   )  [protected]

Changes a few bits and bobs about in the Save Dialog. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 25/1/95 Returns: TRUE => normal window focus is required. See also: SaveFileDialog Definition at line 2627 of file filedlgs.cpp. { // Set up the string we require String_256 NewText(_R(IDS_SAVEBUTTON)); const TCHAR* NewTextStr = NewText; // Get the handle of the ok button. wxButton* OkButton = (wxButton*)FindWindow( wxID_OK ); // Now replace the 'ok' by 'Save' and return OkButton->SetLabel( NewTextStr ); PORTNOTE( "other", "Remove code to add compression check" ) #if !defined(EXCLUDE_FROM_XARALX) && defined(_DEBUG) // Move the bottom of the dialog down... WINDOWPLACEMENT Placement; Placement.length = sizeof(Placement); ::GetWindowPlacement(GetSafeHwnd(), &Placement); INT32 Height = Placement.rcNormalPosition.bottom - Placement.rcNormalPosition.top; if (!CCamApp::IsNewWindowsUI()) { // Only resize the window on older UI i.e. NT 3 and Win 3 as handled differently // on Windows 95 UI forms. ::MoveWindow(GetSafeHwnd(), Placement.rcNormalPosition.left, Placement.rcNormalPosition.top, Placement.rcNormalPosition.right - Placement.rcNormalPosition.left, Height + 20, TRUE); } // ...and add a check box for the compression on/off preference. wxRect ButtonPos(10, Height - 35, 110, Height - 15); CompressButton.Create((TCHAR *)String_32(_R(IDS_FILEDLGS_COMPRESS_FILE)), WS_CHILD | WS_VISIBLE | WS_TABSTOP | BS_AUTOCHECKBOX, ButtonPos, this, _R(IDC_COMPRESS_BUTTON)); // Give it the correct state according to the preference. CompressButton.SetCheck(CamelotNativeEPSFilter::CompressNative != FALSE); #endif return TRUE; }

BOOL SaveFileDialog::PrepareDialog (   )  [virtual]

Does anything the dialogs want doing after they have been created, but before they are displayed. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 26/1/95 Returns: TRUE if it worked, FALSE if not Reimplemented from BaseFileDialog. Reimplemented in SaveTemplateDialog. Definition at line 2773 of file filedlgs.cpp. { // Set the title of the dialog, depending on what the document name is if (!DocName.IsEmpty()) { // Get a string to build the document title in String_256 DialogTitle; // make a title for the dialog, using the default name for the document // ie it will come out a bit like this... Save MyDoc.art As if (DialogTitle.MakeMsg(_R(IDS_SAVENAMEDTITLE), &DocName)!=0) { // OK, we have the title in a string 256, so put it into a normal string UINT32 CopyLength = DialogTitle.Length() + 1; if (CopyLength > TITLE_SIZE) { CopyLength = TITLE_SIZE - 1; } camStrncpy( Title, (const TCHAR*)(DialogTitle), CopyLength); Title[CopyLength] = TEXT('\0'); // Change the dialogs data structure to use the new title string wxFileDialog::SetTitle( Title ); } } else { // We have no title for the document, so just use 'Save As' instead if (SmartLoadString(0, _R(IDS_SAVETITLE), Title, 128)) wxFileDialog::SetTitle( Title ); } // Select the desired path, use the one passed in to the constructor is available if (!DefaultPath.IsEmpty()) { // Set the default path SetDirectory( DefaultPath ); } else { // or use the global default path if( DefaultSaveFilePath.Length() == 0 ) // use the My Documents folder DefaultOpenFilePath = wxStandardPaths::Get().GetUserConfigDir(); SetDirectory( DefaultSaveFilePath ); } // Do the same for the filename if (!DefaultName.IsEmpty()) SetFilename( DefaultName ); return TRUE; }

void SaveFileDialog::SetDefaultPath (  const String_256 &  NewPath  )

Sets the default path. The next Save As dialog will default to this path. Author: Rik_Heywood (Xara Group Ltd) <camelotdev@xara.com> Date: 26/1/95 Parameters: NewPath  - The path to use as the default [INPUTS] Definition at line 2841 of file filedlgs.cpp. { // Set the default path DefaultSaveFilePath = NewPath; }

---

Member Data Documentation

wxButton* SaveFileDialog::CompressButton [protected]

Definition at line 408 of file filedlgs.h.

wxStaticText* SaveFileDialog::CurrentOptions [protected]

Definition at line 410 of file filedlgs.h.

String_256 SaveFileDialog::DefaultName [protected]

Definition at line 404 of file filedlgs.h.

String_256 SaveFileDialog::DefaultPath [protected]

Definition at line 405 of file filedlgs.h.

String_256 SaveFileDialog::DocName [protected]

Definition at line 406 of file filedlgs.h.

wxButton* SaveFileDialog::Options [protected]

Definition at line 409 of file filedlgs.h.

---

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

• wxOil/filedlgs.h (r1785/r1282)
• wxOil/filedlgs.cpp (r1785/r1712)

---