MFXUtils Class Reference

#include <MFXUtils.h>

---

Detailed Description

Some helper functions for FOX.

Definition at line 42 of file MFXUtils.h.

Static Public Member Functions
static FXString	assureExtension (const FXString &filename, const FXString &defaultExtension) throw ()
	Corrects missing extension.
static void	deleteChildren (FXWindow *w) throw ()
	Deletes all children of the given window.
static FXString	getDocumentName (const FXString &filename) throw ()
	Returns the document name.
static FXString	getFilename2Write (FXWindow *parent, const FXString &header, const FXString &extension, FXIcon *icon, FXString &currentFolder) throw ()
	Returns the file name to write.
static FXString	getTitleText (const FXString &appname, FXString filename="") throw ()
	Returns the title text in dependance to an optional file name.
static FXbool	userPermitsOverwritingWhenFileExists (FXWindow *const parent, const FXString &file) throw ()
	Returns true if either the file given by its name does not exist or the user allows overwriting it.

---

Member Function Documentation

FXString MFXUtils::assureExtension	(	const FXString &	filename,
		const FXString &	defaultExtension
	)			throw () [static]

Corrects missing extension.

At first, the extension is determined. If there is none, the given default extension is appended to the file name/path. Otherwise the file name/path remains as is. The so obtained correct file name is returned.

Parameters:

[in]	filename	The filename to evaluate
[in]	defaultExtension	The default extension to use

Returns:

The corrected filename (with extension if no one was given

Definition at line 81 of file MFXUtils.cpp.

                                                                                            {
    FXString ext = FXPath::extension(filename);
    if (ext=="") {
        if (filename.rfind('.')==filename.length()-1) {
            return filename + defaultExtension;
        }
        return filename + "." + defaultExtension;
    }
    return filename;
}

void MFXUtils::deleteChildren

(

FXWindow *

w

)

throw () [static]

Deletes all children of the given window.

Parameters:

[in]

w

The window to delete all of his children

Definition at line 41 of file MFXUtils.cpp.

Referenced by GUIDialog_ViewSettings::rebuildColorMatrices().

                                            {
    while (w->numChildren()!=0) {
        FXWindow *child = w->childAtIndex(0);
        delete child;
    }
}

FXString MFXUtils::getDocumentName

(

const FXString &

filename

)

throw () [static]

Returns the document name.

Removes the path first. Then, returns the part before the first '.' occurence of the so obtained string.

Parameters:

[in]

filename

The file name (including the path) to obtain the name of

Returns:

The name (without the path and the extension)

Definition at line 65 of file MFXUtils.cpp.

                                                          {
    FXString file = FXPath::name(filename);
    return file.before('.');
}

FXString MFXUtils::getFilename2Write	(	FXWindow *	parent,
		const FXString &	header,
		const FXString &	extension,
		FXIcon *	icon,
		FXString &	currentFolder
	)			throw () [static]

Returns the file name to write.

A somehow complete procedure for determining the file name of a file to write. Builds a file dialog, checks whether a file was chosen, if so, checks whether it's not existing or the user allows to overwrite it etc.

Returns an empty string if the file shall not be created, the filename if it shall.

Parameters:

[in]	parent	The window needed to display dialogs
[in]	header	Title of the save-dialog
[in]	extension	The extension the file should have (must be in the form '.xxx'
[in]	icon	The icon the dialog should have
[in]	currentFolder	The string into which the information about the current folder shall be saved

Returns:

The name of the file to write

Definition at line 94 of file MFXUtils.cpp.

Referenced by GUIParameterTracker::onCmdSave(), GUIDialog_GLChosenEditor::onCmdSave(), and GUIDialog_Breakpoints::onCmdSave().

                                                                           {
    // get the new file name
    FXFileDialog opendialog(parent, header);
    opendialog.setIcon(icon);
    opendialog.setSelectMode(SELECTFILE_ANY);
    opendialog.setPatternList("*" + extension);
    if (currentFolder.length()!=0) {
        opendialog.setDirectory(currentFolder);
    }
    if (!opendialog.execute()) {
        return "";
    }
    FXString file = assureExtension(opendialog.getFilename(), extension.after('.')).text();
    if (!userPermitsOverwritingWhenFileExists(parent, file)) {
        return "";
    }
    currentFolder = opendialog.getDirectory();
    return file;
}

FXString MFXUtils::getTitleText	(	const FXString &	appname,
		FXString	filename = ""
	)			throw () [static]

Returns the title text in dependance to an optional file name.

The title is computed as default on windows: The application name only if no file name is given. If a file name is given, it is used without the extension, extended by the application name.

Parameters:

[in]	appname	The name of the application to return the title of
[in]	appname	The name of the file loaded by the application

Returns:

The built title

Definition at line 72 of file MFXUtils.cpp.

Referenced by GUIApplicationWindow::closeAllWindows(), GUIApplicationWindow::dependentBuild(), and GUIApplicationWindow::handleEvent_SimulationLoaded().

                                                                         {
    if (filename.length()==0) {
        return appname;
    }
    return getDocumentName(filename) + " - " + appname;
}

FXbool MFXUtils::userPermitsOverwritingWhenFileExists	(	FXWindow *const	parent,
		const FXString &	file
	)			throw () [static]

Returns true if either the file given by its name does not exist or the user allows overwriting it.

If the named file does not exist, true is returned. Otherwise, a message box is prompted that asks whether the file may be replaced. If the user answers "yes" in this case, true is returned. In any other cases ("no"/"cancel"), false.

Parameters:

[in]	parent	A parent window needed to prompt the dialog box
[in]	file	The file to check whether it may be generated

Returns:

Whether the named file may be written

Definition at line 50 of file MFXUtils.cpp.

Referenced by GUIDialog_ViewSettings::onCmdExportSetting(), GUISUMOViewParent::onCmdMakeSnapshot(), GUIDialog_EditViewport::onCmdSave(), and GUIDialog_ViewSettings::onCmdSaveDecals().

                                      {
    if (!FXStat::exists(file)) {
        return TRUE;
    }
    int answer =
        FXMessageBox::question(parent, MBOX_YES_NO, "File Exists", "Overwrite '%s'?", file.text());
    if (answer==MBOX_CLICKED_NO) {
        return FALSE;
    }
    return TRUE;
}

---

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

• MFXUtils.h
• MFXUtils.cpp