home *** CD-ROM | disk | FTP | other *** search
/ GameStar 2006 January / Gamestar_80_2006-01_dvd.iso / Dema / Civilization4 / data1.cab / Civ4DemoComponent / Assets / Python / pyHelper / Popup.py next >
Encoding:
Python Source  |  2005-11-09  |  10.2 KB  |  265 lines
  1. ## Sid Meier's Civilization 4
  2. ## Copyright Firaxis Games 2005
  3. import CvUtil
  4. from CvPythonExtensions import *
  5.  
  6. class PyPopup:
  7.     ############## S E T U P    F U N C T I O N S ###################
  8.     def __init__(self, popupID=-1, contextType=EventContextTypes.NO_EVENTCONTEXT, bDynamic = True):
  9.         self.ID = popupID
  10.         self.popup = CyPopup(popupID, contextType, bDynamic)
  11.  
  12.     # Misc!    
  13.  
  14.     def isNone(self):
  15.         "verifies valid instance"
  16.         return self.popup.isNone()
  17.     
  18.     def launch(self, bCreateOkButton = True, eState = PopupStates.POPUPSTATE_IMMEDIATE):
  19.         "sets attributes to the popup launch"
  20.         self.popup.launch(bCreateOkButton, eState)
  21.     
  22.     def setUserData(self, userData):
  23.         "sets userData that is passed to OnOkClicked"
  24.         self.popup.setUserData(userData)
  25.     
  26.     def setPosition(self, iX, iY):
  27.         "set the location of the popup"
  28.         self.popup.setPosition(iX, iY)
  29.     
  30.     def setSize(self, iXS, iYS):
  31.         "sets the popups size"
  32.         self.popup.setSize(iXS, iYS)
  33.     
  34.     def addSeparator(self):
  35.         "adds a separator"
  36.         self.popup.addSeparator()
  37.     
  38.     # Header String
  39.     def    setHeaderString( self, strText, uiFlags = CvUtil.FONT_CENTER_JUSTIFY ):
  40.         "sets the header text"
  41.         self.popup.setHeaderString( strText, uiFlags )
  42.     
  43.     # Body String
  44.     def    setBodyString( self, strText, uiFlags = CvUtil.FONT_LEFT_JUSTIFY ):
  45.         "sets the body text"
  46.         self.popup.setBodyString( strText, uiFlags )
  47.     
  48.     def setPythonBodyString( self, strText, strName, strHelpText, uiFlags = CvUtil.FONT_LEFT_JUSTIFY ):
  49.         "PYTHON - sets a body string with help text"
  50.         self.popup.setPythonBodyString( strText, strName, strHelpText, uiFlags )
  51.     
  52.     def setPythonBodyStringXY( self, strText, strName, strHelpText, iX = -1, iY = -1, uiFlags = CvUtil.FONT_LEFT_JUSTIFY ):
  53.         self.popup.setPythonBodyStringXY( strText, strName, strHelpText, iX, iY, uiFlags )
  54.     
  55.     # Radio Buttons
  56.     def    createRadioButtons( self, iNumButtons, iGroup = 0 ):
  57.         "creates radio buttons - only 1 set allowed per popup"
  58.         self.popup.createRadioButtons( iNumButtons, iGroup )
  59.     
  60.     def    setRadioButtonText( self, iRadioButtonID, strText, iGroup = 0 ):
  61.         "sets radio button text - 0 based IDs"
  62.         self.popup.setRadioButtonText( iRadioButtonID, strText, iGroup )
  63.  
  64.     def    createPythonRadioButtons( self, iNumButtons, iGroup = 0 ):
  65.         "creates python radio buttons - only 1 set allowed per popup"
  66.         self.popup.createPythonRadioButtons( iNumButtons, iGroup )
  67.     
  68.     def    setPythonRadioButtonText( self, iRadioButtonID, strText, strHelpText, iGroup = 0 ):
  69.         "sets python radio button text - 0 based IDs"
  70.         self.popup.setPythonRadioButtonText( iRadioButtonID, strText, strHelpText, iGroup )
  71.     
  72.     # Check Boxes
  73.     def    createCheckBoxes( self, iNumBoxes, iGroup = 0 ):
  74.         "creates check boxes - only 1 set allowed per popup"
  75.         self.popup.createCheckBoxes( iNumBoxes, iGroup )
  76.         
  77.     def    setCheckBoxText( self, iCheckBoxID, strText, iGroup = 0 ):
  78.         "sets the check box text"
  79.         self.popup.setCheckBoxText( iCheckBoxID, strText, iGroup )
  80.  
  81.     def    createPythonCheckBoxes( self, iNumBoxes, iGroup = 0 ):
  82.         "creates Python check boxes - only 1 set allowed per popup"
  83.         self.popup.createPythonCheckBoxes( iNumBoxes, iGroup )
  84.         
  85.     def    setPythonCheckBoxText( self, iCheckBoxID, strText, strHelpText, iGroup = 0 ):
  86.         "sets the Python check box text"
  87.         self.popup.setPythonCheckBoxText( iCheckBoxID, strText, strHelpText, iGroup )
  88.         
  89.     # Edit Boxes
  90.     def    createEditBox( self, strText, iGroup = 0):
  91.         "adds an edit box"
  92.         self.popup.createEditBox( strText, iGroup )
  93.  
  94.     def    createEditBoxXY( self, strText, iX = -1, iY = -1, iGroup = 0):
  95.         "adds an edit box at XY"
  96.         self.popup.createEditBox( strText, iX, iY, iGroup )
  97.     
  98.     def    createPythonEditBox( self, strText, strHelpText, iGroup = 0):
  99.         "adds an Python edit box"
  100.         self.popup.createPythonEditBox( strText, strHelpText, iGroup )
  101.  
  102.     def    createPythonEditBoxXY( self, strText, strHelpText, iGroup = 0, iX = -1, iY = -1 ):
  103.         "adds an Python edit box at XY"
  104.         self.popup.createPythonEditBoxXY( strText, strHelpText, iGroup, iX, iY )
  105.  
  106.     def setEditBoxMaxCharCount( self, maxCharCount, preferredCharCount = 32, iGroup = 0 ):
  107.         "set the max character count and the preferred character count of the edit box"
  108.         self.popup.setEditBoxMaxCharCount( maxCharCount, preferredCharCount, iGroup )
  109.     
  110.     # Pull Down 
  111.     def    createPullDown( self, iGroup = 0 ):
  112.         "creates a pulldown menu"
  113.         self.popup.createPullDown( iGroup )
  114.     
  115.     def    createPullDownXY( self, iGroup = 0, iX = -1, iY = -1 ):
  116.         "creates a pulldown menu at XY"
  117.         self.popup.createPullDownXY( iGroup, iX, iY )
  118.     
  119.     def    addPullDownString( self, strText, iID, iGroup = 0 ):
  120.         "adds text to the pulldown"
  121.         self.popup.addPullDownString( strText, iID, iGroup )
  122.     
  123.     def    createPythonPullDown( self, strHelpText, iGroup = 0 ):
  124.         "creates a Python pulldown menu"
  125.         self.popup.createPythonPullDown( strHelpText, iGroup )
  126.     
  127.     def    createPythonPullDownXY( self, strHelpText, iGroup = 0, iX = -1, iY = -1 ):
  128.         "creates a Python pulldown menu at XY"
  129.         self.popup.createPythonPullDownXY( strHelpText, iGroup, iX, iY )
  130.     
  131.     # List Box
  132.     def    createListBox( self, iGroup = 0 ):
  133.         "creates a listbox"
  134.         self.popup.createListBox( iGroup )
  135.  
  136.     def    createListBoxXY( self, iGroup = 0, iX = -1, iY = -1 ):
  137.         "creates a listbox at XY"
  138.         self.popup.createListBoxXY( iGroup, iX, iY )
  139.  
  140.     def    addListBoxString( self, strText, iID, iGroup = 0 ):
  141.         "adds list box IDs"
  142.         self.popup.addListBoxString( strText, iID, iGroup )
  143.  
  144.     def    createPythonListBox( self, strHelpText, iGroup = 0 ):
  145.         "creates a Python listbox"
  146.         self.popup.createPythonListBox( strHelpText, iGroup )
  147.  
  148.     def    createPythonListBoxXY( self, strHelpText, iGroup = 0, iX = -1, iY = -1 ):
  149.         "creates a Python listbox at XY"
  150.         self.popup.createPythonListBoxXY( strHelpText, iGroup, iX, iY )
  151.     
  152.     # spin Box
  153.     def    createSpinBox( self, iIndex, strHelpText, iDefault, iIncrement, iMax, iMin ):
  154.         "creates a listbox"
  155.         self.popup.createSpinBox( iIndex, strHelpText, iDefault, iIncrement, iMax, iMin )
  156.  
  157.     # Buttons
  158.     def    addButton( self, strText ):
  159.         "adds a Button"
  160.         self.popup.addButton( strText )
  161.  
  162.     def    addButtonXY( self, strText, iX = -1, iY = -1 ):
  163.         "adds a Button at XY"
  164.         self.popup.addButtonXY( strText, iX, iY )
  165.     
  166.     def addPythonButton( self, strFunctionName, strButtonText, strHelpText, strArtPointer = "Art\Interface\Popups\PopupRadioButton.kfm", iData1 = -1, iData2 = -1, bOption = True):
  167.         "adds a python button"
  168.         self.popup.addPythonButton( strFunctionName, strButtonText, strHelpText, strArtPointer, iData1, iData2, bOption )
  169.     
  170.     def addPythonButtonXY( self, strFunctionName, strButtonText, strHelpText, strArtPointer = "Art\Interface\Popups\PopupRadioButton.kfm", iData1 = -1, iData2 = -1, bOption = True, iX = -1, iY = -1 ):
  171.         "adds a python button at XY"
  172.         self.popup.addPythonButtonXY( strFunctionName, strButtonText, strHelpText, strArtPointer, iData1, iData2, bOption, X, iY )    
  173.  
  174.     # Graphics        
  175.     def    addDDS( self, strImageLocation, iX, iY, iWidth, iHeight ):
  176.         "adds a DDS"
  177.         self.popup.addDDS( strImageLocation, iX, iY, iWidth, iHeight )
  178.             
  179.     def    addPythonDDS( self, strImageLocation, strHelpText, iX, iY, iWidth, iHeight ):
  180.         "adds a DDS"
  181.         self.popup.addPythonDDS( strImageLocation, strHelpText, iX, iY, iWidth, iHeight )
  182.         
  183.     ############## T A B L E    F U N C T I O N S ###################
  184.     
  185.     def createTable( self, iRows, iColumns, iGroup = 0 ):
  186.         "creates a table that is size X, Y with GroupID"
  187.         self.popup.createTable( iRows, iColumns, iGroup )
  188.         #CvUtil.pyPrint( "py.Popup createTable( %d, %d )" %(iRows, iColumns) )
  189.     
  190.     def setTableCellSize( self, iCol, iPixels, iGroup = 0 ):
  191.         "set the size of the Cell - required before info is added"
  192.         self.popup.setTableCellSize( iCol, iPixels, iGroup )
  193.     
  194.     def setTableYSize( self, iRow, iSize, iGroup = 0 ):
  195.         "sets the size of the Row"
  196.         self.popup.setTableYSize( iRow, iSize, iGroup )
  197.         
  198.     def addTableCellText( self, iRow, iCol, strText, iGroup = 0):
  199.         "adds text to a Cell"
  200.         if strText == 0 or strText == False or strText == 'None':
  201.             self.addTableBlank( iRow, iCol, iGroup )
  202.             return
  203.         self.popup.addTableCellText( iRow, iCol, unicode(strText), iGroup )        
  204.     
  205.     def addTableBlank( self, iRow, iCol, iGroup = 0 ):
  206.         "adds a blank entry to a table"
  207.         self.addTableCellText( iRow, iCol, "", iGroup )
  208.     
  209.     def addTableCellImage( self, iRow, iCol, strImageLocation, iGroup = 0 ):
  210.         "sets a table cell to locate a cell in the table and have it use an image"
  211.         if strImageLocation:
  212.             self.popup.addTableCellImage( iRow, iCol, str(strImageLocation), iGroup )
  213.             return
  214.         self.addTableBlank( iRow, iCol, iGroup )
  215.     
  216.     def addTableCellDDS( self, iRow, iCol, strImageLocation, iX = 5, iY = 5, iWidth = 20, iHeight = 20, iGroup = 0 ):
  217.         "adds a DDS image to the popup - iX/iY are location, iWidth/iHeight adjust the DDS size"
  218.         if strImageLocation:
  219.             self.popup.addTableCellDDS( iRow, iCol, str(strImageLocation), iX, iY, iWidth, iHeight, iGroup )
  220.             return
  221.         self.addTableBlank( iRow, iCol, iGroup )
  222.     
  223.     def    completeTableAndAttach( self, iGroup = 0, iX = -1, iY = -1 ):
  224.         "completes a Table and Adds it to the popup - iX,iY are for the Tables Location"
  225.         self.popup.completeTableAndAttach( iGroup )
  226.     
  227.     
  228. ############ G R O U P      T A B L E S #########################        
  229.         
  230.     def addTitleData(self, TitleList, SizeYTitle = 34):
  231.         "Takes a list of title data and adds it to the popup - (iType, iSize, Name, Data"
  232.         TEXT = 0
  233.         DDS  = 1
  234.         IMG  = 2
  235.         
  236.         for i in range(len(TitleList)):
  237.             titleType, titleName, titleSize = TitleList[i]
  238.                 
  239.             # handle setting title size
  240.             self.setTableCellSize(i, titleSize)
  241.             
  242.             if titleType: # if image type
  243.                 strFileLocation = titleName #file location is the 2nd entry
  244.                 
  245.                 if titleType == DDS:
  246.                     data = loopTitle[3]
  247.                     iX, iY, iWidth, iHeight = data
  248.                     self.addTableCellDDS(0, i, strFileLocation, iX, iY, iWidth, iHeight)
  249.                 
  250.                 elif titleType == IMG:
  251.                     self.popup.addTableCellImage(0, i, strFileLocation)
  252.             
  253.             else:
  254.                 self.addTableCellText(0, i, titleName)
  255.         self.setTableYSize(0, SizeYTitle)
  256.  
  257.     def addTableData(self, TableData):
  258.         'Adds data to the table'
  259.         iLenTable = len(TableData)
  260.         for i in range(iLenTable):
  261.             loopRowData = TableData[i]
  262.             self.addTableCellText(i+1, 0, loopRowData[0])
  263.             for j in range(len(loopRowData[1])):
  264.                 self.addTableCellText(i+1, j+1, loopRowData[1][j])
  265.