Enable file open dialog to restore initial path after close and add another...

Enable file open dialog to restore initial path after close and add another parameter for optional start directory.

git-svn-id: svn://svn.code.sf.net/p/irrlicht/code/trunk@3962 dfc29bdd-3216-0410-991c-e03cc46cb475

include/IGUIEnvironment.h

@@ -156,7 +156,8 @@ public:
 	This pointer should not be dropped. See IReferenceCounted::drop() for
 	more information. */
 	virtual IGUIImageList* createImageList( video::ITexture* texture,
-					core::dimension2d<s32>	imageSize, bool useAlphaChannel ) = 0;
+					core::dimension2d<s32> imageSize,
+					bool useAlphaChannel ) = 0;
 
 	//! Returns pointer to the font with the specified filename.
 	/** Loads the font if it was not loaded before.
@@ -198,8 +199,8 @@ public:
 
 	//! Returns the root gui element.
 	/** This is the first gui element, the (direct or indirect) parent of all
-	other gui elements.  It is a valid IGUIElement, with dimensions the same
-	size as the screen.	You should not need to use this method directly, unless
+	other gui elements. It is a valid IGUIElement, with dimensions the same
+	size as the screen. You should not need to use this method directly, unless
 	you wish to reparent GUI elements to the top level.
 	\return Pointer to the root element of the GUI. The returned pointer
 	should not be dropped. See IReferenceCounted::drop() for more
@@ -353,11 +354,16 @@ public:
 	until this messagebox is removed.
 	\param parent Parent gui element of the dialog.
 	\param id Id to identify the gui element.
+	\param restoreCWD If set to true, the current workingn directory will be
+	restored after the dialog is closed in some way. Otherwise the working
+	directory will be the one that the file dialog was last showing.
+	\param startDir Optional path for which the file dialog will be opened.
 	\return Pointer to the created file open dialog. Returns 0 if an error
 	occurred. This pointer should not be dropped. See
 	IReferenceCounted::drop() for more information. */
-	virtual IGUIFileOpenDialog* addFileOpenDialog(const wchar_t* title = 0,
-		bool modal=true, IGUIElement* parent=0, s32 id=-1) = 0;
+	virtual IGUIFileOpenDialog* addFileOpenDialog(const wchar_t* title=0,
+		bool modal=true, IGUIElement* parent=0, s32 id=-1,
+		bool restoreCWD=false, io::path::char_type* startDir=0) = 0;
 
 	//! Adds a color select dialog.
 	/** \param title The title of the dialog.

source/Irrlicht/CGUIEnvironment.cpp

@@ -1185,11 +1185,13 @@ IGUITreeView* CGUIEnvironment::addTreeView(const core::rect<s32>& rectangle,
 
 //! adds a file open dialog. The returned pointer must not be dropped.
 IGUIFileOpenDialog* CGUIEnvironment::addFileOpenDialog(const wchar_t* title,
-				bool modal, IGUIElement* parent, s32 id)
+				bool modal, IGUIElement* parent, s32 id,
+				bool restoreCWD, io::path::char_type* startDir)
 {
 	parent = parent ? parent : this;
 
-	IGUIFileOpenDialog* d = new CGUIFileOpenDialog(title, this, parent, id);
+	IGUIFileOpenDialog* d = new CGUIFileOpenDialog(title, this, parent, id,
+			restoreCWD, startDir);
 	d->drop();
 
 	if (modal)

source/Irrlicht/CGUIEnvironment.h

@@ -134,7 +134,9 @@ public:
 	virtual IGUIMeshViewer* addMeshViewer(const core::rect<s32>& rectangle, IGUIElement* parent=0, s32 id=-1, const wchar_t* text=0);
 
 	//! Adds a file open dialog.
-	virtual IGUIFileOpenDialog* addFileOpenDialog(const wchar_t* title = 0, bool modal=true, IGUIElement* parent=0, s32 id=-1);
+	virtual IGUIFileOpenDialog* addFileOpenDialog(const wchar_t* title = 0,
+			bool modal=true, IGUIElement* parent=0, s32 id=-1,
+			bool restoreCWD=false, io::path::char_type* startDir=0);
 
 	//! Adds a color select dialog.
 	virtual IGUIColorSelectDialog* addColorSelectDialog(const wchar_t* title = 0, bool modal=true, IGUIElement* parent=0, s32 id=-1);

source/Irrlicht/CGUIFileOpenDialog.cpp

@@ -28,7 +28,8 @@ const s32 FOD_HEIGHT = 250;
 
 //! constructor
 CGUIFileOpenDialog::CGUIFileOpenDialog(const wchar_t* title,
-		IGUIEnvironment* environment, IGUIElement* parent, s32 id)
+		IGUIEnvironment* environment, IGUIElement* parent, s32 id,
+		bool restoreCWD, io::path::char_type* startDir)
 : IGUIFileOpenDialog(environment, parent, id,
 		core::rect<s32>((parent->getAbsolutePosition().getWidth()-FOD_WIDTH)/2,
 					(parent->getAbsolutePosition().getHeight()-FOD_HEIGHT)/2,
@@ -42,16 +43,33 @@ CGUIFileOpenDialog::CGUIFileOpenDialog(const wchar_t* title,
 
 	Text = title;
 
-	IGUISkin* skin = Environment->getSkin();
+	FileSystem = Environment?Environment->getFileSystem():0;
+
+	if (FileSystem)
+	{
+		FileSystem->grab();
+
+		if (restoreCWD)
+			RestoreDirectory = FileSystem->getWorkingDirectory();
+		if (startDir)
+		{
+			StartDirectory = startDir;
+			FileSystem->changeWorkingDirectoryTo(startDir);
+		}
+	}
+	else
+		return;
+
 	IGUISpriteBank* sprites = 0;
 	video::SColor color(255,255,255,255);
+	IGUISkin* skin = Environment->getSkin();
 	if (skin)
 	{
 		sprites = skin->getSpriteBank();
 		color = skin->getColor(EGDC_WINDOW_SYMBOL);
 	}
 
-	const s32 buttonw = environment->getSkin()->getSize(EGDS_WINDOW_BUTTON_WIDTH);
+	const s32 buttonw = skin->getSize(EGDS_WINDOW_BUTTON_WIDTH);
 	const s32 posx = RelativeRect.getWidth() - buttonw - 4;
 
 	CloseButton = Environment->addButton(core::rect<s32>(posx, 3, posx + buttonw, 3 + buttonw), this, -1,
@@ -91,11 +109,6 @@ CGUIFileOpenDialog::CGUIFileOpenDialog(const wchar_t* title,
 	FileNameText->setAlignment(EGUIA_UPPERLEFT, EGUIA_LOWERRIGHT, EGUIA_UPPERLEFT, EGUIA_UPPERLEFT);
 	FileNameText->grab();
 
-	FileSystem = Environment->getFileSystem();
-
-	if (FileSystem)
-		FileSystem->grab();
-
 	setTabGroup(true);
 
 	fillListBox();
@@ -121,7 +134,12 @@ CGUIFileOpenDialog::~CGUIFileOpenDialog()
 		FileNameText->drop();
 
 	if (FileSystem)
+	{
+		// revert to original CWD if path was set in constructor
+		if (RestoreDirectory.size())
+			FileSystem->changeWorkingDirectoryTo(RestoreDirectory);
 		FileSystem->drop();
+	}
 
 	if (FileList)
 		FileList->drop();
@@ -312,6 +330,36 @@ void CGUIFileOpenDialog::draw()
 }
 
 
+//! Writes attributes of the element.
+/* Not sure if this will really work out properly. Saving paths can be
+rather problematic. */
+void CGUIFileOpenDialog::serializeAttributes(io::IAttributes* out, io::SAttributeReadWriteOptions* options) const
+{
+	IGUIFileOpenDialog::serializeAttributes(out,options);
+
+	out->addString("StartDirectory", StartDirectory.c_str());
+	out->addBool("RestoreDirectory", (RestoreDirectory.size()!=0));
+}
+
+
+//! Reads attributes of the element
+/* Note that thiese paths changes will happen at arbitrary places upon
+load of the gui description. This may be undesired. */
+void CGUIFileOpenDialog::deserializeAttributes(io::IAttributes* in, io::SAttributeReadWriteOptions* options)
+{
+	StartDirectory = in->getAttributeAsString("StartDirectory");
+	const bool restore = in->getAttributeAsBool("RestoreDirectory");
+	if (restore)
+		RestoreDirectory = FileSystem->getWorkingDirectory();
+	else
+		RestoreDirectory = "";
+	if (StartDirectory.size())
+		FileSystem->changeWorkingDirectoryTo(StartDirectory);
+
+	IGUIFileOpenDialog::deserializeAttributes(in,options);
+}
+
+
 //! fills the listbox with files.
 void CGUIFileOpenDialog::fillListBox()
 {
@@ -396,4 +444,3 @@ void CGUIFileOpenDialog::sendCancelEvent()
 } // end namespace irr
 
 #endif // _IRR_COMPILE_WITH_GUI_
-

source/Irrlicht/CGUIFileOpenDialog.h

@@ -24,7 +24,9 @@ namespace gui
 	public:
 
 		//! constructor
-		CGUIFileOpenDialog(const wchar_t* title, IGUIEnvironment* environment, IGUIElement* parent, s32 id);
+		CGUIFileOpenDialog(const wchar_t* title, IGUIEnvironment* environment,
+				IGUIElement* parent, s32 id, bool restoreCWD=false,
+				io::path::char_type* startDir=0);
 
 		//! destructor
 		virtual ~CGUIFileOpenDialog();
@@ -41,6 +43,9 @@ namespace gui
 		//! draws the element and its children
 		virtual void draw();
 
+		virtual void serializeAttributes(io::IAttributes* out, io::SAttributeReadWriteOptions* options=0) const;
+		virtual void deserializeAttributes(io::IAttributes* in, io::SAttributeReadWriteOptions* options=0);
+
 	protected:
 
 		//! fills the listbox with files.
@@ -55,6 +60,8 @@ namespace gui
 		core::position2d<s32> DragStart;
 		core::stringw FileName;
 		io::path FileDirectory;
+		io::path RestoreDirectory;
+		io::path StartDirectory;
 
 		IGUIButton* CloseButton;
 		IGUIButton* OKButton;