WxGUI Programming Howto - Revision history

⚠️Wenzeslaus: update links

2015-03-04T15:48:56Z

update links

← Older revision		Revision as of 15:48, 4 March 2015
Line 1:		Line 1:
	The basic rules how to write wxPython-based [[wxGUI]] are in the ~~file~~ {{~~src~~\|~~SUBMITTING_WXGUI~~}} in GRASS source codes. This page contains more advanced tips how to write wxGUI source code.		The basic rules how to write wxPython-based [[wxGUI]] are at the {{twiki\|Submitting/wxGUI\|Submitting page}} in GRASS source codes. This page contains more advanced tips how to write wxGUI source code.

	''Note that this page ~~will~~ be split into more pages.''		''Note that this page should be moved to wxGUI documentation and may be split into more pages.''

	__TOC__		__TOC__
Line 7:		Line 7:
	== List of other resources ==		== List of other resources ==

	* {{~~src~~\|~~SUBMITTING_WXGUI~~}} file		* {{twiki\|Submitting/wxGUI\|Submitting page}} file
	* ~~GRASS Programming manual: [http~~:/~~/grass.osgeo.org/programming7/wxpythonlib.html wxGUI]~~ (API documentation and examples of usage)		* wxGUI documentation: compile Python documentation in {{src\|gui/wxpython}} (API documentation and examples of usage)
	* [[Tools for Python programming]]		* [[Tools for Python programming]]

⚠️Wenzeslaus: /* Using signals or events to reduce dependencies */ adding Signal

2013-08-03T19:56:17Z

Using signals or events to reduce dependencies: adding Signal

← Older revision		Revision as of 19:56, 3 August 2013
Line 19:		Line 19:
	by wx-like styles.		by wx-like styles.

	== Using events to reduce dependencies ==		== Using signals or events to reduce dependencies ==

	=== An event tells us that something happened ===		=== An event tells us that something happened ===
Line 81:		Line 81:
	</source>		</source>

	=== ~~Events emitted by a class~~ are ~~part of its interface~~ ===		=== Signals are better than events ===

	~~Events~~ are ~~part of class' interface~~. ~~If defining new events~~, ~~define~~ them ~~before the class definition~~.		[http://grass.osgeo.org/programming7/pydispatch.html Signals] (an GRASS API for PyDispatcher library) are usually more flexible and easier to use than wxPython events. However, general ideas about the code design which uses signals is the same. Use them if you don't need to use wxPython events.

	Newly defined events should be before a class definition (not at the file beginning or in separate file). Note that this does not apply to <tt>CommandEvents</tt>.		=== Signals and events emitted by a class are part of its interface ===

			Signals and events are part of class' interface.

			Signals should be defined in the class' constructor (<tt>__init__</tt> function) and properly documented including parameters and the occasion of emit.

			If defining new events, define them before the class definition. Newly defined events should be before a class definition (not at the file beginning or in separate file). Note that this does not apply to <tt>CommandEvents</tt>.

	== Splitting GUI and logic ==		== Splitting GUI and logic ==

⚠️Landa: /* Splitting GUI and logic */

2013-08-02T07:45:29Z

Splitting GUI and logic

← Older revision		Revision as of 07:45, 2 August 2013
Line 89:		Line 89:
	== Splitting GUI and logic ==		== Splitting GUI and logic ==

	You can achieve re-usability by splitting GUI (windows, buttons, colors, ...) and logic (running commands, writing files, data handling, ...). Note, that there also is MVC concept which has three parts logic, data and GUI.		You can achieve re-usability by splitting GUI (windows, buttons, colors, ...) and logic (running commands, writing files, data handling, ...). Note, that there also is {{wikipedia\|Model–view–controller\|MVC}} concept which has three parts logic, data and GUI.

	== Single responsibility principle ==		== Single responsibility principle ==

⚠️Landa: /* List of other resources */

2013-08-01T18:31:10Z

List of other resources

← Older revision		Revision as of 18:31, 1 August 2013
Line 7:		Line 7:
	== List of other resources ==		== List of other resources ==

	* ~~[http://trac.osgeo.org/grass/browser/grass/trunk/~~SUBMITTING_WXGUI ~~SUBMITTING_WXGUI]~~ file		* {{src\|SUBMITTING_WXGUI}} file
	* GRASS Programming manual: [http://grass.osgeo.org/programming7/wxpythonlib.html wxGUI] (API documentation and examples of usage)		* GRASS Programming manual: [http://grass.osgeo.org/programming7/wxpythonlib.html wxGUI] (API documentation and examples of usage)
	* [[Tools for Python programming]]		* [[Tools for Python programming]]

⚠️Landa at 18:30, 1 August 2013

2013-08-01T18:30:30Z

← Older revision		Revision as of 18:30, 1 August 2013
Line 1:		Line 1:
	The basic rules how to write wxPython-based [[wxGUI]] are in the file ~~<tt>~~SUBMITTING_WXGUI~~</tt>~~ in GRASS source codes. This page contains more advanced tips how to write wxGUI source code.		The basic rules how to write wxPython-based [[wxGUI]] are in the file {{src\|SUBMITTING_WXGUI}} in GRASS source codes. This page contains more advanced tips how to write wxGUI source code.

	''Note that this page will be split into more pages.''		''Note that this page will be split into more pages.''

⚠️Landa at 18:28, 1 August 2013

2013-08-01T18:28:03Z

← Older revision		Revision as of 18:28, 1 August 2013
Line 1:		Line 1:
	The basic rules how to write wxPython-based wxGUI are in the file <tt>SUBMITTING_WXGUI</tt> in GRASS source codes. This page contains more advanced tips how to write wxGUI source code.		The basic rules how to write wxPython-based [[wxGUI]] are in the file <tt>SUBMITTING_WXGUI</tt> in GRASS source codes. This page contains more advanced tips how to write wxGUI source code.

	''Note that this page will be split into more pages.''		''Note that this page will be split into more pages.''

⚠️Landa: /* List of other resources */

2013-03-21T15:12:54Z

List of other resources

← Older revision		Revision as of 15:12, 21 March 2013
Line 7:		Line 7:
	== List of other resources ==		== List of other resources ==

	* ~~<tt>~~SUBMITTING_WXGUI~~</tt>~~ file		* [http://trac.osgeo.org/grass/browser/grass/trunk/SUBMITTING_WXGUI SUBMITTING_WXGUI] file
	* GRASS Programming manual: [http://grass.osgeo.org/programming7/wxpythonlib.html wxGUI] (API documentation and examples of usage)		* GRASS Programming manual: [http://grass.osgeo.org/programming7/wxpythonlib.html wxGUI] (API documentation and examples of usage)
	* [[Tools for Python programming]]		* [[Tools for Python programming]]

⚠️Wenzeslaus at 10:50, 7 February 2013

2013-02-07T10:50:16Z

← Older revision		Revision as of 10:50, 7 February 2013
Line 9:		Line 9:
	* <tt>SUBMITTING_WXGUI</tt> file		* <tt>SUBMITTING_WXGUI</tt> file
	* GRASS Programming manual: [http://grass.osgeo.org/programming7/wxpythonlib.html wxGUI] (API documentation and examples of usage)		* GRASS Programming manual: [http://grass.osgeo.org/programming7/wxpythonlib.html wxGUI] (API documentation and examples of usage)
			* [[Tools for Python programming]]

	== Isolating different behavior by using wx-like styles ==		== Isolating different behavior by using wx-like styles ==
Line 167:		Line 168:

	The possible exceptions when buttons can be disabled are wizards when it may be clear that user have to fill all the fields. However, there could be some other validation needed such a the length of text in some field and again user does not know what to change.		The possible exceptions when buttons can be disabled are wizards when it may be clear that user have to fill all the fields. However, there could be some other validation needed such a the length of text in some field and again user does not know what to change.

			{{Python}}

⚠️Wenzeslaus: adding GlynnC's advice

2013-02-06T16:03:44Z

adding GlynnC's advice

← Older revision		Revision as of 16:03, 6 February 2013
Line 1:		Line 1:
	The basic rules how to write wxPython-based wxGUI are in the file <tt>SUBMITTING_WXGUI</tt> in GRASS source codes ~~(TODO: create this file)~~. This page contains more advanced tips how to write wxGUI source code.		The basic rules how to write wxPython-based wxGUI are in the file <tt>SUBMITTING_WXGUI</tt> in GRASS source codes. This page contains more advanced tips how to write wxGUI source code.

			''Note that this page will be split into more pages.''

	__TOC__		__TOC__
Line 5:		Line 7:
	== List of other resources ==		== List of other resources ==

	* <tt>SUBMITTING_WXGUI</tt> file ~~(not exists yet)~~		* <tt>SUBMITTING_WXGUI</tt> file
	* <tt>SUBMITTING_PYTHON</tt> file (note that many things applies only to Python scripts)		* GRASS Programming manual: [http://grass.osgeo.org/programming7/wxpythonlib.html wxGUI] (API documentation and examples of usage)
	* GRASS Programming manual: [http://grass.osgeo.org/programming7/wxpythonlib.html wxGUI] (documentation and examples of usage)

	== Isolating different behavior by using wx-like styles ==		== Isolating different behavior by using wx-like styles ==
Line 144:		Line 145:

	Use <tt>wx.FutureCall()</tt> instead of <tt>time.sleep()</tt>.		Use <tt>wx.FutureCall()</tt> instead of <tt>time.sleep()</tt>.

			=== Setting environmental variables ===

			Do not use <tt>os.environ</tt> to set environment variables for one command. Use <tt>env</tt> parameter of <tt>subprocess.Popen()</tt> instead.

	== GUI guidelines ==		== GUI guidelines ==

⚠️Wenzeslaus: other grass resources

2013-02-02T16:43:14Z

other grass resources

← Older revision		Revision as of 16:43, 2 February 2013
Line 2:		Line 2:

	__TOC__		__TOC__

			== List of other resources ==

			* <tt>SUBMITTING_WXGUI</tt> file (not exists yet)
			* <tt>SUBMITTING_PYTHON</tt> file (note that many things applies only to Python scripts)
			* GRASS Programming manual: [http://grass.osgeo.org/programming7/wxpythonlib.html wxGUI] (documentation and examples of usage)

	== Isolating different behavior by using wx-like styles ==		== Isolating different behavior by using wx-like styles ==