Move the GUI frontend doc out of the Qt implementation

[lilass.git] / gui.py

diff --git a/gui.py b/gui.py
index b6906e122af59c70f1310c9fa8538894ed15d0eb..b3929cbed6835543ed23add3663b461d6cc2bc9b 100644 (file)
--- a/gui.py
+++ b/gui.py
@@ -12,25 +12,54 @@
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program (gpl.txt); if not, write to the Free Software
+# along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
-# This file bstracts GUI stuff away, so that the actual dsl.py does not have to deal with it
+# This file abstracts GUI stuff away, so that the actual dsl.py does not have to deal with it
 import sys
-from PyQt4 import QtGui
-from qt_dialogue import PositionSelection
-app = QtGui.QApplication(sys.argv)
+
+'''
+This module implements two functions:
 
 def error(message):
-       '''Displays a fatal error to the user'''
-       QtGui.QMessageBox.critical(None, 'Fatal error', message)
-
-def getDialogue(externalName, internalResolutions, externalResolutions):
-       '''Returns a class implementing the following functions:
-        * run() opens the dialogue. returns True if it was accepted, False otherwise
-        * getRelativeScreenPosition() returns one of the RelativeScreenPosition values (see dsl.py)
-        * getIntResolutionIndex() returns the index of an element in the internalResolutions list
-        * getExtResolutionIndex() returns the index of an element in the externalResolutions list
-        * externalIsPrimary() returns whether the external screen is the primary one (True) or the internal one (False)
-       '''
-       return PositionSelection(externalName, internalResolutions, externalResolutions)
+       This function displays the error message to the user in some appropriate fassion
+
+def setup(internalResolutions, externalResolutions):
+       Both arguments are lists of (width, height) tuples of resolutions. You can use dsl.res2user to obtain a user-readable representation of a resolution tuple.
+       The user should be asked about his display setup preferences.
+       The function returns None if the user cancelled, and an instance of dsl.ScreenSetup otherwise.
+'''
+
+# frontend detectors
+def qtAvailable():
+       try:
+               import PyQt4
+               return True
+       except ImportError:
+               return False
+
+def zenityAvailable():
+       return True # FIXME
+
+# actual frontends
+if qtAvailable():
+       from PyQt4 import QtGui
+       from qt_dialogue import PositionSelection
+       app = QtGui.QApplication(sys.argv)
+       
+       def error(message):
+               QtGui.QMessageBox.critical(None, 'Fatal error', message)
+       
+       def setup(internalResolutions, externalResolutions):
+               return PositionSelection(internalResolutions, externalResolutions).run()
+
+elif zenityAvailable():
+       import subprocess
+       from zenity_dialogue import run as setup # this provides the setup function
+       
+       def error(message):
+               '''Displays a fatal error to the user'''
+               subprocess.check_call(["zenity", "--error", "--text="+message])
+
+else:
+       print >> sys.stderr, 'No GUI frontend available, please make sure PyQt4 or Zenity is installed'