Functions and Settings
Previous topic  First topic  Next topic


Marinas-GUI has some Functions and Settings (SET command) for additional tasks.
Marinas-GUI tiene algunas Funciones y Seteos (comando SET) para tareas adicionales.

In this topic you can see these Functions and Settings.
En este tópico usted puede ver dichas Funciones y Seteos.

Note: if you see the sources for marinas-gui or his tools, you can see a lot of functions defined, but, for convention, you can only use those functions whose name begins with mg_
Functions whose name begins with __mg_ are for internal use only and can be changed or deleted without previous notification.

Nota: si usted mira dentro de los fuentes de marinas-gui o las herramientas que la acompañan va a encontrar muchas funciones, pero, por convención, usted puede usar solamente aquellas funciones cuyos nombres comiencen con mg_
Funciones cuyos nombres comienzan con __mg_ son de uso interno solamente y pueden ser cambiadas o eliminadas sin previo aviso.



Functions
 

   mg_allStr ( xValue )

      Description:
         This function convert any value type to character string. Including arrays and hashes

      Parameters:
      xValue = any value

      Return Value:
      xValue converted to string var type


   mg_barcodeGetFinalHeight ( cString [ , cType ] [ , nBarWidth ] )

      Description:
         This function is used to calculates the exact height that would occupy a barcode (very usefull with barcodes like QRCode).

      Parameters:
      cString = Text for the barcode
      cType = Barcode type (default: "Code128")
      bBarWidth = Bar width (or dot width for barcodes like "QRCode") (Default: 1)


      Return Value:
      Barcode height in pixels.


   mg_barcodeGetFinalWidth ( cString [ , cType ] [ , nBarWidth ] )

      Description:
         This function is used to calculates the exact width that would occupy a barcode.

      Parameters:
      cString = Text for the barcode
      cType = Barcode type (default: "Code128")
      bBarWidth = Bar width (or dot width for barcodes like "QRCode") (Default: 1)


      Return Value:
      Barcode width in pixels.


   mg_barcodeSaveToFile ( cString [ , cType ] [ , cFilename ] [ , nWidth ] [ , nHeight ] [ , nBarWidth ] [ , aBackColor ] [ , aFontColor ] )

      Description:
         This function is used to generate an stand alone BARCODE image. The image file type will be chosen from fileName's suffix. Default image type is 'png' and allowed types are: 'bmp', 'jpeg', 'jpg' and 'png'

      Parameters:
      cString = Text for the barcode
      cType = Barcode type (default: "Code128")
      cFileName = File name for the image (default: "__mg_barcode_image_#####.png" where ##### are seconds() )
      nWidth := WIDTH of the image file (Default: the exact barcode width)
      nHeight = HEIGHT of the image (Default: the exact barcode height)
      bBarWidth = Bar width (or dot width for barcodes like "QRCode") (Default: 1)
      aBackColor = Backcolor of image (Default: {255,255,255})
      aFontColor = Forecolor of barcode (Default: {0,0,0})


      Return Value:
      Function returns .T. or .F. for success or not


   mg_clipboardClear ()

      Description:
         This function is used to clear the system clipboard

      Parameters:
      NIL

      Return Value:
      Function always returns NIL


   mg_clipboardGetData ( [ bNoShowErrorMessage ] )

      Description:
         This function is used to get the clipboard contents

      Parameters:
      bNoShowErrorMessage = This parameter is used if you do not like to receive an error message when clipboard is empty or when function returns an clipboard error

      Return Value:
      Function returns NIL if an error occurs or if clipboard is empty. If not, it returns the clipboard data


   mg_clipboardGetDataType ( [ bNoShowErrorMessage ] )

      Description:
         This function is used to get the type of clipboard contents

      Parameters:
      bNoShowErrorMessage = This parameter is used if you do not like to receive an error message when clipboard is empty or when function returns an clipboard error

      Return Value:
      Function returns NIL if an error occurs or if clipboard is empty. If not, it returns the clipboard data type: "image", "html" or "text"


   mg_clipboardSendData ( xData [ , cType ] )

      Description:
         This function is used to put a data into clipboard, if cText was ommited, "text" mode is used

      Parameters:
      xData = Data to put into clipboard
      cType = (Optional) force the data type of xData: "image", "html" or "text". Default is "text"


      Return Value:
      Function returns .T. if data was put into clipboard, if not, it returns .F.


   mg_clipboardShowData ()

      Description:
         This function opens a dialog window with the clipboard contents

      Parameters:
      NIL

      Return Value:
      Function always returns NIL


   mg_dISABLEALLACTIVATEDWINDOW ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_destroyControl ( cWindow , cControl )

      Description:
         This function is used to destroy a previously created control

      Parameters:
      cWindow = Window name
      cControl = Control name


      Return Value:
      Function returns .T. if control was destoyed, if not, it returns .F.


   mg_do ( cWindow [ , cControl ] , cMethod [ , xMethodParms , ... ] )

      Description:
         Execute method block coded in CREATE or seted by mg_Set

      Parameters:
      cWindow = Name of window widget
      cControl = (Optional) Name of control widget
      cMethod = Method name
      xMethodParms = (Optional) Extra parms for method
      


      Return Value:
      Function returns .T. for Succesful
      Function returns .F. when property didn't DO



   mg_eNABLEALLACTIVATEDWINDOW ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_execute ( cCommand [ , cParm ] [ , bWait ] [ , bHide ] [ , bMinimize ] [ , bMaximize ] [ , cFileIn ] [ , cFileOut ] [ , cWorkingDirectory ] ) )

      Description:
         This function is used to execute an external commnad. It is the same that use
command.

      Parameters:
      cCommand = Command to execute
      cParm = (Optional) parameters for cCommand
      bWait = (Optional) If .T., process wait to cCommnad finish
      bHide = (Optional) If .T., process will be executed hidden
      bMinimize = (Optional) If .T., process will be executed minimized
      bMaximize = (Optional) If .T., process will be executed maximized
      cFileIn = (Optional) Redirect Standard Input to this file
      cFileOut = (Optional) Redirect standard output and error output to this file
      cWorkingDirectory = (Optional) Set working directory to this folder


      Return Value:
      Function returns the cCommand return code or an error code. Refer to EXECUTE command for more information or press



   mg_get ( cWindow [ , cControl ] , cProperty [ , xPropertyParms , ... ] , xNewValue )

      Description:
         Set a control or window property

      Parameters:
      cWindow = Name of window widget
      cControl = (Optional) Name of control widget
      cProperty = Property name
      xPropertyParms = (Optional) Extra parms for property
      xNewValue = New property value


      Return Value:
      Function returns the property value. the value type is depending of Property
      Function returns .F. when operation didn't succesful



   mg_getACTIVEINIFILE ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getALLACTIVATEDWINDOWNAME ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getAPPLICATIONCURSOR ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getAPPLSTYLE ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getAPPLWINDOWNAME ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getAdjustFontSize ()

      Description:
         This function returns the active increment/decrement for application font size

      Parameters:
      NIL

      Return Value:
      An integer value representing the nIncrement or nDecrement


   mg_getAdjustFontSizeEnabled ()

      Description:
         Used to ask about state of ADJUST FONT SIZE setting

      Parameters:
      NIL

      Return Value:
      This function returns .T. if adjust font size is enabled (default) or .F. if not.


   mg_getBITSBYARCHITECTURE ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getCLASSNAME ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getCOMMONPROGRAMSFOLDER ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getCOMPUTERNAME ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getCURRENTFOLDER ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getColor ( [ cTitle ] [ , cBaseColor ] )

      Description:
         Open Dialog to select a new Color

      Parameters:
      cTitle = (Optional) Dialog Window Title
      cBaseColor = (Optional) An RGB color array to open dialog in this color
      For example: { 125 , 43 , 134 }


      Return Value:
      Function returns the selected color in an RGB color array or an empty array if dialog was canceled


   mg_getControlParentName ( cWindow , cControl )

      Description:
         This function is used to query the name of the parent widget where this control has been defined

      Parameters:
      cWindow = Window Name
      cControl = Control Name


      Return Value:
      Function returns control name of parent widget as string. e.g.: WINDOW, TAB, etc. If cControl don't exists into cWindow, this function returns an empty string


   mg_getControlParentType ( cWindow , cControl )

      Description:
         This function is used to query the type of the parent widger where this control has been defined

      Parameters:
      cWindow = Window Name
      cControl = Control Name


      Return Value:
      Function returns control type of parent widget as string. e.g.: WINDOW, TAB, etc. If cControl don't exists into cWindow, this function returns an empty string


   mg_getControlType ( cWindow , cControl )

      Description:
         This function is used to query the type of control of an previously created control into a specific window

      Parameters:
      cWindow = Window Name
      cControl = Control Name


      Return Value:
      Function returns control type as string. e.g.: BUTTON, TEXTBOX, SPINNER, etc. If cControl don't exists into cWindow, this function returns an empty string


   mg_getDECIMALPOINT ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getDEFAULTFONTNAME ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getDEFAULTFONTSIZE ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getDEFAULTICONNAME ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getDEFAULTPNGNAME ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getDESKTOPACTIVE ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getDESKTOPFAMILYACTIVE ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getDESKTOPFOLDER ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getDESKTOPSINSTALLED ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getDesktopCol ()

      Description:
         This function returns the top column of desktop (Incluying TASK BAR). Normally, this value is 0 (zero)

      Parameters:
      NIL

      Return Value:
      Function returns an INTEGER value representing top column Desktop in pixels


   mg_getDesktopFreeCol ()

      Description:
         This function returns the top column of desktop (Excluding TASK BAR). Normally, this value is greater 0 (zero) when OS Task Bar is in the left Desktop.

      Parameters:
      NIL

      Return Value:
      Function returns an INTEGER value representing top column Desktop in pixels


   mg_getDesktopFreeHeight ()

      Description:
         This function returns the total FREE desktop height (Excluding TASK BAR)

      Parameters:
      NIL

      Return Value:
      Function returns an INTEGER value representing the Height of Desktop in pixels


   mg_getDesktopFreeRow ()

      Description:
         This function returns the top row of desktop (Excluding TASK BAR). Normally, this value is greater 0 (zero) when OS Task Bar is in the top Desktop.

      Parameters:
      NIL

      Return Value:
      Function returns an INTEGER value representing top row Desktop in pixels


   mg_getDesktopFreeWidth ()

      Description:
         This function returns the total FREE desktop width (Excluding TASK BAR)

      Parameters:
      NIL

      Return Value:
      Function returns an INTEGER value representing the Width of Desktop in pixels


   mg_getDesktopHeight ()

      Description:
         This function returns the total desktop height (Incluying TASK BAR)

      Parameters:
      NIL

      Return Value:
      Function returns an INTEGER value representing the Height of Desktop in pixels


   mg_getDesktopRow ()

      Description:
         This function returns the top row of desktop (Incluying TASK BAR). Normally, this value is 0 (zero)

      Parameters:
      NIL

      Return Value:
      Function returns an INTEGER value representing top row Desktop in pixels


   mg_getDesktopWidth ()

      Description:
         This function returns the total desktop width (Incluying TASK BAR)

      Parameters:
      NIL

      Return Value:
      Function returns an INTEGER value representing the Width of Desktop in pixels


   mg_getEXTFORBAT ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getEXTFORDLL ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getEXTFOREXE ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getFILEPERMISSIONS ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getFOCUSEDCONTROLNAME ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getFONTFAMILYLIST ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getFile ( [ aFilters ] [ , cTitle ] [ , cBaseFolder ] [ , bMultiselect ] [ , bNoChangeDir ] [ , bAllowNewFile ] )

      Description:
         Open Dialog to select a file or several files as input

      Parameters:
      aFilters = (Optional) An array containing "n" arrays by each filename filter.
      For example: { {"Source files","*.prg;*.c;*.cpp"} , {"Only PRG files","*.prg"} }
      cTitle = (Optional) Dialog Window Title
      cBaseFolder = (Optional) Folder or file for first time open dialog
      bMultiSelect = (Optional) Allow multi file selection (default=.F.)
      bNoChangeDir = (Optional) if .F., when dialog finished does change current folder (default=.T.)
      bAllowNewFile = (Optional) Allow user to select a file that doesn't exists (default=.F.)


      Return Value:
      Function returns an string with the file name selected if bAllowMultiSelect=.F., or an array of filenames if bAllowMultiSelect=.T.. For Dialog canceled, return an empty string or an empty array respectively


   mg_getFocusedWindowName ()

      Description:
         This function returns the name of the focused window.

      Parameters:
      NIL

      Return Value:
      Function returns window name as string. If doesn't have any focused window, this function returns an empty string


   mg_getFolder ( [ cTitle ] [ , cBaseFolder ] )

      Description:
         Open Dialog to select a folder as input

      Parameters:
      cTitle = (Optional) Dialog Window Title
      cBaseFolder = (Optional) Folder for first time open dialog


      Return Value:
      Function returns an string with the folder name selected. For Dialog canceled, return an empty string


   mg_getFont ( [ cTitle ] [ , HFontAttributes ] )

      Description:
         Open Dialog to select a new Font Family and their attributes

      Parameters:
      cTitle = (Optional) Dialog Window Title
      HFontAttributes = (Optional) An HASH containing initial values for the dialog
      For example (in short format): { "InitialFontName" => "mg_monospace" , "InitialFontSize" => 16 }
      In standard format you only need specify the HASH name containing keys like "InitialFontName" or "InitialFontBold"
      Keys available are all properties for FONTDIALOG control


      Return Value:
      Return an HASH with the following keys and their respective values: "FontName", "FontSize", "FontBold", "FontItalic", "FontUnderline" and "FontStrikeout"


   mg_getHOMEFOLDER ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getHelpFile ()

      Description:
         This function returns the user defined Help FileName previously defined by "SET HELPFILE TO cFileName". If HELPFILE wasn't SET, this function return an empty string

      Parameters:
      NIL

      Return Value:
      This function returns the file name of Help File. If Help File wasn't defined, this function returns an empty string


   mg_getINTERNALINFO ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getInstanceCount ( cFile )

      Description:
         This function return the amount of cFile running in the system

      Parameters:
      cFile = Name of Executable, you can specify only name and extension or full path with name and extension

      Return Value:
      This function return an array with full path of all occurs of cFile running in the system. Or an empty array if cFile isn't running in the system.


   mg_getLASTFOCUSEDCONTROLNAME ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getLASTFOCUSEDWINDOWNAME ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getLINKHBMODE ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getLINKQTMODE ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getLOGFILENAME ( ... )

      Description:
         Press
to go to this topic

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getLastActivatedWindowName ()

      Description:
         This function returns the name of the last window activate.

      Parameters:
      NIL

      Return Value:
      Function returns window name as string. If doesn't have any active window, this function returns an empty string


   mg_getLastAllActivityTimestamp ()

      Description:
         This function will returns the last activity timestamp for ALL events in format YYYYMMDDHHMMSScc

      Parameters:
      NIL

      Return Value:
      Last activity timestamp


   mg_getLastUserActivityTimestamp ()

      Description:
         This function will returns the last activity timestamp for USER events in format YYYYMMDDHHMMSScc

      Parameters:
      NIL

      Return Value:
      Last activity timestamp


   mg_getLogAllActivityTimestamp ()

      Description:
         Check status for write ALL application activity to application log file

      Parameters:
      NIL

      Return Value:
      .T. or .F.


   mg_getLogUserActivityTimestamp ()

      Description:
         Check status for write USER application activity to application log file

      Parameters:
      NIL

      Return Value:
      .T. or .F.


   mg_getMASKALLFILES ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getMILLARSEPARATOR ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getMONEYIDENTIFIER ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getMainMenuName ( cWindow )

      Description:
         This function is used to ask for MAIN MENU control name because MAIN MENU doesn't has an mandatory name.

      Parameters:
      cWindow = Window name

      Return Value:
      Function returns the name of MAIN MENU control of window cWindow


   mg_getMainWindowName ()

      Description:
         This function returns the name of the MAIN window.

      Parameters:
      NIL

      Return Value:
      Function returns window name as string. If doesn't have any MAIN window, this function returns an empty string


   mg_getPLATFORM ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPRINTERALIGN ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPRINTERCOLLATE ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPRINTERCOLORMODE ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPRINTERCOPIES ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPRINTERCUSTOMPAPERSIZE ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPRINTERDEFAULT ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPRINTERDEFAULTSOURCE ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPRINTERDIALOG ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPRINTERDUPLEX ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPRINTERLIST ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPRINTERMARGINBOTTOM ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPRINTERMARGINLEFT ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPRINTERMARGINRIGHT ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPRINTERMARGINTOP ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPRINTERNAME ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPRINTERORIENTATION ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPRINTERPAPERSIZE ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPRINTERPAPERSIZELIST ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPRINTERPREVIEW ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPRINTERQUALITY ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPRINTERS ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPRINTERUNITS ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPROGRAMBITS ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPROGRAMFILESFOLDER ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getPlatformEditKey ( [ lNumeric ] )

      Description:
         This function return the key name of Platform Edit Key. Eg. at Windows, that function returns "F2".
If you coded .T. at lNumeric parameter, that function returns the numeric value of Platform Edit Key. Eg. at Windows, that function returns the Qt_Key_F2 value


      Parameters:
      lNumeric = (Optional ) Platform Edit Key as numeric

      Return Value:
      Platform Edit Key (Name or Number)


   mg_getQUICKLAUNCHMENUFOLDER ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getSTARTMENUFOLDER ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getSTYLEFONT ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getSTYLEPEN ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getSUDOGUI ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getSYSTEMFOLDER ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getSuspendAllActivityTimestamp ()

      Description:
         Check status for suspend reset activity for ALL events

      Parameters:
      NIL

      Return Value:
      .T. or .F.


   mg_getSuspendUserActivityTimestamp ()

      Description:
         Check status for suspend reset activity for ALL events

      Parameters:
      NIL

      Return Value:
      .T. or .F.


   mg_getTEMPFOLDER ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getUSERNAME ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_getVisibleOrdKeyNo ( cAlias )

      Description:
         This function returns the correct recNo for a DBF with or without records filterd and/or SET DELETED ON. The original Harbour function ordKeyNo() could return an invalid ordKeyNo if your DBF has records deleted or filtered before current record. The Marinas function always return the correct recNo in the index order.

      Parameters:
      cAlias

      Return Value:
      Function returns the visible recNo in the set order index.


   mg_getWindowBorderHeight ( cWindow )

      Description:
         This function is used to query the height of a window border. Can be used to calculate the full area filled by a window in this way: nFullAreaHeight := mg_do( "win" , "getTitlebarHeight" ) + mg_get( "win" , "height" ) + ( mg_getWindowBorderHeight( "win" ) * 2 )
Method "getBorderHeight" of WINDOW does the same job.


      Parameters:
      cWindow = Window Name

      Return Value:
      Function returns the height of border of a window.


   mg_getWindowBorderWidth ( cWindow )

      Description:
         This function is used to query the width of a window border. Can be used to calculate the full area filled by a window in this way: nFullAreaWidth := mg_get( "win" , "width" ) + ( mg_getWindowBorderWidth( "win" ) * 2 )
Method "getBorderWidth" of WINDOW does the same job.


      Parameters:
      cWindow = Window Name

      Return Value:
      Function returns the width of border of a window.


   mg_getWindowTitleBarHeight ( cWindow )

      Description:
         This function is used to query the height of a window titlebar. Can be used to calculate the full area filled by a window in this way: nFullAreaHeight := mg_getWindowTitlebarHeight( "win" ) + mg_get( "win" , "height" ) + ( mg_do( "win" , "getBorderHeight" ) * 2 )
Method "getTitleBarHeight" of WINDOW does the same job.


      Parameters:
      cWindow = Window Name

      Return Value:
      Function returns the height of titlebar of a window.


   mg_getWindowType ( cWindow )

      Description:
         This function is used to query the type of windows of an previously created window

      Parameters:
      cWindow = Window Name

      Return Value:
      Function returns window type as string. Values returned: MAIN | MODAL | CHILD. If cWindow don't exists, this function returns an empty string


   mg_hideSplashWindow ()

      Description:
         Hide the splash window

      Parameters:
      NIL

      Return Value:
      Function returns NIL


   mg_inputDIALOG ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_isControlCreated ( cWindow , cControl )

      Description:
         This function is used to test if a control was created into a window or not

      Parameters:
      cWindow = Window Name
      cControl = Control Name


      Return Value:
      Function returns .T. if cControl was created into cWindow
      Function returns .F. if cControl wasn't created into cWindow



   mg_isDESKTOPACTIVE ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_isDESKTOPINSTALLED ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_isFONTAVAILABLE ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_isKEYCREATED ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_isPLATFORM ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_isQTDYNAMICLINK ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_isQTSTATICLINK ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_isROOTFOLDER ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_isWINDOWACTIVATED ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_isWindowActive ( cWindow )

      Description:
         This function is used to test if a window is active or not

      Parameters:
      cWindow = Window Name

      Return Value:
      Function returns .T. if cWindow is active
      Function returns .F. if cWindow isn't active



   mg_isWindowCreated ( cWindow )

      Description:
         This function is used to test if a window was created or not

      Parameters:
      cWindow = Window Name

      Return Value:
      Function returns .T. if cWindow was created
      Function returns .F. if cWindow wasn't created



   mg_isWindowFullScreen ( cWindow )

      Description:
         This function is used to test if a window is FullScreen or not

      Parameters:
      cWindow = Window Name

      Return Value:
      Function returns .T. or .F.


   mg_isWindowHidden ( cWindow )

      Description:
         This function is used to test if a window is Hidden or not

      Parameters:
      cWindow = Window Name

      Return Value:
      Function returns .T. or .F.


   mg_isWindowMaximized ( cWindow )

      Description:
         This function is used to test if a window is Maximized or not

      Parameters:
      cWindow = Window Name

      Return Value:
      Function returns .T. or .F.


   mg_isWindowMinimized ( cWindow )

      Description:
         This function is used to test if a window is Minimized or not

      Parameters:
      cWindow = Window Name

      Return Value:
      Function returns .T. or .F.


   mg_isWindowShowNormal ( cWindow )

      Description:
         This function is used to test if a window is Visible in Normal Mode or not.
ShowNormal == !mg_isWindowMinimized( cWin ) .AND. ;
!mg_isWindowMaximized( cWin ) .AND. ;
!mg_isWindowFullScreen( cWin )


      Parameters:
      cWindow = Window Name

      Return Value:
      Function returns .T. or .F.


   mg_isWindowVisible ( cWindow )

      Description:
         This function is used to test if a window is Visible or not

      Parameters:
      cWindow = Window Name

      Return Value:
      Function returns .T. or .F.


   mg_lastKey ( cWindow )

      Description:
         This function return the name of last key pressed (without modifiers) or *InvalidKey* if last key pressed isn't in the hbqt key list. If *InvalidKey* was returned, you can get the key value by calling to the mg_LastKeyInvalid() function.

      Parameters:
      cWindow = Window Name

      Return Value:
      Name of last key pressed


   mg_lastKeyInvalid ( cWindow )

      Description:
         This function return the code of last invalid key pressed (without modifiers).

      Parameters:
      cWindow = Window Name

      Return Value:
      Code of last invalid key pressed or it returns an empty string if never pressed an invalid key


   mg_lastKeyMod ( cWindow )

      Description:
         This function return the name of last modifier key pressed or *InvalidKey* if last modifier key pressed isn't in the hbqt key list. If *InvalidKey* was returned, you can get the key value by calling to the mg_LastKeyModInvalid() function.

      Parameters:
      cWindow = Window Name

      Return Value:
      Name of last modifier key pressed


   mg_lastKeyModInvalid ( cWindow )

      Description:
         This function return the code of last invalid modifier key pressed.

      Parameters:
      cWindow = Window Name

      Return Value:
      Code of last invalid modifier key pressed or it returns an empty string if never pressed an invalid modifier key


   mg_log ( ... )

      Description:
         Press
to go to this topic

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_msgCANCELNOYES ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_msgCANCELOK ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_msgCANCELRETRY ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_msgCANCELYESNO ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_msgINFO ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_msgNOCANCELYES ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_msgNOYES ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_msgNOYESCANCEL ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_msgOKCANCEL ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_msgRETRYCANCEL ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_msgSTOP ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_msgWARNING ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_msgYESNO ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_msgYESNOCANCEL ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_putFile ( [ aFilters ] [ , cTitle ] [ , cBaseFolder ] [ , bMultiselect ] [ , bNoChangeDir ] [ , bAllowNewFile ] )

      Description:
         Open Dialog to select a file or several files as output

      Parameters:
      aFilters = (Optional) An array containing "n" arrays by each filename filter.
      For example: { {"Source files","*.prg;*.c;*.cpp"} , {"Only PRG files","*.prg"} }
      cTitle = (Optional) Dialog Window Title
      cBaseFolder = (Optional) Folder or file for first time open dialog
      bMultiSelect = (Optional) Allow multi file selection (default=.F.)
      bNoChangeDir = (Optional) if .F., when dialog finished does change current folder (default=.T.)
      bAllowNewFile = (Optional) Allow user to select a file that doesn't exists (default=.F.)


      Return Value:
      Function returns an string with the file name selected if bAllowMultiSelect=.F., or an array of filenames if bAllowMultiSelect=.T.. For Dialog canceled, return an empty string or an empty array respectively


   mg_putFolder ( [ cTitle ] [ , cBaseFolder ] )

      Description:
         Open Dialog to select a folder as output

      Parameters:
      cTitle = (Optional) Dialog Window Title
      cBaseFolder = (Optional) Folder for first time open dialog


      Return Value:
      Function returns an string with the folder name selected. For Dialog canceled, return an empty string


   mg_qtBUILDVERSION ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_qtRUNVERSION ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_refreshSplashWindow ()

      Description:
         Raise the splash window

      Parameters:
      NIL

      Return Value:
      Function returns NIL


   mg_resetLastAllActivityTimestamp ()

      Description:
         This function will force a reset of timestamp for ALL events

      Parameters:
      NIL

      Return Value:
      This function always returns NIL


   mg_resetLastUserActivityTimestamp ()

      Description:
         This function will force a reset of timestamp for ALL events

      Parameters:
      NIL

      Return Value:
      This function always returns NIL


   mg_resetPRINTER ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_resourceDetachToFile ( cFileAlias , cFileName , [ BProgress ] , [ @lStopVarByReference ] , [ lReplace ] )

      Description:
         This function detach an attached file to a phisical file

      Parameters:
      cFileAlias = Alias name used in RC file
      cFileName = Output file name
      BProgress = (Optional) Block for progress with two values: nPartial and nTotal bytes
      lStopVarByReference = (Optional) Variable passed by reference to stop the detach process
      lReplace = (Optional) Replace file if already exists


      Return Value:
      .T. (success) or .F. (failed)


   mg_resourceDetachToVar ( cFileAlias , @cVarNameByReference , [ BProgress ] , [ @lStopVarByReference ] )

      Description:
         This function detach an attached file to a memo variable

      Parameters:
      cFileAlias = Alias name used in RC file
      cVarNameByReference = Output memo var name passed by reference
      BProgress = (Optional) Block for progress with two values: nPartial and nTotal bytes
      lStopVarByReference = (Optional) Variable passed by reference to stop the detach process


      Return Value:
      .T. (success) or .F. (failed)


   mg_resourceFileSize ( cFileAlias )

      Description:
         This function returns the size of attached alias file

      Parameters:
      cFileAlias = Alias name for attached file

      Return Value:
      File size in bytes


   mg_resourceList ()

      Description:
         List all user attached files to executable

      Parameters:
      NIL

      Return Value:
      This function returns a bidimentional array containing a row with cAliasName and nFileSize by each attached file


   mg_saveSCREEN ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_set ( cWindow [ , cControl ] , cProperty [ , xPropertyParms , ... ] , xNewValue )

      Description:
         Set a control or window property

      Parameters:
      cWindow = Name of window widget
      cControl = (Optional) Name of control widget
      cProperty = Property name
      xPropertyParms = (Optional) Extra parms for property
      xNewValue = New property value


      Return Value:
      Function returns .T. for Succesful
      Function returns .F. when property didn't SET



   mg_setACTIVEINIFILE ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setAPPLICATIONCURSOR ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setAPPLSTYLE ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setAdjustFontSize ( nValue )

      Description:
         Used to set the increment or decrement for ADJUST FONT SIZE setting. Using +1 or -1, this function simulates the keys '+' and '-' to increment/decrement application font size from program

      Parameters:
      nValue = increment or decrement value (integer)

      Return Value:
      This function returns NIL


   mg_setAdjustFontSizeEnabled ( lSet )

      Description:
         Used to set the state of ADJUST FONT SIZE setting

      Parameters:
      lSet = .T. or .F.

      Return Value:
      This function returns NIL


   mg_setCURRENTFOLDER ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setDECIMALPOINT ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setLOGFILENAME ( ... )

      Description:
         Press
to go to this topic

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setLogAllActivityTimestamp ( lLog )

      Description:
         This function will enable/disable write ALL activity into application log file. Warning!!! this function will produce a loss of performance. Remember, the application log file has the same name that application executable but with ".log" as extension file name

      Parameters:
      lLog = .T. or .F.

      Return Value:
      This function always returns NIL


   mg_setLogUserActivityTimestamp ( lLog )

      Description:
         This function will enable/disable write USER activity into application log file. Warning!!! this function will produce a loss of performance. Remember, the application log file has the same name that application executable but with ".log" as extension file name

      Parameters:
      lLog = .T. or .F.

      Return Value:
      This function always returns NIL


   mg_setMONEYIDENTIFIER ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setMultiple ( bMultiple [ , bWarning ] )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      bMultiple = .T. or .F.
      bWarning = (Optional) Allow execution of this instance but send a message warning


      Return Value:
      This function allow user to prevent more than one execution of the same program (set bMultiple to .F.)


   mg_setPRINTERALIGN ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setPRINTERCOLLATE ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setPRINTERCOLORMODE ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setPRINTERCOPIES ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setPRINTERCUSTOMPAPERSIZE ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setPRINTERDEFAULTSOURCE ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setPRINTERDUPLEX ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setPRINTERMARGINBOTTOM ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setPRINTERMARGINLEFT ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setPRINTERMARGINRIGHT ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setPRINTERMARGINTOP ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setPRINTERNAME ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setPRINTERORIENTATION ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setPRINTERPAPERSIZE ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setPRINTERPREVIEW ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setPRINTERQUALITY ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setPRINTERUNITS ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setSTYLEFONT ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setSTYLEPEN ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_setSuspendAllActivityTimestamp ( lSuspend )

      Description:
         This function will stop the reset activity timestamp for ALL events

      Parameters:
      lSuspend = .T. or .F.

      Return Value:
      This function always returns NIL


   mg_setSuspendUserActivityTimestamp ( lSuspend )

      Description:
         This function will stop the reset activity timestamp for USER events

      Parameters:
      lSuspend = .T. or .F.

      Return Value:
      This function always returns NIL


   mg_showSplashWindow ( [ cImage ] )

      Description:
         Show a splash window with the associated picture

      Parameters:
      cImage = (Optional) Picture name for display into splash window. If cImage isn't specified, the marinas-gui logo is used

      Return Value:
      Function returns NIL


   mg_transform ( cText , cInputMask )

      Description:
         This function converts a string into a string but according to cInputMask.

      Parameters:
      cText = Value to apply an InputMask
      cInputMask = String contening an textbox InputMask


      Return Value:
      Function returns a String with cText formated for cInputMask.


   mg_unSETAPPLICATIONCURSOR ( ... )

      Description:
         Function implemented but documentation is in progress

      Parameters:
      Function implemented but documentation is in progress

      Return Value:
      Function implemented but documentation is in progress


   mg_unTransform ( cText , cInputMask )

      Description:
         This function converts a string with mask separators into a string without cInputMask separators.

      Parameters:
      cText = Value to substract an InputMask
      cInputMask = String contening an textbox InputMask


      Return Value:
      Function returns a String without cInputMask separators.


   mg_version ()

      Description:
         This function returns the Marinas-GUI library version into a string with the following format: VV.RR.BBBB. Where "VV" is the major version, "RR" is the release and "BBBB" is the build

      Parameters:
      NIL

      Return Value:
      This function returns the version of Marinas-GUI as String


   mg_wait ( nSeconds )

      Description:
         This function will stop the process for nSeconds

      Parameters:
      nSeconds = Time wait in seconds

      Return Value:
      This function always returns .T.




Marinas-GUI Version 03.06 and
Marinas-IDE Version 05.06 and
LEX Files Version 02.06


---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
last update: April 27
2017
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------




A Harbour/QT framework to make multiplatform programs

(©) Copyright 2009-2017 by Fernando Santolin (aka CarozoDeQuilmes)
CarozoDeQuilmes@gmail.com

2009-2017 Beta tester and full English translator: Bruno Luciani
Bruno.Luciani@gmail.com

2014-2015 Final English corrector: David Worboys
DavidWorboys@hotmail.com

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

www.marinas-gui.org


www.marinas-gui.org  

Previous topic  First topic  Next topic