Les scripts de Maxthon v2.0

De Wiki Francophone de Maxthon

Version: 2.0.1 Last Modified: 2006-07-17 4:24 PM


Overview

Maxthon Browser has extended the DHTML support of IE by adding several new extensions which can be called by scripting language such as Javascript and VBScript.

These APIs can be called via the window.external object in a HTML page or a script plugin made for Maxthon Browser.

Some functions will require a security_id as first parameter. These Functions can only be used by Plugins.
In order to get a security_id for your plugin, you can do the following:

Vue d'ensemble

Le navigateur Maxthon a amélioré le support du DHTML de IE en ajoutant plusieurs nouvelles extensions qui peuvent être appelées par un langage de script comme Javascript et VBScript.

Ces APIs peuvent être appelées via l'objet window.external dans une page HTML ou par un Plugin de type script réalisé pour Maxthon.

Quelques fonctions nécessiteront security_id comme premier paramètre. Ces fonctions ne peuvent être seulement utilisées par des Plugins.
Afin d'avoir un security_id pour votre plugin, vous devez procéder ainsi :

Button Plugins

Put a %max_security_id in your script, such as:

var security_id=%max_security_id;

Then you can use the variable security_id in your script.

Plugins de type Bouton

Insérez un %max_security_id dans votre script, comme ceci :

var security_id=%max_security_id;

Ainsi vous pourrez utiliser la variable security_id dans votre script.

Sidebar Plugins

A file named max.src will be created in your plugin's folder, include this file in your HTML file:

<script type="text/javascript" src="max.src"></script>

Then use variable max_security_id for security id parameter in your script.

Plugins de type Barre latérale

Un fichier nommé max.src sera créé dans le dossier de votre Plugin, inclure ce fichier dans votre fichier HTML :

<script type="text/javascript" src="max.src"></script>

Ainsi vous pourrez utiliser la variable max_security_id comme paramètre identificateur de sécurité dans votre script.

Index

Extended Properties

Propriétés étendues

General Methods

Méthodes générales

Tab Related Methods

Méthodes associées aux onglets

File Related Methods

Méthodes associées aux fichiers


Propriétées étendues

max_version

Remarks:

This property will return a string of Maxthon Browser Version Number.
The return string is formatted like "2.1.0.600".

It's sugguested use this property to determine whether Maxthon Browser is running.

Remarques :

Cette propriété retournera une chaîne de caractères indiquant le numéro de version de Maxthon.
 La chaîne sera formatée de la façon suivante : "2.1.0.600".

Il est suggéré d'utiliser cette propriété pour déterminer si Maxthon est en cours d'exécution.

Exigences :

Maxthon version 2.0+

Exemple :

alert('Maxthon Version: '+external.max_version);


max_language_id

Remarks:

This property will return current language id of Maxthon Browser.

The Language ID has change to use Language Identifiers defined in Microsoft Windows since Maxthon Browser 2.0.
A list of Maxthon's Language IDs can be found at:
http://msdn.microsoft.com/library/?url=/library/en-us/intl/nls_238z.asp

Remarques :

Cette propriété retournera l'id de la langue en cours d'utilisation dans Maxthon.

L'ID de la langue a été modifié afin d'utiliser l'identificateur de langage défini dans Microsoft Windows depuis Maxthon v2.0. 
 la liste des ID utilisés par Maxthon se trouve ici :
http://msdn.microsoft.com/library/?url=/library/en-us/intl/nls_238z.asp

Exigences :

Maxthon version 1.0+

Exemple :

alert('Language ID='+external.max_language_id);


====current_tab==== (formerly cur_sel ) Non encore implémenté

Remarks:

This property will return an integer number as the index of the tab which is activated.
null will be returned if there is no tab opened.
current_tab is introduced in Maxthon 2.0 as a replacement of cur_sel because the old property name is too obscure to understand.

Remarques :
Cette propriété retournera un nombre entier qui représente l'index de l'onglet qui est actif.
null sera retourné s'il n'y a auncun onglet d'ouvert.
current_tab a été introduit dans Maxthon v2.0 en remplacement de cur_sel parce que le nom de l'ancienne propriété était trop obscur à comprendre.
Exigences :
Maxthon version 2.0+ (use cur_sel pour les versions 1.x)
Exemple :
alert('Current Tab Index: '+external.current_tab);


tab_count

Remarks:

This property will return current tab count as an integer.

Remarques :
Cette propriété retournera ne nombre d'onglet en cours sous la forme d'un entier.
Exigences :
Maxthon version 1.0+
Exemple :

alert('Tabs Count: '+external.tab_count);


Méthodes générales

addFavorite(url [, title])

Parameters:

url : string
The url to add.

title : string
Optional. The title of the url.

Paramètres :

url : chaîne
L'url à ajouter.

title : chaîne
Optionnel. Le titre de l'url.

Remarks:

Show the Add Favorite dialog to ask user to add a new Favorites Item.
This function will return false if user cancelled this operation.

Remarques :
Affiche la boîte de dialogue Ajouter un Favori pour demander à l'utilisateur d'ajouter un nouveau Favori.
 Cette fonction retournera faux si l'utilisateur a annulé cette opération.
Exigences :
Maxthon version 1.0+
Exemple :

external.addFavorite("http://www.maxthon.com");

external.addFavorite("http://www.maxthon.com", "Site officiel de Maxthon");


addProxy(name, address, type)

Parameters:

name : string
The display name of proxy.

address : string
The IP address or Domain name of proxy.

type : integer
A number indicates the speed rating of proxy.
= HTTP Proxy, 1 = SOCKS4A Proxy, 2 = SOCKS5 Proxy

Paramètres :

name : chaîne
Le nom du Proxy.

address : chaîne
L'adresse IP ou le nom de domaine du Proxy.

type : entier
Un nombre indiquant la vitesse du Proxy.
= Proxy HTTP, 1 = Proxy SOCKS4A, 2 = Proxy SOCKS5

Remarks:

Add a new proxy into Maxthon's proxy list. A dialog will be shown to the user.
This function will return false if user cancelled this operation.

Remarques :
Ajoute un nouveau Proxy dans liste des Proxy de Maxthon. Une boîte de dialogue sera présentée à l'utilisateur.
 Cette fonction retournera faux si l'utilisateur a annulé cette opération.
Exigences :
Maxthon version 2.0+
Exemple :

external.addProxy("My proxy","192.168.1.0:8080", 1);


addFilter(url_mask, type)

Parameters:

url_mask : string
Address mask to match blocked addresses. Supports Regular Expression.

type : integer
A number indicates which Filter list to add.
= Popup Filter, 1 = Content Filter

Paramètres :

url_mask : chaîne
Masque d'adresse qui correspond aux adresses à bloquer. Supporte les expressions régulières.

type : entier
Un nombre indiquant la liste de filtres à ajouter.
= Filtre de Popup, 1 = Filtre de contenu

Remarks:

Add a new filter policy into Maxthon. A dialog will be shown to the user.
This function will return false if user cancelled this operation.

Remarques :
Ajoute une nouvelle politique de filtrage dans Maxthon. Une boîte de dialogue sera présentée à l'utilisateur.
 Cette fonction retournera faux si l'utilisateur a annulé cette opération.
Exigences :
Maxthon version 2.0+
Exemple:

external.addFilter("http://www.advertisement.com/img/*", );


max_addProxyProvider(URL)

Parameters:

URL : string
The URL of proxy list file. File format please refer to [proxyprovider.htm this document].

Paramètres :

URL : chaîne
L'URL du fichier de la liste des Proxy. Pour le format du fichuer, se reporter à [proxyprovider.htm ce document].

Remarks:

Add a new Proxy Provider into Maxthon Broser. A dialog will be shown to the user.
This function will return false if user cancelled this operation.

Remarques :
Ajoute un nouveau fournisseur de Proxy dans Maxthon. Une boîte de dialogue sera présentée à l'utilisateur.
 Cette fonction retournera faux si l'utilisateur a annulé cette opération.
Exigences :
Maxthon version 2.0+
Exemple :

external.max_addProxyProvider("http://www.freeproxy.cn/m2proxy/proxylist.xml");


m2_run_cmd(security_id, command_id)

Parameters:

security_id : string
Maxthon's Security ID.

command_id : integer
The internal command ID of Maxthon.

Paramètres :

security_id : chaîne
ID de sécurité de Maxthon.

command_id : entier
L'ID de la commande interne de Maxthon.

Remarks:

This function will call a Maxthon's command with specified command_id.
Most usable Command IDs can be found in the language file inside Maxthon's language folder.
Command ID might be different between versions. Please do not use this function if not required.

Remarques :
Cette fonction Appellera une commande de Maxthon avec le command_id spécifié.
 De nombreux ID de commande peuvent être trouvés dans le fichier langage dans le répertoire language de Maxthon.
L'ID de la commande peut être différent suivant la version. N'utilisez pas cette fonction si ce n'est pas nécessaire.
Exigences :
Maxthon version 1.0+
Exemple :

external.m2_run_cmd(security_id, 32772); // Ouvre une page vierge


m2_search_text(security_id)

Parameters:

security_id : string
Maxthon's Security ID.

Paramètres :

security_id : chaîne
ID de sécurité de Maxthon.

Remarks:

This function will return the text in Maxthon's Search Box as a string.

Remarques :
Cette fonction retournera le texte de la barre de recherche de Maxthon sous la forme d'une chaîne.
Exigences :
Maxthon version 1.2+
Exemple:

var searchText=external.m2_search_text(security_id);


m2_plugin_folder(security_id, plugin_name)

Parameters:

security_id : string
Maxthon's Security ID.

plugin_name : string
The name of the plugin as defined in plugin.ini.

Paramètres :

security_id : chaîne
ID de sécurité de Maxthon.

plugin_name : chaîne
Le nom du Plugin comme défini dans le fichier plugin.ini.

Remarks:

This function will return the local folder path of specified plugin as a string.

Remarques :
Cette fonction retournera le dossier local du Plugin spécifié sous la forme d'une chaîne.
Exifences :
Maxthon version 1.2+
Exemple:

var pluginPath=external.m2_plugin_folder(security_id, "ViewSource!");


m2_callerName(security_id, plugin_name)

Parameters:

security_id : string
Maxthon's Security ID.

plugin_name : string
The name of the plugin as defined in plugin.ini.

Paramètres :

security_id : chaîne
ID de sécurité de Maxthon.

plugin_name : chaîne
Le nom du Plugin comme défini dans le fichier plugin.ini.

Remarks:

This function will tell Maxthon the next function call is from a plugin.
This function is usually used before the window.open() method to bypass the Popup Blocker of Maxthon for the plugin.

Remarques :
Cette fonction indiquera à Maxthon la fonction suivante appelée à partir du Plugin.
 Cette fonction est habituellement utilisée avant l'ouverture de la méthode window.open() pour bypasser le bloqueur de Popup de Maxthon pour le Plugin.
Exigences :
Maxthon version 1.2+
Exemple :

external.m2_callerName(security_id, "ViewSource!");
window.open("about:blank");


max_actSideBarItem(plugin_name)

Parameters:

plugin_name : string
The name of the plugin as defined in plugin.ini.

Paramètres :

plugin_name : chaîne
Le nom du Plugin comme défini dans le fichier plugin.ini.

Remarks:

This function will activate the sidebar plugins with the given name.

Remarques :
Cette fonction activera le Plugin de la barre latérale avec le nom indiqué.
Exigences :
Maxthon version 1.2+
Exemple :

external.max_actSideBarItem("Calculator++");


max_modelessDialog(security_id, url, arguments, features, parent_window)

Parameters:

security_id : string
Maxthon's Security ID.

url : string
The url of modeless dialog content.

arguments : variant
The arguments pass to the modeless dialog's window.dialogArguments object.

features : string
A String that specifies the window ornaments for the dialog box.

parent_window : object
The parent window object of the dialog.

Paramètres :

security_id : chaîne
ID de sécurité de Maxthon.

url : chaîne
L'url du contenu de la boîte de dialogue.

arguments : variante
Les arguments passés à l'objet window.dialogArguments de la boîte de dialogue .

features : chaîne
Une chaîne qui spécifie les caractéristiques de la fenêtre de la boîte de dialogue.

parent_window : objet
La racine de l'objet window de la boîte de dialogue.

Remarks:

This function is almost the same as window.showModelessDialog() but with two more parameters.
With the security_id your plugin can bypass Maxthon's Popup Blocker.
With the parent_window you can make the dialog being a child of another tab's window.

Remarques :
Cette fonction est à peu près la même que window.showModelessDialog() mais avec 2 paramètres de plus.
 Avec le security_id votre Plugin peut bypasser le bloqueur de Popup de Maxthon.
 Avec le parent_window vous pouvez créer la boîte de dialogue qui est une fille d'une autre window de l'onglet.
Exigences :
Maxthon version 1.2+
Exemple :

external.max_modelessDialog(security_id, "about:blank", {"userid": 7, "key": "d3fe3asd"}, "status:no; help:no; resizable:yes; scroll:yes;", window);


get_tab(security_id, index)

Parameters:

security_id : string
Maxthon's Security ID.

index : integer
The index of the tab to get.

Paramètres:

security_id : chaîne
ID de sécurité de Maxthon.

index : entier
L'index de l'onglet à obtenir.

Remarks:

This function will get the window object of specified tab in Maxthon.
null will be returned if the tab does not exist.

Remarques:
Cette fonction will get the window object of specified tab in Maxthon.
null will be returned if the tab does not exist.
Requirements:
Maxthon Version 1.0+
Example:

var objTab=external.get_tab(security_id, 5);


activate_tab(security_id, index)

Parameters:

security_id : string
Maxthon's Security ID.

index : integer
The index of the tab to be activated.

Remarks:
This function will activate the specified tab in Maxthon.
 Nothing will happen if the tab does not exist.
Requirements:
Maxthon Version 1.0+
Example:

external.activate_tab(security_id, 1);


close_tab(security_id, index)

Parameters:

security_id : string
Maxthon's Security ID.

index : integer
Integer. The index of the tab to close.

Remarks:
This function will close the tab which index represents.
 Nothing will happen if the tab does not exist.
Requirements:
Maxthon Version 1.0+
Example:

external.close_tab(security_id, );


readFile(security_id, plugin_name, file_name)

Parameters:

security_id : string
Maxthon's Security ID.

plugin_name : string
The name of calling plugin as defined in plugin.ini

file_name : string
The file to read.

Remarks:
This function can only be used in a plugin.
 The function will return the file content in string when success.
 If the plugin is not enabled or the plugin_name is not found, the function will fail and return null.
Requirements:
Maxthon Version 1.0+
Example:

var strFile=external.readFile(security_id, "Test plugin", "plugin.ini");


writeFile(security_id, plugin_name, file_name, content)

Parameters:

security_id : string
Maxthon's Security ID.

plugin_name : string
The name of calling plugin as defined in plugin.ini

file_name : string
The file to write.

content : string
File content string to write.

Remarks:
This function can only be used in a plugin.
 This function will return true when success.
 If the file is not found, the plugin is not enabled or the plugin_name is not found, the function will fail and return false.
If a file with the same name exists, it will be overwritten.
Requirements:
Maxthon Version 1.0+
Example:

external.writeFile(security_id, "Test plugin", "setting.ini", "username=abc\npass=qwrxcv");


m2_readIni(security_id, plugin_name, file_name, section_name, key, default_value)

Parameters:

security_id : string
Maxthon's Security ID.

plugin_name : string
The name of calling plugin as defined in plugin.ini.

file_name : string
The name of the INI file to read.

section_name : string
The INI section to read, without brackets [ ].

key : string
The key of the entry to read.

default_value : string
The default value to return if the key does not exist.

Remarks:
This function will read the value of key under section section_name in INI file file_name.
 The INI file must be placed inside the folder of plugin plugin_name.
 The value will be returned as a string if success.
 If the file does not exist, the section does not exist or the key does not exist, the default_value will be returned.
Requirements:
Maxthon Version 1.0+
Example:

var saveCount = external.m2_readIni(security_id, "TestPlugin", "settings.ini", "general", "saveCount", "0");


m2_writeIni(security_id, plugin_name, file_name, section_name, key, value)

Parameters:

security_id : string
Maxthon's Security ID.

plugin_name : string
The name of calling plugin as defined in plugin.ini.

file_name : string
The name of the INI file to write.

section_name : string
The INI section to write, without brackets [ ].

key : string
The key of the entry to write.

value : string/integer
The value to write.

Remarks:
This function will write a key and value pair entry under section section_name in INI file file_name.
 The INI file can only be writen inside the folder of plugin plugin_name.
 If the file does not exist, the section does not exist or the key does not exist, they will be created automatically.
 This function will return true when success and false when failed.
Requirements:
Maxthon Version 1.0+
Example:

external.m2_writeIni(security_id, "TestPlugin", "settings.ini", "general", "saveCount", 25);


Base de connaissances de Maxthon 2.0
Récupérée de « https://www.maxthon-fr.com/wiki/index.php?title=Les_scripts_de_Maxthon_v2.0&oldid=3212 »