Tutorial Plugin : 3 - Commandes de Maxthon

De Wiki Francophone de Maxthon
Sauter à la navigation Sauter à la recherche

Maxthon a maintenant plus de 20 commandes. De nombreuses commandes fonctionnent seulement dans les plugins, mais certaines peuvent aussi être utilisées sur des pages Web normales.


Vous pouvez appeler ces commandes avec l'objet "window.external". Parce qu'il est possible pour les pages Web d'utiliser ces commandes, de nombreuses commandes nécessitent maintenant un "security_id" (une identification de sécurité).


Un "security_id" est une variable qui ressemble à ceci : "{DCFC4598-B97C-49B6-8108-EE86F8694283}". Le "security_id" change chaque fois que vous relancez votre navigateur.


  • Pour les plugins de script, vous devez utiliser %max_security_id dans le fichier de script, tels que 'var security_id=%max_security_id', alors vous pourrez utiliser 'security_id' dans votre script.
    NOTE : Les pages Web sont capables d'obtenir cette variable security_id si vous lancez un plugin sur une page Web et si la page Web connaît la variable que vous stockez dans le max_security_id. Vous pouvez éviter un litige de sécurité si vous mettez tout votre code dans une fonction anonyme. [Vous trouverez plus d'informations sur les fonctions anonymes dans la 4ème Partie].
  • Pour les plugins de barre latérale, un fichier nommé "max.src" sera créé dans le dossier de votre plugin avec la variable max_security_id comme étant le security_id. Vous pouvez inclure ce fichier dans votre page html pour obtenir l'"id" (identifiant).


Comme ceci :

<lang="html4strict"><script language="JavaScript" type="text/JavaScript"
src="max.src"></script>

Ce code devrait être placé à l'intérieur de la balise <head>.


Vous trouverez ci-dessous, les commandes DHTML de Maxthon, n'oubliez pas de les faire précéder de 'external' ! :


  • readFile( security_id, plugin_name, file_name) Où 'plugin_name' fait référence au nom du plugin défini dans le fichier plugin.ini et 'file_name' indique le nom du fichier qu'il veut lire (situé dans le dossier plugin). Ce nom de fichier peut comporter un chemin, tel que 'data\settings.ini' pour lire le fichier 'settings.ini' dans le dossier 'data'.
    Le nom de fichier peut également comporter '..' pour lire le dossier parent, par exemple : '..\..\config\plugins.ini' pour lire le fichier plugin.ini dans le sous-dossier 'Maxthon\config'. Vous ne pouvez pas utiliser '..' plus de deux fois, ainsi vous ne pourrez pas lire/écrire des fichiers en dehors du dossier où Maxthon est situé (pour une meilleure sécurité).
    La commande retournera le contenu du fichier. Si le plugin n'est pas activé, ou si le nom du plugin n'est pas correct ou n'est pas trouvé, la commande échouera et retournera "null".
    Cette commande ne peut que lire des fichiers texte au format ANSI.
var text = external.readFile(%max_security_id,"Test plugin",
"export.txt");


  • writeFile( security_id, plugin_name, file_name, content ) Cette fonction ne peut être utilisée que dans un script de plugin, pour des raisons de sécurité.
    'plugin_name' se réfère au nom du plugin défini dans plugin.ini et 'file_name' indique le nom du fichier qui doit être écrit. 'content' est le contenu qui sera écrit dans le fichier. Si le plugin n'est pas capable d'écrire ou que le nom du plugin et erroné ou non trouvé, la fonction se terminera sur une erreur et retournera "null".
    Cette commande peut seulement écrire des fichiers au format texte. Aussi, la commande ajoute un caractère NULL à la fin du fichier. Celà n'a pas beaucoup d'importance, mais rend impossible d'écrire un fichier au format XML. Vous devez utiliser pour cela FileSystemObject (un composant ActiveX).
    Notez : Le fichier sera écrasé à partir du début.
    Pour ajouter du contenu à un fichier, lire la donnée du premier fichier, puis ajouter la nouvelle donnée et écrire la donnée.
external.writeFile(%max_security_id,"Test plugin","setting.ini",
"username=abc\npass=qwrxcv");


  • m2_readIni( security_id, plugin_name , file_name , section_name , key , default_value) Cette fonction lira la clé dans le fichier ini spécifié par 'file_name' dans le répertoire du plugin. Elle retournera 'default_value' si la clé n'est pas disponible ou si 'file_name' ou 'plugin_name' sont erronés.
path = external.m2_readIni(%max_security_id,"testplugin","settings.ini",
"general","save","0");


  • m2_writeIni( security_id , plugin_name , file_name , section_name , key , value ) Cette fonction écriera la clé avec 'value' dans le fichier ini spécifié par 'file_name'.
external.m2_writeIni(%max_security_id,"testplugin","settings.ini",
"general","save","true");


  • tab_count Cette commande retourne le nombre total d'onglets ouverts sous la forme d'un entier, comme le "Nombre d'onglets" dans la barre d'état.
var total_tab = external.tab_count;


  • activate_tab( security_id , index ) Cette fonction active l'onglet numéro 'index' dans Maxthon ('index' commence à 0).
external.activate_tab(%max_security_id,2);


  • close_tab( security_id , index ) Cette commande fermera l'onglet numéroté selon son 'index' dans Maxthon ('index' commence à zéro).
external.close_tab(%max_security_id,2);


  • get_tab( security_id , index ) Cette fonction retournera un objet de page web de l'onglet numéro 'index' ('index' commence à zéro). Vous pouvez l'utiliser si vous avez besoin d'information sur cet onglet, comme le titre ou l'adresse URL.
external.get_tab(%max_security_id,2).document;


  • cur_sel Cette fonction retournera le numéro (en commençant à zéro) de l'onglet courant sous la forme d'un entier.
var cur_tab = external.cur_sel;


  • m2_plugin_folder( security_id , plugin_name ) Cette fonction retournera le répertoire local du plugin. Vous pouvez utiliser cette commande si vous ajoutez des images locales ou une feuille de style à une page web.
var folder = external.m2_plugin_folder(%max_security_id,"Weather");
Ceci retourne par exemple : "C:\Program Files\Maxthon\Plugin\Weather"


  • m2_run_cmd( security_id , id ) Cette fonction appellera une commande de Maxthon avec l'ID spécifié. L'id de chaque commande est présent dans le fichier de chaque langue ou ici.
external.m2_run_cmd(%max_security_id,32772); //Ouvre une page vierge.


  • m2_callerName( security_id, plugin_name) Cette fonction indique à Maxthon que l'appel est réalisé à partir d'un Plugin.
    C'est habituellement utilisé avant un appel 'window.open()' pour que Maxthon ne tienne pas compte de la fenêtre popup que le plugin ouvre. La fenêtre ouverte conservera le focus si vous utilisez cette fonction.
external.m2_callerName(%max_security_id,"ViewSource!");


  • max_showConfig( security_id, plugin_name) Cette fonction affichera la boîte de dialogue de configuration des plugins (aller dans la 2ème partie de ce tutoriel pour obtenir plus d'information sur la fenêtre de configuration).
external.max_showConfig(%max_security_id,"ViewSource!");


  • max_activex(security_id, prog_id) Cette fonction créera un contrôle ActiveX avec le 'prog_id'.
    Ce contrôle ActiveX a plus de droits qu'un contrôle ActiveX normal, vous pouvez l'utiliser même si vous avez des options de sécurités hautes, mais il est encore possible qu'un antivirus bloque le composant.
    Vous devez ouvrir un nouvel onglet sous peine d'obtenir cette alerte : Cette commande ne peut seulement être appelée d'une page locale.
    Un nouvel onglet est une 'page locale' pour Maxthon.
var XML=external.max_activex(%max_security_id,"Microsoft.XMLDOM");


  • max_modelessDialog( security_id , url , option , attr , window ) Cette fonction ouvrira un 'modelessDialog'. C'est la même chose que la fonction 'window.ShowModelessDialog'. Le dernier paramètre 'window' est l'objet fenêtre de la page web.
external.max_modelessDialog(%max_security_id,'example.htm',
window,'status:no;help:no;resizable:yes;scroll:yes;',window);


  • max_language_id Cette propriété retourne le code de la langue en cours.
    Vous pouvez consulter tous les codes de langue ici
var language=external.max_language_id;


  • max_actSideBarItem( plugin_name ) Cette fonction activera le plugin de la barre latérale nommé 'plugin_name'.
external.max_actSideBarItem("Calculator++");


  • addFavorite( url , title ) , addFavorite( url ) Cette fonction demandera à l'utilisateur d'ajouter lurl' dans les favoris, en utilisant 'title' comme nom d'url.
external.addFavorite( "http://www.google.com" ); 
external.addFavorite( "http://www.google.com","C'est google");


  • addProxy (name, address, speed, is_web_proxy) Cette fonction appellera la boîte de dialogue d'ajout d'un proxy de Maxthon pour ajouter le nom du proxy 'name' à l'adresse 'address', en indiquant comme vitesse initiale 'speed'. Le 'is_web_proxy' indique si le proxy est un proxy web ou un proxy normal.
external.addProxy("Mon proxy","192.168.1.0:8080",1,0);


  • addFilter( address ) , addFilter( address, is_pop_filter ) Cette fonction appellera la boîte de dialogue d'ajout d'un filtre de Maxthon, en indiquant l'adresse à filtrer 'address', 'is_pop_filter' indiquant si le type de filtre par défaut est un filtre de popup.
external.addFilter("http://www.yahoo.com/ad*");
external.addFilter("http://www.yahoo.com/img/*", 0);


  • m2_addSearchEngine(name, address) Cette fonction appellera la boîte de dialogue d'ajout d'un moteur de recherche de Maxthon.
javascript:external.m2_addSearchEngine('SteadySearch',
'http://www.steadysearch.com/search?p=Q&ts=ne&w=%us');


  • m2_search_text( security_id ) Cette propriété retournera le texte présent dans la barre de recherche de Maxthon.
var text = external.m2_search_text(%max_security_id);


Dans un plugin de barre latérale vous pouvez insérer une fonction script appelée max_callback(status).

  1. Quand le plugin est créé l'adresse URL sera filename?maxcmd=init
  2. Quand le plugin est activé, max_callback('sidebar_activate') sera appelé
  3. Quand le plugin est désactivé, max_callback('sidebar_deactivate') sera appelé
  4. Quand l'onglet actif est modifié, max_callback('sidebar_tab_change') sera appelé
  5. Quand le plugin sera fermé, max_callback('sidebar_unload') sera appelé.


< Partie 2 : Fichiers Plugin | Sommaire Plugin | Partie 4 : Astuces >