Différences entre les versions de « Les scripts de Maxthon v2.0 »

De Wiki Francophone de Maxthon
Aller à la navigation Aller à la recherche
 
(46 versions intermédiaires par 6 utilisateurs non affichées)
Ligne 1 : Ligne 1 :
Last Modified: 2006-07-17 4:24 PM
== '''Types de Plugin de Maxthon''' ==
Version: 2.0.1




==''Overview''==
Le type de Plugin de Maxthon est défini par ModuleType (Script, HTML, COM et EXE) et Type (Button, Sidebar, Toolbar, COM_Button, MHO, MHO_Button) simultanément :
''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 <span style="color: #000066;font-weight: bold;">window</span>.<span style="color: #000066;font-weight: bold;">external</span> object in a HTML page or a script plugin made for Maxthon Browser.''


''Some functions will require a <span style="color: #990000;">security_id</span> as first parameter. These Functions can only be used by Plugins.<br /> In order to get a <span style="color: #990000;">security_id</span> for your plugin, you can do the following:''
              Button    SideBar  Toolbar  COM_Button    MHO    MHO_Button
Script        oui      oui
HTML          oui
EXE            oui
COM            oui      oui        oui        oui        oui        oui
COM_Global    oui      oui        oui        oui


==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 <span style="color: #000066;font-weight: bold;">window</span>.<span style="color: #000066;font-weight: bold;">external</span> dans une page HTML ou par un Plugin de type script réalisé pour Maxthon.
==== '''1. ModuleType - Script, HTML, EXE, COM et COM_Global''' ====


Quelques fonctions nécessiteront <span style="color: #990000;">security_id</span> comme premier paramètre. Ces fonctions peuvent seulement être utilisées par des Plugins.<br /> Afin d'avoir un <span style="color: #990000;">security_id</span> pour votre plugin, vous devez procéder ainsi :


====''Button Plugins''====
'''Script''' - Le Plugin Script peut être de type button, qui exécute un script lorsqu'il est cliqué. le script peut être dans un langage supporté par IE, comme le JavaScript ou le vbscript. Maxthon 2.0 supporte le mscript qui exécute l'environnement (plus de détails ci-après). Le Script peut également être de type sidebar, qui affiche un fichier HTML dans la barre latérale.
''Put a <span style="color: #990000;">%max_security_id</span> in your script, such as:''
'''HTML''' - Un nouveau type de Plugin pour Maxthon 2.0 seulement. Le Plugin de type HTML est similaire au Plugin Script Sidebar dans sa nature. La différence majeure est que le Plugin Script Sidebar est affiché dans la barre latérale de Maxthon alors que le Plugin HTML est affiché comme un bouton dans la barre des Plugins ou n'importe quelle barre d'outils (barre d'état, barre des menus, barre des onglets, barre d'adresses...).
'''EXE''' - Le Plugin EXE sera affiché comme un bouton sur la barre des Plugins. Le Plugin EXE peut être n'importe quel fichier exécutable. Maxthon peut passer plusieurs paramètres au fichier exécutable comme l'URL de la page Web en cours ou le "handle" de la fenêtre de Maxthon.


''<span style="color: #000066;font-weight: bold;">var</span> security_id=<span style="color: #990000;">%max_security_id</span><nowiki>;</nowiki>''
'''COM''' - Un plugin COM peut instancier l'interface IObjectWithSite pour obtenir un pointeur sur l'onglet actif du navigateur, les évènements et sur le DOM pour toute manipulation .


''Then you can use the variable <span style="color: #990000;">security_id</span> in your script.''
'''COM_Global''' - Les Plugins COM_Global sont créés seulement une fois au démarrage de Maxthon, et sont détruits à la fermeture de Maxthon. Les Plugins COM_Global sont souvent pour les fonctions de navigation qui ne sont pas en relation avec le Document Object Model. Ainsi, les Plugins COM_Global peuvent implémenter une fonction PutMaxCommander à travers l'interface IDispatch pour obtenir un objet du Plugin de Maxthon, qui peut être utilisé de la même façon qu'un objet externe de Maxthon pour les Plugins script (cf. les commandes ci-dessous des Plugins script), pour interagir avec le Document Object Model des onglets et Maxthon.


====Plugins de type Bouton====
Notez que Maxthon 2.0 est "multithread" (un "thread" pour chaque onglet). Les Plugins développés pour une interaction approfondie avec le Document Object Model des onglets doivent être développés en COM (par onglet) au lieu de COM_Global ainsi ils pourront fonctionner plus efficacement avec le même "thread" d'un onglet individuel.
Insérez un <span style="color: #990000;">%max_security_id</span> dans votre script, comme ceci :


<span style="color: #000066;font-weight: bold;">var</span> security_id=<span style="color: #990000;">%max_security_id</span><nowiki>;</nowiki>
==== '''2. Type - Button, SideBar, Toolbar, COM_Button, MHO, and MHO_Button''' ====


Ainsi vous pourrez utiliser la variable <span style="color: #990000;">security_id</span> dans votre script.


====''Sidebar Plugins''====
'''Button''' - Un bouton sera ajouté sur la barre des Plugins. L'opération spécifiée par le script (Plugin Script), l'exécutable (Plugin EXE), la DLL (Plugin COM) sera exécutée lorsque le bouton sera cliqué. En option, Les Plugins de bouton peuvent implémenter un menu déroulant pour le Plugin. Un Plugin de bouton COM doit implémenter l'interface IOleCommandTarget pour recevoir le clic du bouton. Si un menu est implémenté, la fonction IOleCommandTarget_Exec recevra un id de commande de 1 lorsque le bouton est cliqué, et un id de commande de 2 lorsque le premier item du menu est cliqué, et ainsi de suite. Un Plugin de bouton COM est créé lorsque le bouton est cliqué et est détruit lorsque l'onglet est fermé (comme IE7).
''A file named <span style="color: #990000;">max.src</span> will be created in your plugin's folder, include this file in your HTML file:''


''<<span style="color: #000066;font-weight: bold;">script</span> <span style="color: #990000;">type</span><nowiki>=</nowiki><span style="color: #0000FF;">"text/javascript"</span> <span style="color: #990000;">src</span><nowiki>=</nowiki><span style="color: #0000FF;">"max.src"</span>></<span style="color: #000066;font-weight: bold;">script</span>>''
'''SideBar''' - Un bouton sera ajouté à la barre latérale, et un élément sera ajouté au menu principal > Affichage > Barre latérale. Lorsque le bouton ou l’élément du menu est cliqué, la barre latérale de Maxthon s'ouvrira et affichera le fichier HTML spécifié par le Plugin (Plugin script), ou la fenêtre spécifiée par le Plugin à travers l'interface IDeskBand (Plugin com ou com_global).


''Then use variable <span style="color: #990000;">max_security_id</span> for security id parameter in your script.''
'''Toolbar''' - Les Plugins de barre d'outils doivent être écrits en COM. Une nouvelle barre d'outils sera ajoutée, qui pourra être affichée ou cachée à partir du menu principal > Affichage > Barre d'outils. Un Plugin de barre d'outils doit implémenter l'interface IDeskBand pour spécifier la fenêtre de la barre d'outils. Les Plugins de barre d'outils peuvent être COM ou COM_Global. Les Plugins de barre d'outils COM sont affectés à un onglet lorsque l'onglet est crée, et sont détruits lorsque l'onglet est fermé. Cela permet l'adoption de certaines barres d'outils d'IE dans Maxthon en l'état ou avec un minimum de changements. Les barres d'outils COM_Global sont créés uniquement au démarrage de Maxthon, et sont détruites à la fermeture de Maxthon. Une barre d'outils COM_Global peut instancier l'interface IObjectWithSite pour obtenir un pointeur sur l'onglet actif du navigateur à travers la fonction SetSite. Lorsque l'onglet actif est modifié, SetSite sera appelé de nouveau pour passer le pointeur sur le nouvel onglet actif du navigateur.


====Plugins de type Barre latérale====
'''COM_Button''' - Les Plugins COM_Button sont identiques au Plugins de barre d'outils, à l'exception près que les Plugins COM_Button sont affichés dans Maxthon comme un bouton, et non pas comme une barre d'outils. Un Plugin COM_Button a la même flexibilité de positionnement dans l'interface de Maxthon que les autres boutons, mais il supporte également la richesse de l'interface d'une barre d'outils par rapport à celle d'un simple bouton.
Un fichier nommé <span style="color: #990000;">max.src</span> sera créé dans le dossier de votre Plugin, inclure ce fichier dans votre fichier HTML :


<<span style="color: #000066;font-weight: bold;">script</span> <span style="color: #990000;">type</span><nowiki>=</nowiki><span style="color: #0000FF;">"text/javascript"</span> <span style="color: #990000;">src</span><nowiki>=</nowiki><span style="color: #0000FF;">"max.src"</span>></<span style="color: #000066;font-weight: bold;">script</span>>
'''MHO''' - Un Plugin MHO est identique au Browser Helper Object d'IE et doit être écrit en COM. Les Plugins MHO sont créés par onglet lorsque l'onglet est créé, et sont détruits lorsque l'onglet est fermé. Les Plugins MHO doivent instancier l'interface IObjectWithSite pour obtenir un pointeur sur l'onglet du navigateur  ,de manière à interagir avec le DOM. Les Plugins MHO n'ont pas d'interface.


Ainsi vous pourrez utiliser la variable <span style="color: #990000;">max_security_id</span> comme paramètre identificateur de sécurité dans votre script.
'''MHO_Button''' - Le Plugin MHO est une combinaison d'un Plugin MHO et d'un Plugin bouton COM. Les Plugins MHO_Button sont créés par onglet lorsque l'onglet est créé, et sont détruits lorsque l'onglet est fermé. En plus, une instance de Plugin MHO_Button sera créée lorsque son bouton est cliqué, et l'instance sera détruite lorsque l'opération est terminée. Le Plugin MHO_Button ajoute essentiellement une interface bouton au Plugin MHO.


==Index==
== Créer un Plugin pour Maxthon ==


====''Extended Properties''====
* ''[[#max_version|max_version]] : Get current version of Maxthon Browser''
* ''[[#max_language_id|max_language_id]] : Get current language id of Maxthon UI''
* ''[[#current_tab|current_tab (cur_sel)]] : Get current tab's index''
* ''[[#tab_count|tab_count]] : Get current opened tabs' count''


====Propriétés étendues====
'''Composants majeurs d’un Plugin de Maxthon'''
* [[#max_version|max_version]] : Obtenir la version courante de Maxthon
* [[#max_language_id|max_language_id]] : Obtenir l'id de la langue courante de l'interface utilisateur de Maxthon
* [[#current_tab|current_tab (cur_sel)]] : Obtenir l'index de l'onglet en cours
* [[#tab_count|tab_count]] : Obtenir le nombre d'onglets ouvert en cours


====''General Methods''====
Un Plugin de Maxthon contient généralement les fichiers suivants :
* ''[[#addFavorite|addFavorite()]] : Call the Add Favorites dialog''
* ''[[#addProxy|addProxy()]] : Call the Add Proxy dialog''
* ''[[#addFilter|addFilter()]] : Call the Add Filter dialog''
* ''[[#max_addProxyProvider|max_addProxyProvider()]] : Call the Add Proxy Provider dialog''
* ''[[#m2_run_cmd|m2_run_cmd()]] : Execute Maxthon functions by Command ID''
* ''[[#m2_search_text|m2_search_text()]] : Get search string in Maxthon's Search Box''
* ''[[#m2_plugin_folder|m2_plugin_folder()]] : Get local folder path of a plugin''


====Méthodes générales====
'''Fichiers INI''' – Le fichier plugin.ini est nécessaire pour tous les Plugins de Maxthon. Il définit plusieurs attributs du Plugin.
* [[#addFavorite|addFavorite()]] : Appeler la boîte de dialogue Ajouter un Favori
 
* [[#addProxy|addProxy()]] : Appeler la boîte de dialogue Ajouter un Proxy
'''Fichiers HTML/DLL/EXE file''' – Le composant principal nécessaire à tous les Plugins de Maxthon spécifiant l'opération à réaliser ou le contenu à afficher.
* [[#addFilter|addFilter()]] : Appeler la boîte de dialogue Ajouter un Filtre
* [[#max_addProxyProvider|max_addProxyProvider()]] : Appeler la boîte de dialogue Ajouter un Fournisseur de Proxy
'''Fichier Icônes''' – L'icône du bouton (*.ICO) nécessaire aux Plugins bouton et barre latérale. Les plugins COM ou EXE peuvent utiliser des icones insérées dans leur code.
* [[#m2_run_cmd|m2_run_cmd()]] : Exécuter la fonction de Maxthon correspondant à la commande ID
* [[#m2_search_text|m2_search_text()]] : Obtenir la chaîne de recherche de la barre de recherche de Maxthon
'''Config.html''' – Un fichier HTML optionnel pour être utilisé avec les Plugins de type Script et HTML comme boîte de dialogue de configuration.
* [[#m2_plugin_folder|m2_plugin_folder()]] : Obtenir le dossier local des Plugins


====''Tab Related Methods''====
* ''[[#get_tab|get_tab()]] : Get a tab's window object by index''
* ''[[#activate_tab|activate_tab()]] : Activate a tab by index''
* ''[[#close_tab|close_tab()]] : Close a tab by index''


====Méthodes associées aux onglets====
* [[#get_tab|get_tab()]] : Obtenir l'objet d'un onglet par index
* [[#activate_tab|activate_tab()]] : Activer un onglet par index
* [[#close_tab|close_tab()]] : Fermer un onglet par index


====''File Related Methods''====
'''Fichier plugin.ini'''
* ''[[#readFile|readFile()]] : Read a file's content''
* ''[[#writeFile|writeFile()]] : Write data to a file''
* ''[[#m2_readIni|m2_readIni()]] : Read an INI file''
* ''[[#m2_writeIni|m2_writeIni()]] : Write to an INI file''


====Méthodes associées aux fichiers====
* [[#readFile|readFile()]] : Lire le contenu d'un fichier
* [[#writeFile|writeFile()]] : Ecrire des données dans un fichier
* [[#m2_readIni|m2_readIni()]] : Lire un fichier INI
* [[#m2_writeIni|m2_writeIni()]] : Ecrire dans un fichier INI


[General] nécessaire à la définition de plusieurs attributs du plugin
'''Name'''= nom du Plugin
'''Author'''= nom de l'auteur
'''Version'''= Version du Plugin
'''ModuleType'''= Peut être Script, HTML, EXE, COM, or COM_Global
'''FileName'''= Peut-être un fichier HTML (Plugins Script et HTML), un fichier DLL (Plugins COM) ou un fichier EXE (Plugins EXE)
'''Comments'''= La description affichée dans les options du Plugin et/ou l'info-bulle du Plugin de type Button
'''Type'''= Peut être M2Plugin_Button, M2Plugin_Sidebar, M2Plugin_Toolbar, M2Plugin_COM_Button, M2Plugin_MHO, ou M2Plugin_MHO_Button
'''IdealSize'''= La largeur et la hauteur de l'interface du Plugin (ex. 120 20, pour un Plugin HTML seulement)
'''IdealSizeVertical'''= La largeur et la hauteur de l'interface du Plugin lorsqu'il est positionné verticalement (ex 120 20, optionnel pour un Plugin HTML)
'''Icon'''= L'icône du bouton pour les Plugins de type Button ou Sidebar
'''HotIcon'''= L'icône du bouton lorsque le bouton du Plugin est survolé
'''CLSID'''= Le CSLID pour les Plugins de type COM et COM_Global
'''DefaultLocation'''= Optionnel, défini la localisation par défaut de l'icône du Plugin, peut être '''None''' (dans la barre des Plugins, mais non affichée après l'installation, l'utilisateur peut afficher le bouton à partir du menu Afficher ou masquer des boutons), '''MenuBar''', '''ToolBar''', ou '''StatusBar'''. S’il n'est pas définit, le Plugin sera affiché dans la barre des Plugins. Pour le Plugin de type '''Button''' et pour Maxthon 2.0.5 ou supérieur.


==Propriétées étendues==
'''StartAfterPageDoneURL'''= Optionnel, définit les adresses pour lesquelles le Plugin doit démarrer automatiquement, supporte les caractères joker, et on peut utiliser "|" pour séparer les adresses, ex. '''*maxthon.com*|forum.maxthon.cn*'''. Si il n'est pas défini, le Plugin démarrera pour toutes les adresses, équivalent à '''*'''. Pour les Plugins de types '''Script''' et '''Button''' et pour Maxthon 2.0.5 ou supérieur.


===max_version===
'''StartAfterPageDoneURLExclude'''= Optionnel, définit les adresses pour lesquelles le Plugin ne doit pas démarrer automatiquement, a une priorité supérieure à startAfterPageDoneUrl. Utilise le même format que startAfterPageDoneUrl ex. '''forum.maxthon.cn/index.php?|*.maxthon.cn/index.php?showtopic*'''. Pour les Plugins de types '''Script''' et '''Button''' et pour Maxthon 2.0.5 ou supérieur.
<div style="margin-left: 10px;">


====''Remarks:''====
''This property will return a string of Maxthon Browser Version Number.<br /> The return string is formatted like <span style="color: #0000FF;">"2.1.0.600"</span>.''
[MyIE2Buttons] Optionnel pour définir le menu déroulant pour les Plugins de types Button et MHO_Button
'''Count'''= Le nombre d'éléments du menu déroulant
'''Name1'''= Le nom du 1er élément du menu déroulant
'''FileName1'''= Le nom du fichier, ou le nom du fichier + les paramètres pour les Plugins de type EXE, du 1er élément du menu déroulant. Pour les Plugins de type COM Button et COM MHO_Button, mettre un nom arbitraire et distinct, ex. 1 pour FileName1 et 2 pour FileName2 etc.


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


====Remarques :====
'''Installation d'un Plugin de Maxthon'''
Cette propriété retournera une chaîne de caractères indiquant le numéro de version de Maxthon.<br /> La chaîne sera formatée de la façon suivante : <span style="color: #0000FF;">"2.1.0.600"</span>.


Il est suggéré d'utiliser cette propriété pour déterminer si Maxthon est en cours d'exécution.
Les Plugins de Maxthon sont installés dans le répertoire "Plugin" du dossier d'installation de Maxthon. Chaque Plugin possède son propre dossier dédié qui contient le fichier plugin.ini et les autres fichiers nécessaires et/ou sous-dossiers.


====Exigences :====
Un Plugin terminé, comprenant le dossier du Plugin et tous les fichiers et/ou sous-dossiers peut-être compressé dans un fichier ZIP (*.zip) pour être déployé.
Maxthon version 2.0+<br /><br />


====Exemple :====
<div style="margin: 5px;padding: 10px;background: #F3F3F3;border: 1px dashed #CCCCCC;"><span style="color: #000066;font-weight: bold;">alert</span>(<span style="color: #0000FF;">'Maxthon Version: '</span>+<span style="color: #000066;font-weight: bold;">external</span>.<span style="color: #000066;font-weight: bold;">max_version</span>);</div></div>


'''Maxthon 2.0'''
Maxthon 2.0 supporte un pack d'installation M2P de plugins (essentiellement un *.zip renommé en *.m2p. Le Plugin sera installé lorsque le fichier M2P est double-cliqué ou par glisser/déplacer dans la fenêtre de Maxthon.


===max_language_id===
'''Maxthon 1.X'''
<div style="margin-left: 10px;">
Les Plugins sont installés dans Maxthon 1.x en suivant cette procédure :
1. Fermer Maxthon
2. Extraire le fichier zip du Plugin dans le dossier "Plugin" du répertoire d'installation de Maxthon. En général, le fichier plugin.ini devrait se trouver dans C:\Program Files\Maxthon\Plugin\'''NewPlugin'''\plugin.ini
3. Ouvrir Maxthon, la fenêtre d'installation du Plugin devrait s'afficher
4. Confirmer l'installation du nouveau plugin


====''Remarks:''====
== Commandes des Plugins Script de Maxthon ==
''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. <br /> A list of Maxthon's Language IDs can be found at:<br />http://msdn.microsoft.com/library/?url=/library/en-us/intl/nls_238z.asp''


====Remarques :====
Maxthon propose plusieurs commandes pour améliorer la capacité des Plugins Script. Ces commandes peuvent être exécutées par l'intermédiaire de l'objet window.external. Certaines commandes nécessitent un ID de sécurité généré par Maxthon pour pouvoir s'exécuter.  
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. <br /> la liste des ID utilisés par Maxthon se trouve ici :<br />http://msdn.microsoft.com/library/?url=/library/en-us/intl/nls_238z.asp


====Exigences :====
'''Comment obtenir l'ID de sécurité'''
Maxthon version 1.0+<br /><br />


====Exemple :====
1. Les Plugins Script de type Button peuvent utiliser "%max_security_id" pour l'ID de sécurité
<span style="color: #000066;font-weight: bold;">alert</span>(<span style="color: #0000FF;">'Language ID='</span>+<span style="color: #000066;font-weight: bold;">external</span>.<span style="color: #000066;font-weight: bold;">max_language_id</span>);
</div>
2. Les Plugins Script de type Sidebar et les Plugins HTML de type Button doivent charger "max.src", un script généré par Maxthon. Ensuite "max_security_id" peut être utilisé :
<script src=max.src></script>




====current_tab==== '''(formerly''' cur_sel ''')''' <span style="color: #FFFFFF;background-color: #CC0000;">Non encore implémenté</span>
'''Référence des commandes des Plugins de Maxthon'''
<div style="margin-left: 10px;">


=====''Remarks:''=====
Sauf indication contraire, les commandes suivantes sont applicables pour Maxthon 2.0 et Maxthon 1.X :
''This property will return an integer number as the index of the tab which is activated.<br /><span style="color: #990000;">null</span> will be returned if there is no tab opened.<br /><span style="color: #000066;font-weight: bold;">current_tab</span><span style="color: #CC0000;font-weight: bold;"> is introduced in Maxthon 2.0 as a replacement of </span><span style="color: #000066;font-weight: bold;">cur_sel</span><span style="color: #CC0000;font-weight: bold;"> because the old property name is too obscure to understand.</span><br /><br />''


=====Remarques :=====
1. '''max_version''' - retourne le numéro de version de Maxthon
Cette propriété retournera un nombre entier qui représente l'index de l'onglet qui est actif.<br /><span style="color: #990000;">null</span> sera retourné s'il n'y a auncun onglet d'ouvert.<br /><span style="color: #000066;font-weight: bold;">current_tab</span><span style="color: #CC0000;font-weight: bold;"> a été introduit dans Maxthon v2.0 en remplacement de </span><span style="color: #000066;font-weight: bold;">cur_sel</span><span style="color: #CC0000;font-weight: bold;"> parce que le nom de l'ancienne propriété était trop obscur à comprendre.</span><br /><br />
Exemple :
alert(external.max_version);


=====Exigences :=====
2. '''max_language_id''' - retourne l'ID de langue de Maxthon
Maxthon version 2.0+ (utiliser <span style="color: #000066;font-weight: bold;">cur_sel</span> pour les versions 1.x)<br /><br />
Exemple :
alert(external.max_language_id);


=====Exemple :=====
Note : Maxthon 2.0 et Maxthon 1.X ont un format d'ID de langue différent
<div style="margin: 5px;padding: 10px;background: #F3F3F3;border: 1px dashed #CCCCCC;"><span style="color: #000066;font-weight: bold;">alert</span>(<span style="color: #0000FF;">'Current Tab Index: '</span>+<span style="color: #000066;font-weight: bold;">external</span>.<span style="color: #000066;font-weight: bold;">current_tab</span>);</div></div>


3. '''tab_count''' - retourne le nombre d'onglets ouverts dans Maxthon
Exemple :
alert(external.tab_count);


====tab_count====
4. '''cur_sel''' - retourne l'index de l'onglet en cours de Maxthon
<div style="margin-left: 10px;">
Exemple :
alert(external.cur_sel);


=====''Remarks:''=====
5. '''m2_plugin_folder( security_id , plugin_name )''' - retourne le chemin du dossier du Plugin spécifié
''This property will return current tab count as an integer.<br /><br />''
Exemple :
alert(external.m2_plugin_folder( %max_security_id , 'ViewSource!'));


=====Remarques :=====
6. '''m2_run_cmd( security_id , command_id )''' - exécute l'ID de la commande spécifiée
  Cette propriété retournera le nombre d'onglet en cours sous la forme d'un entier.<br /><br />
Exemple :
                external. m2_run_cmd( %max_security_id , 32772 ));
   
Note: Maxthon 2.0 et Maxthon 1.X ont des ID de commande différents. Les ID des commandes se trouvent dans le fichier langue de Maxthon.


=====Exigences :=====
7. '''get_tab( security_id , tab_index )''' - retourne l'objet Windows de l'onglet spécifié
  Maxthon version 1.0+<br /><br />
Exemple :
var oWin=external.get_tab(%max_security_id, 0);
alert(oWin.document.URL);
8. '''activate_tab( security_id , tab_index )''' - active l'onglet spécifié
Exemple :
external.activate_tab(%max_security_id, 0);
9. '''close_tab( security_id , tab_index )''' - ferme l'onglet spécifié
   
Exemple :
external.close_tab(%max_security_id, 0);
10. '''readFile( security_id, plugin_name, file_name)''' - lit le contenu du fichier texte spécifié
Example :
var sText=external.readFile(%max_security_id, 'ViewPage', 'readme.txt');
alert(sText);


=====Exemple :=====
11. '''writeFile( security_id, plugin_name, file_name, content )''' - écrit le contenu dans le fichier texte spécifié
<span style="color: #000066;font-weight: bold;">alert</span>(<span style="color: #0000FF;">'Tabs Count: '</span>+<span style="color: #000066;font-weight: bold;">external</span>.<span style="color: #000066;font-weight: bold;">tab_count</span>);
</div>
Exemple :
external.writeFile(%max_security_id, 'ViewPage', 'test.txt', 'Ceci est le contenu du fichier');


12. '''m2_readIni( security_id, plugin_name , file_name , section_name , key , default_value)''' - lit les données du fichier INI spécifié
Exemple :
var sDownloadTool=external.m2_readIni(%max_security_id, 'ViewPage', 'plugin.ini', 'Settings', 'Tool', '');
alert(sDownloadTool);


==Méthodes générales==
13. '''m2_writeIni( security_id , plugin_name , file_name , section_name , key , value )''' - écrit les données dans le fichier INI spécifié
Exemple :
external.m2_writeIni(%max_security_id, 'ViewPage', 'test.ini', 'Config', 'height', '100px');


====addFavorite(''url'' '''[''', ''title''''']''')====
14. '''max_modelessDialog( security_id , url , option , attr , window )''' - retourne une page de dialogue en mode Web
<div style="margin-left: 10px;">
Exemple :
var oDialog= external.max_modelessDialog( %max_security_id , 'blank.html', window , '', window );
var oDoc=oDialog.document;
oDoc.write('Testing');
oDoc.close();


=====''Parameters:''=====
15. '''max_activex(security_id ,program_id)''' - retourne l'objet ActiveX spécifié
'' ''url'' : string<br /> The url to add.<br /><br />''title'' : string<br /> Optional. The title of the url.<br /><br />''
Exemple :
var oWSH=external.max_activex(%max_security_id, 'WScript.Shell');
oWSH.run('notepad.exe');


=====Paramètres :=====
16. '''m2_search_text(security_id)''' - retourne le texte de la barre de recherche
''url'' : chaîne<br /> L'url à ajouter.<br /><br />''title'' : chaîne<br /> Optionnel. Le titre de l'url.<br /><br />
Exemple :
alert(m2_search_text(%max_security_id));


=====''Remarks:''=====
17. '''max_callback(event_name)''' - une fonction qui est exécutée lorsque certains événements de Maxthon se produisent (pour les Plugins HTML de type Button et les Plugins Script de type Sidebar)
'' Show the Add Favorite dialog to ask user to add a new Favorites Item.<br /> This function will return <span style="color: #CC0000;font-weight: bold;">false</span> if user cancelled this operation.<br /><br />''
Les Plugins HTML de type Button et les Plugins Script de type Sidebar peuvent utiliser la fonction max_callback pour réagir à certains événements de Maxthon comme le changement d'onglet.
Exemple :
function max_callback(x){
if(x=='tab_change') alert('L'onglet en cours a changé.');
}


=====Remarques :=====
En testant le paramètre de la fonction max_callback, le Plugin peut récupérer les événements suivants :
  Affiche la boîte de dialogue Ajouter un Favori pour demander à l'utilisateur d'ajouter un nouveau Favori.<br /> Cette fonction retournera <span style="color: #CC0000;font-weight: bold;">faux</span> si l'utilisateur a annulé cette opération.<br /><br />
   
'''Plugins HTML de type Button'''


=====Exigences :=====
'''tab_change''' – après que l'onglet en cours ait changé
Maxthon version 1.0+<br /><br />


=====Exemple :=====
'''document_Complete''' - après que l'onglet en cours soit entièrement chargé
<span style="color: #000066;font-weight: bold;">external</span>.<span style="color: #000066;font-weight: bold;">addFavorite</span>(<span style="color: #0000FF;">"http://www.maxthon.com"</span>);


<span style="color: #000066;font-weight: bold;">external</span>.<span style="color: #000066;font-weight: bold;">addFavorite</span>(<span style="color: #0000FF;">"http://www.maxthon.com"</span>, <span style="color: #0000FF;">"Site officiel de Maxthon"</span>);
'''self_destroy''' - lorsque le HTML est déchargé, normalement lorsque Maxthon est fermé
</div>




====addProxy(''name'', ''address'', ''type'')====
'''Plugins Script de type Sidebar'''
<div style="margin-left: 10px;">


=====''Parameters:''=====
'''sidebar_tab_change''' - après changement de l'onglet actif
'' ''name'' : string<br /> The display name of proxy.<br /><br />''address'' : string<br /> The IP address or Domain name of proxy.<br /><br />''type'' : integer<br /> A number indicates the speed rating of proxy.<br /> = HTTP Proxy, <span style="color: #FF6600;">1</span> = SOCKS4A Proxy, <span style="color: #FF6600;">2</span> = SOCKS5 Proxy<br /><br />''


=====Paramètres :=====
'''sidebar_activate''' - lorsque le Plugin Sidebar est activé
''name'' : chaîne<br /> Le nom du Proxy.<br /><br />''address'' : chaîne<br /> L'adresse IP ou le nom de domaine du Proxy.<br /><br />''type'' : entier<br /> Un nombre indiquant la vitesse du Proxy.<br /> = Proxy HTTP, <span style="color: #FF6600;">1</span> = Proxy SOCKS4A, <span style="color: #FF6600;">2</span> = Proxy SOCKS5<br /><br />


=====''Remarks:''=====
'''sidebar_deactivate''' - lorsque le Plugin Sidebar est désactivé
'' Add a new proxy into Maxthon's proxy list. A dialog will be shown to the user.<br /> This function will return <span style="color: #CC0000;font-weight: bold;">false</span> if user cancelled this operation.<br /><br />''


=====Remarques :=====
'''sidebar_unload''' - lorsque le Plugin Sidebar est déchargé (Maxthon est fermé)
Ajoute un nouveau Proxy dans liste des Proxy de Maxthon. Une boîte de dialogue sera présentée à l'utilisateur.<br /> Cette fonction retournera <span style="color: #CC0000;font-weight: bold;">faux</span> si l'utilisateur a annulé cette opération.<br /><br />


=====Exigences :=====
Maxthon version 2.0+<br /><br />


=====Exemple :=====
18. '''max_getObj''' (pour Maxthon 2.0 seulement) - retourne plusieurs objets de Maxthon :
<span style="color: #000066;font-weight: bold;">external</span>.<span style="color: #000066;font-weight: bold;">addProxy</span>(<span style="color: #0000FF;">"My proxy"</span>,<span style="color: #0000FF;">"192.168.1.0:8080"</span>, <span style="color: #FF6600;">1</span>);
</div>


'''Info'''  - information générale sur Maxthon


====addFilter(''url_mask'', ''type'')====
'''Adhunter''' – à propos du tueur de pubs
<div style="margin-left: 10px;">


=====''Parameters:''=====
'''FavManager''' – à propos des Favoris
'' ''url_mask'' : string<br /> Address mask to match blocked addresses. Supports Regular Expression.<br /><br />''type'' : integer<br /> A number indicates which Filter list to add.<br /> = Popup Filter, <span style="color: #FF6600;">1</span> = Content Filter<br /><br />''


=====Paramètres :=====
'''RssManager''' à propos des flux RSS
''url_mask'' : chaîne<br /> Masque d'adresse qui correspond aux adresses à bloquer. Supporte les expressions régulières.<br /><br />''type'' : entier<br /> Un nombre indiquant la liste de filtres à ajouter.<br /> = Filtre de Popup, <span style="color: #FF6600;">1</span> = Filtre de contenu<br /><br />


=====''Remarks:''=====
'''PluginManager''' - à propos des Plugins, pour Maxthon 2.0.5 ou supérieur
'' Add a new filter policy into Maxthon. A dialog will be shown to the user.<br /> This function will return '''false''' if user cancelled this operation.<br /><br />''


=====Remarques :=====
Ajoute une nouvelle politique de filtrage dans Maxthon. Une boîte de dialogue sera présentée à l'utilisateur.<br /> Cette fonction retournera '''faux''' si l'utilisateur a annulé cette opération.<br /><br />


=====Exigences :=====
Exemple :
Maxthon version 2.0+<br /><br />
var oInfo=external.max_getObj(%max_security_id, 'info');


=====Exemple:=====
<span style="color: #000066;font-weight: bold;">external</span>.<span style="color: #000066;font-weight: bold;">addFilter</span>(<span style="color: #0000FF;">"http://www.advertisement.com/img/*"</span>, );
</div>


'''L'objet Info supporte les propriétés et méthodes suivantes :'''
Propriétés :


====max_addProxyProvider(''URL'')====
'''fileProxy''' - en lecture seule, retourne le chemin du document de configuration du Proxy utilisateur en cours.
<div style="margin-left: 10px;">
Exemple :
var oInfo=external.max_getObj(%max_security_id, 'info');
alert(oInfo.fileProxy);


=====''Parameters:''=====
'''folderUser''' - en lecture seule, retourne le chemin du dossier du profil de l'utilisateur en cours
'' ''URL'' : string<br /> The URL of proxy list file. File format please refer to [proxyprovider.htm this document].<br /><br />''
 
Exemple :
var oInfo=external.max_getObj(%max_security_id, 'info');
alert(oInfo. folderUser);


=====Paramètres :=====
Méthodes :
''URL'' : chaîne<br /> L'URL du fichier de la liste des Proxy. Pour le format du fichier, se reporter à [proxyprovider.htm ce document].<br /><br />
'''getFolderPluginData(plugin_name)''' - obtient le chemin du dossier de stockage des données d'un Plugin pour l'utilisateur en cours et le Plugin indiqué
Exemple :
var oInfo=external.max_getObj(%max_security_id, 'info');
alert(oInfo.getFolderPluginData('ViewSource!'));


=====''Remarks:''=====
'' Add a new Proxy Provider into Maxthon Broser. A dialog will be shown to the user.<br /> This function will return <span style="color: #CC0000;font-weight: bold;">false</span> if user cancelled this operation.<br /><br />''


=====Remarques :=====
'''L'object AdHunter supporte les méthodes suivantes :'''
  Ajoute un nouveau fournisseur de Proxy dans Maxthon. Une boîte de dialogue sera présentée à l'utilisateur.<br /> Cette fonction retournera <span style="color: #CC0000;font-weight: bold;">faux</span> si l'utilisateur a annulé cette opération.<br /><br />
   
Méthodes :


=====Exigences :=====
'''reloadFilter(filter_name)''' – recharge le filtre de Maxthon spécifié (actuellement seulement les filtres de contenu) après avoir modifié le filtre en question
Maxthon version 2.0+<br /><br />
Exemple :
var oAdHunter=external.max_getObj(%max_security_id, 'AdHunter');
oAdHunter.reloadFilter('content');


=====Exemple :=====
'''enableFilter(filter_name, bEnable)''' – active ou désactive le filtre de 'contenu' ou de 'Popup' de Maxthon
<span style="color: #000066;font-weight: bold;">external</span>.<span style="color: #000066;font-weight: bold;">max_addProxyProvider</span>(<span style="color: #0000FF;">"http://www.freeproxy.cn/m2proxy/proxylist.xml"</span>);
</div>
Exemple :
var oAdHunter=external.max_getObj(%max_security_id, 'AdHunter');
oAdHunter.enableFilter ('content', false);




====m2_run_cmd(''security_id'', ''command_id'')====
'''L'objet PluginManager supporte les méthodes suivantes :'''
<div style="margin-left: 10px;">


=====''Parameters:''=====
'''getPluginFolder''' - retourne le chemin du dossier principal du Plugin de Maxthon
'' ''security_id'' : string<br /> Maxthon's Security ID.<br /><br />''command_id'' : integer<br /> The internal command ID of Maxthon.<br /><br />''


=====Paramètres :=====
Exemple :
''security_id'' : chaîne<br /> ID de sécurité de Maxthon.<br /><br />''command_id'' : entier<br /> L'ID de la commande interne de Maxthon.<br /><br />
var oPluginManager=external.max_getObj(%max_security_id, 'PluginManager');
alert(oPluginManager.getPluginFolder)


=====''Remarks:''=====
'''getCount''' - retourne le total de tous les Plugins installés, qu'ils soient activés ou non
'' This function will call a Maxthon's command with specified ''command_id''.<br /> Most usable Command IDs can be found in the language file inside Maxthon's language folder.<br /><span style="color: #CC0000;font-weight: bold;">Command ID might be different between versions. Please do not use this function if not required.</span><br /><br />''


=====Remarques :=====
Exemple :
Cette fonction appellera une commande de Maxthon avec le ''command_id'' spécifié.<br /> De nombreux ID de commande peuvent être trouvés dans le fichier langage dans le répertoire langage de Maxthon.<br /><span style="color: #CC0000;font-weight: bold;">L'ID de la commande peut être différent suivant la version. N'utilisez pas cette fonction si ce n'est pas nécessaire.</span><br /><br />
var oPluginManager=external.max_getObj(%max_security_id, 'PluginManager');
alert(oPluginManager.getCount)


=====Exigences :=====
'''getList''' - retourne une liste qui contient des informations comme le nom, l'auteur, etc. de tous les Plugins
Maxthon version 1.0+<br /><br />


=====Exemple :=====
Exemple :
<span style="color: #000066;font-weight: bold;">external</span>.<span style="color: #000066;font-weight: bold;">m2_run_cmd</span>(<span style="color: #0000FF;">security_id</span>, <span style="color: #FF6600;">32772</span>); // Ouvre une page vierge
var oPluginManager=external.max_getObj(%max_security_id, 'PluginManager');
</div>
alert(oPluginManager.getList)


'''getPlugin(Index)''' - Index est un nombre, retourne les objets du Plugin correspondant


====m2_search_text(''security_id'')====
Exemple :
<div style="margin-left: 10px;">
var oPluginManager=external.max_getObj(%max_security_id, 'PluginManager');
var oPlugin=oPluginManager.getPlugin(0);


=====''Parameters:''=====
'' ''security_id'' : string<br /> Maxthon's Security ID.<br /><br />''


=====Paramètres :=====
'''L'objet Plugin retourné de getPlugin(Index) supporte les propriétés et méthodes suivantes :'''
''security_id'' : chaîne<br /> ID de sécurité de Maxthon.<br /><br />


=====''Remarks:''=====
Propriétés :
'' This function will return the text in Maxthon's Search Box as a string.<br /><br />''


=====Remarques :=====
'''title''' - lecture seule, retourne le nom du Plugin
Cette fonction retournera le texte de la barre de recherche de Maxthon sous la forme d'une chaîne.<br /><br />


=====Exigences :=====
Exemple :
Maxthon version 1.2+<br /><br />
alert(oPlugin.title);


=====Exemple:=====
'''folderName''' - lecture seule, retourne le nom du dossier du Plugin
<span style="color: #000066;font-weight: bold;">var</span> searchText=<span style="color: #000066;font-weight: bold;">external</span>.<span style="color: #000066;font-weight: bold;">m2_search_text</span>(<span style="color: #0000FF;">security_id</span>);
</div>


Exemple :
alert(oPlugin.folderName);


====m2_plugin_folder(''security_id'', ''plugin_name'')====
'''fullPath''' - lecture seule, retourne le chemin complet du dossier du Plugin
<div style="margin-left: 10px;">


=====''Parameters:''=====
Exemple :
'' ''security_id'' : string<br /> Maxthon's Security ID.<br /><br />''plugin_name'' : string<br /> The name of the plugin as defined in plugin.ini.<br /><br />''
alert(oPlugin.fullPath);


=====Paramètres :=====
'''enable''' - lecture/écriture, retourne ou définit si le Plugin est actif
''security_id'' : chaîne<br /> ID de sécurité de Maxthon.<br /><br />''plugin_name'' : chaîne<br /> Le nom du Plugin comme défini dans le fichier plugin.ini.<br /><br />


=====''Remarks:''=====
Exemple :
'' This function will return the local folder path of specified plugin as a string.<br /><br />''
oPlugin.enable=false;
alert(oPlugin.enable);
oPlugin.enable=true;
alert(oPlugin.enable);


=====Remarques :=====
'''startAfterPageDone''' - lecture/écriture, retourne ou définit si le Plugin est en démarrage automatique
Cette fonction retournera le dossier local du Plugin spécifié sous la forme d'une chaîne.<br /><br />


=====Exigences :=====
Exemple :
Maxthon version 1.2+<br /><br />
oPlugin.startAfterPageDone = true;
alert(oPlugin.startAfterPageDone);
oPlugin.startAfterPageDone = false;
alert(oPlugin.startAfterPageDone);


=====Exemple:=====
'''startAfterPageDoneUrl''' - lecture/écriture, retourne ou définit l'adresse pour laquelle le Plugin sera démarré automatiquement
<span style="color: #000066;font-weight: bold;">var</span> pluginPath=<span style="color: #000066;font-weight: bold;">external</span>.<span style="color: #000066;font-weight: bold;">m2_plugin_folder</span>(<span style="color: #0000FF;">security_id</span>, <span style="color: #0000FF;">"ViewSource!"</span>);
</div>


Exemple :
oPlugin.startAfterPageDoneUrl='*maxthon.com*|*maxthon.cn*';
alert(oPlugin.startAfterPageDoneUrl);


====m2_callerName(''security_id'', ''plugin_name'')====
Mêthodes :
<div style="margin-left: 10px;">


=====''Parameters:''=====
'''config()''' - ouvre la boîte de dialogue de configuration du Plugin (config.html)
'' ''security_id'' : string<br /> Maxthon's Security ID.<br /><br />''plugin_name'' : string<br /> The name of the plugin as defined in plugin.ini.<br /><br />''


=====Paramètres :=====
Exemple :
''security_id'' : chaîne<br /> ID de sécurité de Maxthon.<br /><br />''plugin_name'' : chaîne<br /> Le nom du Plugin comme défini dans le fichier plugin.ini.<br /><br />
oPlugin.config();


=====''Remarks:''=====
'''remove()''' - supprime le Plugin
'' This function will tell Maxthon the next function call is from a plugin.<br /> This function is usually used before the <span style="color: #000066;font-weight: bold;">window</span>.<span style="color: #000066;font-weight: bold;">open</span>() method to bypass the Popup Blocker of Maxthon for the plugin.<br /><br />''


=====Remarques :=====
Exemple :
Cette fonction indiquera à Maxthon la fonction suivante appelée à partir du Plugin.<br /> Cette fonction est habituellement utilisée avant l'ouverture de la méthode <span style="color: #000066;font-weight: bold;">window</span>.<span style="color: #000066;font-weight: bold;">open</span>() pour bypasser le bloqueur de Popup de Maxthon pour le Plugin.<br /><br />
oPlugin.remove();


=====Exigences :=====
== Mscript ==
Maxthon version 1.2+<br /><br />


=====Exemple :=====
Maxthon 2.0 supporte des mscripts personnalisés en plus des scripts pour les Plugins de type Button. Contrairement aux scripts normaux, les mscripts ne sont pas exécutés sur des pages Web ,ainsi les mscripts ne sont pas sujets aux restrictions de sécurité imposées aux scripts normaux,et on ne doit donc pas craindre qu'ils soient exploités par des pages Web. Les mscripts peuvent grandement améliorer les fonctionnalités des Plugins car ils peuvent fonctionner malgré la désactivation des scripts classiques et aussi accéder aux contenus des différentes frames d'une page web même si elles ne sont pas dans le même domaine.
<span style="color: #000066;font-weight: bold;">external</span>.<span style="color: #000066;font-weight: bold;">m2_callerName</span>(<span style="color: #0000FF;">security_id</span>, <span style="color: #0000FF;">"ViewSource!"</span>);<br /><span style="color: #000066;font-weight: bold;">window</span>.<span style="color: #000066;font-weight: bold;">open</span>(<span style="color: #0000FF;">"about:blank"</span>);
Pour utiliser mscript dans un Plugin de type Button, remplacez la balise <script...> par <mscript...>
</div>




====max_actSideBarItem(''plugin_name'')====
Exemple - le Plugin de type Button peut désactiver les scripts dans la page en cours en modifiant le contrôle de contenu de Maxthon :
<div style="margin-left: 10px;">


=====''Parameters:''=====
<script language="javascript">
'' ''plugin_name'' : string<br /> The name of the plugin as defined in plugin.ini.''
external.m2_run_cmd(%max_security_id, 33175);
</script>


=====Paramètres :=====
Mais après que les scripts aient été désactivés, le Plugin ne peut plus fonctionner. Ainsi, il ne pourra plus réactiver les scripts dans la page en cours. Au contraire, le Plugin mscript suivant peut fonctionner avec les scripts désactivés, ainsi il pourra réactiver les scripts dans la page en cours.
''plugin_name'' : chaîne<br /> Le nom du Plugin comme défini dans le fichier plugin.ini.


=====''Remarks:''=====
<mscript language="javascript">
'' This function will activate the sidebar plugins with the given name. <br /><br />''
external.m2_run_cmd(0, 33175);
</script>


=====Remarques :=====
Notez qu'un nombre arbitraire peut être utilisé comme %max_security_id lorsque le mscript est utilisé.
Cette fonction activera le Plugin de la barre latérale avec le nom indiqué. <br /><br />


=====Exigences :=====
Maxthon version 1.2+<br /><br />


=====Exemple :=====
==Créer un Plugin multilingue==
<span style="color: #000066;font-weight: bold;">external</span>.<span style="color: #000066;font-weight: bold;">max_actSideBarItem</span>(<span style="color: #0000FF;">"Calculator++"</span>);
Lien original :[http://forum.maxthon.com/index.php?showtopic=62954]
</div>


Il existe plusieurs façons de faire un Plugin multilingue. Personnellement j'ai utilisé la méthode suivante que je trouve assez pratique pour les auteurs et les traducteurs de Plugins :


====max_modelessDialog(''security_id'', ''url'', ''arguments'', ''features'', ''parent_window'')====
Pour les auteurs de Plugins
<div style="margin-left: 10px;">


=====''Parameters:''=====
# Dans le dossier des Plugins, créer un sous-dossier "Language" qui contiendra les fichiers de langue
'' ''security_id'' : string<br /> Maxthon's Security ID.<br /><br />''url'' : string<br /> The url of modeless dialog content.<br /><br />''arguments'' : variant<br /> The arguments pass to the modeless dialog's '''window.dialogArguments''' object.<br /><br />''features'' : string<br /> A String that specifies the window ornaments for the dialog box.<br /><br />''parent_window'' : object<br /> The parent '''window''' object of the dialog.''
# Créer le fichier de langue anglaise par défaut (créer un fichier texte et le nommer "0x0409.ini", "0x0409" est l'ID de la langue anglaise)
# Ouvrir le fichier avec un éditeur de texte et ajouter les chaînes de caractères nécessaires, eg.


=====Paramètres :=====
''security_id'' : chaîne<br /> ID de sécurité de Maxthon.<br /><br />''url'' : chaîne<br /> L'url du contenu de la boîte de dialogue.<br /><br />''arguments'' : variante<br /> Les arguments passés à l'objet '''window.dialogArguments''' de la boîte de dialogue .<br /><br />''features'' : chaîne<br /> Une chaîne qui spécifie les caractéristiques de la fenêtre de la boîte de dialogue.<br /><br />''parent_window'' : objet<br /> La racine de l'objet '''window''' de la boîte de dialogue.


=====''Remarks:''=====
[General]
'' This function is almost the same as '''window.showModelessDialog()''' but with two more parameters.<br /> With the ''security_id'' your plugin can bypass Maxthon's Popup Blocker.<br /> With the ''parent_window'' you can make the dialog being a child of another tab's '''window'''.<br /><br />''
01=Hello!
02=This is testing.
...


=====Remarques :=====
Ici les chaînes de caractères "01", "02", "..." etc. sont ajoutées sous la section "General".
Cette fonction est à peu près la même que '''window.showModelessDialog()''' mais avec 2 paramètres de plus.<br /> Avec le ''security_id'' votre Plugin peut bypasser le bloqueur de Popup de Maxthon.<br /> Avec le ''parent_window'' vous pouvez créer la boîte de dialogue qui est une fille d'une autre '''window''' de l'onglet.<br /><br />


=====Exigences :=====
Maxthon version 1.2+<br /><br />


=====Exemple :=====
Pour les Plugins de barre de boutons, ajouter la fonction suivante (remplacer "Test" par le nom de votre Plugin) dans le script du Plugin :
<span style="color: #000066;font-weight: bold;">external</span>.<span style="color: #000066;font-weight: bold;">max_modelessDialog</span>(<span style="color: #0000FF;">security_id</span>, <span style="color: #0000FF;">"about:blank"</span>, {"userid": 7, "key": "d3fe3asd"}, <span style="color: #0000FF;">"status:no; help:no; resizable:yes; scroll:yes;"</span>, window);
</div>




====get_tab(''security_id'', ''index'')====
function getStr(x){
<div style="margin-left: 10px;">
    var sString=external.m2_readIni(%max_security_id, 'Test', 'Language/'+external.max_language_id+'.ini', 'General', x, ''''''');
    if(!sString) sString=external.m2_readIni(%max_security_id, 'Test', 'Language/0x0409.ini', 'General', x, ''''''');
    return(sString);
}


=====''Parameters:''=====
'' ''security_id'' : string<br /> Maxthon's Security ID.<br /><br />''index'' : integer<br /> The index of the tab to get.<br /><br />''


=====Paramètres:=====
Pour les Plugin de Barre latérale, ajouter les scripts suivants dans l'entête de la section du fichier HTML :
''security_id'' : chaîne<br /> ID de sécurité de Maxthon.<br /><br />''index'' : entier<br /> L'index de l'onglet à obtenir.<br /><br />


=====''Remarks:''=====
'' This function will get the '''window''' object of specified tab in Maxthon.<br /><span style="color: #990000;">null</span> will be returned if the tab does not exist.<br /><br />''


=====Remarques:=====
<script src=max.src></script>
  Cette fonction obtiendra l'objet '''window''' de l'onglet spécifié dans Maxthon.<br /><span style="color: #990000;">null</span> sera retourné si l'onglet n'existe pas.<br /><br />
<script>
  function getStr(x){
    var sString=external.m2_readIni(max_security_id, 'Test', 'Language/'+external.max_language_id+'.ini', 'General', x, ''''''');
    if(!sString) sString=external.m2_readIni(max_security_id, 'Test', 'Language/0x0409.ini', 'General', x, ''''''');
    return(sString);
}
</script>


=====Exigences :=====
Maintenant la fonction "getStr" peut être utilisée pour récupérer les chaînes de caractères à partir des fichiers de langue. Par exemple "getStr('01')" essayera de récupérer chaîne de caractères "01" à partir du fichier langue qui correspond à la langue sélectionnée dans Maxthon. Si le fichier langue n'est pas trouvé, il récupèrera la chaîne de caractères "01" à partir du fichier de langue anglaise par défaut.
Maxthon version 1.0+<br /><br />


=====Exemple :=====
<span style="color: #000066;font-weight: bold;">var</span> objTab=<span style="color: #000066;font-weight: bold;">external</span>.<span style="color: #000066;font-weight: bold;">get_tab</span>(<span style="color: #0000FF;">security_id</span>, <span style="color: #FF6600;">5</span>);
</div>


Pour les traducteurs


====activate_tab(''security_id'', ''index'')====
# Récupérer l'identifiant de langue approprié pour votre traduction ici
<div style="margin-left: 10px;">
# Dupliquer le fichier de langue anglaise et renommer le avec l'ID de langue adéquat, ex. 0x040c.ini pour français
# Ouvrir le fichier avec un éditeur de texte et traduire les chaînes de caractères "01=", "02=", "..." etc.
# Enregistrer le fichier au format Unicode pour ne pas avoir de problème d'encodage
# Envoyer le fichier sur le forum ou à l'auteur du Plugin


=====''Parameters:''=====
Mettre le fichier de langue dans le dossier "Language" du Plugin. Il fonctionnera immédiatement si l'utilisateur sélectionne la langue adéquate.
'' ''security_id'' : string<br /> Maxthon's Security ID.<br /><br />''index'' : integer<br /> The index of the tab to be activated.<br /><br />''


=====Paramètres :=====
''security_id'' : chaîne<br /> ID de sécurité de Maxthon.<br /><br />''index'' : entier<br /> L'index de l'onglet à activer.<br /><br />


=====''Remarks:''=====
Traduire Plugin.ini
'' This function will activate the specified tab in Maxthon.<br /> Nothing will happen if the tab does not exist.<br /><br />''


=====Remarques :=====
En plus de la traduction des chaînes de caractères utilisées par les scripts du Plugin, il est recommandé aux traducteurs de traduire le fichier plugin.ini également. Dans ce cas, les commentaires et le menu déroulant du Plugin, s'ils sont présents, seront affichés dans la langue adéquate. Pour traduire le plugin.ini :
Cette fonction activera l'onglet spécifié dans Maxthon.<br /> Il ne se passera rien si l'onglet n'existe pas.<br /><br />


=====Exigences :=====
# Récupérer l'identifiant de langue approprié pour votre traduction ici
Maxthon version 1.0+<br /><br />
# Dupliquer le fichier plugin.ini et renommez-le par ex. plugin0x040c.ini pour le français
# Ouvrir le fichier avec un éditeur de texte et traduire les chaînes de caractères pour "Comments", et s'il y en a dans la section "[MyIE2Buttons]", traduire également "Name1", "Name2", ...
# Enregistrer le fichier au format Unicode pour ne pas avoir de problème d'encodage
# Envoyer le fichier sur le forum ou à l'auteur du Plugin


=====Exemple :=====
Mettre le fichier plugin.ini dans le dossier du Plugin. Il fonctionnera après le redémarrage de Maxthon et la réinitialisation de la barre de Plugins si l'utilisateur sélectionne la langue adéquate.
<span style="color: #000066;font-weight: bold;">external</span>.<span style="color: #000066;font-weight: bold;">activate_tab</span>(<span style="color: #0000FF;">security_id</span>, <span style="color: #FF6600;">1</span>);
</div>




====close_tab(''security_id'', ''index'')====
Exemple
<div style="margin-left: 10px;">


=====''Parameters:''=====
Le Plugin "Test" contient 2 langues, English (par défaut - 0x0409) et Chinois Simplifié (简体中文 - 0x0804). Essayez de changer la langue de Maxthon et cliquez sur le bouton du Plugin (redémarrer Maxthon et réinitialiser la barre de Plugins est nécessaire pour charger le plugin.ini pour une nouvelle langue). Essayez également d'ajouter un nouveau fichier de langue et un plugin.ini pour votre langue.
'' ''security_id'' : string<br /> Maxthon's Security ID.<br /><br />''index'' : integer<br /> Integer. The index of the tab to close.<br /><br />''


=====Paramètres :=====
''security_id'' : chaîne<br /> ID de sécurité de Maxthon.<br /><br />''index'' : entier<br /> Entier. L'index de l'onglet à fermer.<br /><br />


=====''Remarks:''=====
Texte original : [http://wiki.maxthon.com/index.php/Plugin_Reference_-_Maxthon_2.x Plugin Reference - Maxthon 2.x] traduit par Ldfa et corrigé par Ray1, POLAURENT, Ricouz et Vee.
'' This function will close the tab which ''index'' represents.<br /> Nothing will happen if the tab does not exist.<br /><br />''
 
=====Remarques :=====
Cette fonction fermera l'onglet représentant l'''index''.<br /> Il ne se passera rien si l'onglet n'existe pas.<br /><br />
 
=====Exigences :=====
Maxthon version 1.0+<br /><br />
 
=====Exemple :=====
<span style="color: #000066;font-weight: bold;">external</span>.<span style="color: #000066;font-weight: bold;">close_tab</span>(<span style="color: #0000FF;">security_id</span>, );
</div>
 
 
====readFile(''security_id'', ''plugin_name'', ''file_name'')====
<div style="margin-left: 10px;">
 
=====''Parameters:''=====
'' ''security_id'' : string<br /> Maxthon's Security ID.<br /><br />''plugin_name'' : string<br /> The name of calling plugin as defined in plugin.ini<br /><br />''file_name'' : string<br /> The file to read.<br /><br />''
 
=====Paramètres :=====
''security_id'' : chaîne<br /> ID de sécurité de Maxthon.<br /><br />''plugin_name'' : chaîne<br /> Le nom du Plugin appelé indiqué dans le fichier plugin.ini<br /><br />''file_name'' : chaîne<br /> Le ficher à lire.<br /><br />
 
=====''Remarks:''=====
'' This function can only be used in a plugin.<br /> The function will return the file content in string when success.<br /> If the plugin is not enabled or the ''plugin_name'' is not found, the function will fail and return '''null'''.<br /><br />''
 
=====Remarques :=====
Cette fonction peut seulement être utilisée dans un Plugin.<br /> La fonction retournera le contenu du fichier dans une chaîne en cas de succès.<br /> Si le Plugin n'est pas actif ou que le ''plugin_name'' n'est pas trouvé, la fonction échouera et retournera '''null'''.<br /><br />
 
=====Exigences :=====
Maxthon version 1.0+<br /><br />
 
=====Exemple :=====
<span style="color: #000066;font-weight: bold;">var</span> strFile=<span style="color: #000066;font-weight: bold;">external</span>.<span style="color: #000066;font-weight: bold;">readFile</span>(<span style="color: #0000FF;">security_id</span>, <span style="color: #0000FF;">"Test plugin"</span>, <span style="color: #0000FF;">"plugin.ini"</span>);<br />
</div>
 
 
====writeFile(''security_id'', ''plugin_name'', ''file_name'', ''content'')====
<div style="margin-left: 10px;">
 
=====''Parameters:''=====
'' ''security_id'' : string<br /> Maxthon's Security ID.<br /><br />''plugin_name'' : string<br /> The name of calling plugin as defined in plugin.ini<br /><br />''file_name'' : string<br /> The file to write.<br /><br />''content'' : string<br /> File content string to write.<br /><br />''
 
=====Paramètres :=====
''security_id'' : chaîne<br /> ID de sécurité de Maxthon.<br /><br />''plugin_name'' : chaîne<br /> Le nom du Plugin appelant comme indiqué dans le fichier plugin.ini<br /><br />''file_name'' : chaîne<br /> Le fichier à écrire.<br /><br />''content'' : chaîne<br /> Chaîne du contenu du fichier à écrire.<br /><br />
 
=====''Remarks:''=====
'' This function can only be used in a plugin.<br /> This function will return <span style="color: #CC0000;font-weight: bold;">true</span> when success.<br /> If the file is not found, the plugin is not enabled or the ''plugin_name'' is not found, the function will fail and return <span style="color: #CC0000;font-weight: bold;">false</span>.<br /><span style="color: #CC0000;font-weight: bold;">If a file with the same name exists, it will be overwritten.</span><br /><br />''
 
=====Remarques :=====
Cette fonction ne peut être utilisée que dans un Plugin.<br /> Cette fonction retournera <span style="color: #CC0000;font-weight: bold;">vrai</span> en cas de succès.<br /> Si le fichier n'est pas trouvé, le plugin n'est pas actif ou le ''plugin_name'' n'est pas trouvé, la fonction échouera et retournera <span style="color: #CC0000;font-weight: bold;">faux</span>.<br /><span style="color: #CC0000;font-weight: bold;">Si un fichier avec le même nom existe, il sera écrasé.</span><br /><br />
 
=====Exigences :=====
Maxthon version 1.0+<br /><br />
 
=====Exemple:=====
<span style="color: #000066;font-weight: bold;">external</span>.<span style="color: #000066;font-weight: bold;">writeFile</span>(<span style="color: #0000FF;">security_id</span>, <span style="color: #0000FF;">"Test plugin"</span>, <span style="color: #0000FF;">"setting.ini"</span>, <span style="color: #0000FF;">"username=abc\npass=qwrxcv"</span>);
</div>
 
 
====m2_readIni(''security_id'', ''plugin_name'', ''file_name'', ''section_name'', ''key'', ''default_value'')====
<div style="margin-left: 10px;">
 
=====''Parameters:''=====
'' ''security_id'' : string<br /> Maxthon's Security ID.<br /><br />''plugin_name'' : string<br /> The name of calling plugin as defined in plugin.ini.<br /><br />''file_name'' : string<br /> The name of the INI file to read.<br /><br />''section_name'' : string<br /> The INI section to read, without brackets [ ].<br /><br />''key'' : string<br /> The key of the entry to read.<br /><br />''default_value'' : string<br /> The default value to return if the key does not exist.<br /><br />''
 
=====Paramètres :=====
''security_id'' : chaîne<br /> ID de sécurité de Maxthon.<br /><br />''plugin_name'' : chaîne<br /> Le nom du Plugin appelant comme indiqué dans le fichier plugin.ini.<br /><br />''file_name'' : chaîne<br /> Le nom du fichier INI à lire.<br /><br />''section_name'' : chaîne<br /> La section INI à lire, sans crochet [ ].<br /><br />''key'' : chaîne<br /> La clé de l'entrée à lire.<br /><br />''default_value'' : chaîne<br /> La valeur par défaut à retourner si la clé n'existe pas.<br /><br />
 
=====''Remarks:''=====
'' This function will read the value of ''key'' under section ''section_name'' in INI file ''file_name''.<br /> The INI file must be placed inside the folder of plugin ''plugin_name''.<br /> The value will be returned as a '''string''' if success.<br /> If the file does not exist, the section does not exist or the key does not exist, the ''default_value'' will be returned.<br /><br />''
 
=====Remarques :=====
Cette fonction lira la valeur de la ''key'' sous la section ''section_name'' dans le fichier INI ''file_name''.<br /> Le fichier INI doit se trouver dans le dossier du Plugin ''plugin_name''.<br /> La valeur sera retournée sous la forme d'une '''string''' en cas de succès.<br /> Si le fichier n'existe pas, la section n'existe pas ou la clé n'existe pas, la ''default_value'' sera retournée.<br /><br />
 
=====Exigences :=====
Maxthon version 1.0+<br /><br />
 
=====Exemple :=====
<span style="color: #000066;font-weight: bold;">var</span> saveCount = <span style="color: #000066;font-weight: bold;">external</span>.<span style="color: #000066;font-weight: bold;">m2_readIni</span>(<span style="color: #0000FF;">security_id</span>, <span style="color: #0000FF;">"TestPlugin"</span>, <span style="color: #0000FF;">"settings.ini"</span>, <span style="color: #0000FF;">"general"</span>, <span style="color: #0000FF;">"saveCount"</span>, <span style="color: #0000FF;">"0"</span>);
</div>
 
 
====m2_writeIni(''security_id'', ''plugin_name'', ''file_name'', ''section_name'', ''key'', ''value'')====
<div style="margin-left: 10px;">
 
=====''Parameters:''=====
'' ''security_id'' : string<br /> Maxthon's Security ID.<br /><br />''plugin_name'' : string<br /> The name of calling plugin as defined in plugin.ini.<br /><br />''file_name'' : string<br /> The name of the INI file to write.<br /><br />''section_name'' : string<br /> The INI section to write, without brackets [ ].<br /><br />''key'' : string<br /> The key of the entry to write.<br /><br />''value'' : string/integer<br /> The value to write.<br /><br />''
 
=====Paramètres :=====
''security_id'' : chaîne<br /> ID de sécurité de Maxthon.<br /><br />''plugin_name'' : chaîne<br /> Le nom du Plugin appelant comme indiqué dans le fichier plugin.ini.<br /><br />''file_name'' : chaîne<br /> Le nom du fichier INI à écrire.<br /><br />''section_name'' : chaîne<br /> La section INI à écrire, sans crochet [ ].<br /><br />''key'' : chaîne<br /> La clé de l'entrée à écrire.<br /><br />''value'' : chaîne/entier<br /> La valeur à écrire.<br /><br />
 
=====''Remarks:''=====
'' This function will write a ''key'' and ''value'' pair entry under section ''section_name'' in INI file ''file_name''.<br /> The INI file can only be writen inside the folder of plugin ''plugin_name''.<br /> If the file does not exist, the section does not exist or the key does not exist, they will be created automatically.<br /> This function will return <span style="color: #CC0000;font-weight: bold;">true</span> when success and <span style="color: #CC0000;font-weight: bold;">false</span> when failed.<br /><br />''
 
=====Remarques :=====
Cette fonction écrira une ''key'' et une paire de ''value'' sous la section ''section_name'' dans le fichier INI ''file_name''.<br /> Le fichier INI ne peut être écrit que dans le dossier du Plugin ''plugin_name''.<br /> Si le fichier n'existe pas, la section n'existe pas ou la clé n'existe pas, ils seront crés automatiquement.<br /> Cette fonction retournera <span style="color: #CC0000;font-weight: bold;">vrai</span> en cas de succès et <span style="color: #CC0000;font-weight: bold;">faux</span> en cas d'échec.<br /><br />
 
=====Exigences :=====
Maxthon version 1.0+<br /><br />
 
=====Exemple :=====
<span style="color: #000066;font-weight: bold;">external</span>.<span style="color: #000066;font-weight: bold;">m2_writeIni</span>(<span style="color: #0000FF;">security_id</span>, <span style="color: #0000FF;">"TestPlugin"</span>, <span style="color: #0000FF;">"settings.ini"</span>, <span style="color: #0000FF;">"general</span>", <span style="color: #0000FF;">"saveCount"</span>, <span style="color: #FF6600;">25</span>);
</div>




<center>[[Base de connaissances de Maxthon 2.0]]</center>
<center>[[Base de connaissances de Maxthon 2.0]]</center>

Version actuelle datée du 30 décembre 2009 à 09:09

Types de Plugin de Maxthon

Le type de Plugin de Maxthon est défini par ModuleType (Script, HTML, COM et EXE) et Type (Button, Sidebar, Toolbar, COM_Button, MHO, MHO_Button) simultanément :


              Button    SideBar   Toolbar   COM_Button    MHO     MHO_Button
Script         oui       oui
HTML           oui
EXE            oui
COM            oui       oui        oui        oui        oui        oui
COM_Global     oui       oui        oui        oui


1. ModuleType - Script, HTML, EXE, COM et COM_Global

Script - Le Plugin Script peut être de type button, qui exécute un script lorsqu'il est cliqué. le script peut être dans un langage supporté par IE, comme le JavaScript ou le vbscript. Maxthon 2.0 supporte le mscript qui exécute l'environnement (plus de détails ci-après). Le Script peut également être de type sidebar, qui affiche un fichier HTML dans la barre latérale.

HTML - Un nouveau type de Plugin pour Maxthon 2.0 seulement. Le Plugin de type HTML est similaire au Plugin Script Sidebar dans sa nature. La différence majeure est que le Plugin Script Sidebar est affiché dans la barre latérale de Maxthon alors que le Plugin HTML est affiché comme un bouton dans la barre des Plugins ou n'importe quelle barre d'outils (barre d'état, barre des menus, barre des onglets, barre d'adresses...).

EXE - Le Plugin EXE sera affiché comme un bouton sur la barre des Plugins. Le Plugin EXE peut être n'importe quel fichier exécutable. Maxthon peut passer plusieurs paramètres au fichier exécutable comme l'URL de la page Web en cours ou le "handle" de la fenêtre de Maxthon.

COM - Un plugin COM peut instancier l'interface IObjectWithSite pour obtenir un pointeur sur l'onglet actif du navigateur, les évènements et sur le DOM pour toute manipulation .

COM_Global - Les Plugins COM_Global sont créés seulement une fois au démarrage de Maxthon, et sont détruits à la fermeture de Maxthon. Les Plugins COM_Global sont souvent pour les fonctions de navigation qui ne sont pas en relation avec le Document Object Model. Ainsi, les Plugins COM_Global peuvent implémenter une fonction PutMaxCommander à travers l'interface IDispatch pour obtenir un objet du Plugin de Maxthon, qui peut être utilisé de la même façon qu'un objet externe de Maxthon pour les Plugins script (cf. les commandes ci-dessous des Plugins script), pour interagir avec le Document Object Model des onglets et Maxthon.

Notez que Maxthon 2.0 est "multithread" (un "thread" pour chaque onglet). Les Plugins développés pour une interaction approfondie avec le Document Object Model des onglets doivent être développés en COM (par onglet) au lieu de COM_Global ainsi ils pourront fonctionner plus efficacement avec le même "thread" d'un onglet individuel.

2. Type - Button, SideBar, Toolbar, COM_Button, MHO, and MHO_Button

Button - Un bouton sera ajouté sur la barre des Plugins. L'opération spécifiée par le script (Plugin Script), l'exécutable (Plugin EXE), la DLL (Plugin COM) sera exécutée lorsque le bouton sera cliqué. En option, Les Plugins de bouton peuvent implémenter un menu déroulant pour le Plugin. Un Plugin de bouton COM doit implémenter l'interface IOleCommandTarget pour recevoir le clic du bouton. Si un menu est implémenté, la fonction IOleCommandTarget_Exec recevra un id de commande de 1 lorsque le bouton est cliqué, et un id de commande de 2 lorsque le premier item du menu est cliqué, et ainsi de suite. Un Plugin de bouton COM est créé lorsque le bouton est cliqué et est détruit lorsque l'onglet est fermé (comme IE7).

SideBar - Un bouton sera ajouté à la barre latérale, et un élément sera ajouté au menu principal > Affichage > Barre latérale. Lorsque le bouton ou l’élément du menu est cliqué, la barre latérale de Maxthon s'ouvrira et affichera le fichier HTML spécifié par le Plugin (Plugin script), ou la fenêtre spécifiée par le Plugin à travers l'interface IDeskBand (Plugin com ou com_global).

Toolbar - Les Plugins de barre d'outils doivent être écrits en COM. Une nouvelle barre d'outils sera ajoutée, qui pourra être affichée ou cachée à partir du menu principal > Affichage > Barre d'outils. Un Plugin de barre d'outils doit implémenter l'interface IDeskBand pour spécifier la fenêtre de la barre d'outils. Les Plugins de barre d'outils peuvent être COM ou COM_Global. Les Plugins de barre d'outils COM sont affectés à un onglet lorsque l'onglet est crée, et sont détruits lorsque l'onglet est fermé. Cela permet l'adoption de certaines barres d'outils d'IE dans Maxthon en l'état ou avec un minimum de changements. Les barres d'outils COM_Global sont créés uniquement au démarrage de Maxthon, et sont détruites à la fermeture de Maxthon. Une barre d'outils COM_Global peut instancier l'interface IObjectWithSite pour obtenir un pointeur sur l'onglet actif du navigateur à travers la fonction SetSite. Lorsque l'onglet actif est modifié, SetSite sera appelé de nouveau pour passer le pointeur sur le nouvel onglet actif du navigateur.

COM_Button - Les Plugins COM_Button sont identiques au Plugins de barre d'outils, à l'exception près que les Plugins COM_Button sont affichés dans Maxthon comme un bouton, et non pas comme une barre d'outils. Un Plugin COM_Button a la même flexibilité de positionnement dans l'interface de Maxthon que les autres boutons, mais il supporte également la richesse de l'interface d'une barre d'outils par rapport à celle d'un simple bouton.

MHO - Un Plugin MHO est identique au Browser Helper Object d'IE et doit être écrit en COM. Les Plugins MHO sont créés par onglet lorsque l'onglet est créé, et sont détruits lorsque l'onglet est fermé. Les Plugins MHO doivent instancier l'interface IObjectWithSite pour obtenir un pointeur sur l'onglet du navigateur ,de manière à interagir avec le DOM. Les Plugins MHO n'ont pas d'interface.

MHO_Button - Le Plugin MHO est une combinaison d'un Plugin MHO et d'un Plugin bouton COM. Les Plugins MHO_Button sont créés par onglet lorsque l'onglet est créé, et sont détruits lorsque l'onglet est fermé. En plus, une instance de Plugin MHO_Button sera créée lorsque son bouton est cliqué, et l'instance sera détruite lorsque l'opération est terminée. Le Plugin MHO_Button ajoute essentiellement une interface bouton au Plugin MHO.

Créer un Plugin pour Maxthon

Composants majeurs d’un Plugin de Maxthon

Un Plugin de Maxthon contient généralement les fichiers suivants :

Fichiers INI – Le fichier plugin.ini est nécessaire pour tous les Plugins de Maxthon. Il définit plusieurs attributs du Plugin.

Fichiers HTML/DLL/EXE file – Le composant principal nécessaire à tous les Plugins de Maxthon spécifiant l'opération à réaliser ou le contenu à afficher.

Fichier Icônes – L'icône du bouton (*.ICO) nécessaire aux Plugins bouton et barre latérale. Les plugins COM ou EXE peuvent utiliser des icones insérées dans leur code.

Config.html – Un fichier HTML optionnel pour être utilisé avec les Plugins de type Script et HTML comme boîte de dialogue de configuration.


Fichier plugin.ini


[General] nécessaire à la définition de plusieurs attributs du plugin


Name= nom du Plugin

Author= nom de l'auteur

Version= Version du Plugin

ModuleType= Peut être Script, HTML, EXE, COM, or COM_Global

FileName= Peut-être un fichier HTML (Plugins Script et HTML), un fichier DLL (Plugins COM) ou un fichier EXE (Plugins EXE)

Comments= La description affichée dans les options du Plugin et/ou l'info-bulle du Plugin de type Button

Type= Peut être M2Plugin_Button, M2Plugin_Sidebar, M2Plugin_Toolbar, M2Plugin_COM_Button, M2Plugin_MHO, ou M2Plugin_MHO_Button

IdealSize= La largeur et la hauteur de l'interface du Plugin (ex. 120 20, pour un Plugin HTML seulement)

IdealSizeVertical= La largeur et la hauteur de l'interface du Plugin lorsqu'il est positionné verticalement (ex 120 20, optionnel pour un Plugin HTML)

Icon= L'icône du bouton pour les Plugins de type Button ou Sidebar

HotIcon= L'icône du bouton lorsque le bouton du Plugin est survolé

CLSID= Le CSLID pour les Plugins de type COM et COM_Global

DefaultLocation= Optionnel, défini la localisation par défaut de l'icône du Plugin, peut être None (dans la barre des Plugins, mais non affichée après l'installation, l'utilisateur peut afficher le bouton à partir du menu Afficher ou masquer des boutons), MenuBar, ToolBar, ou StatusBar. S’il n'est pas définit, le Plugin sera affiché dans la barre des Plugins. Pour le Plugin de type Button et pour Maxthon 2.0.5 ou supérieur.

StartAfterPageDoneURL= Optionnel, définit les adresses pour lesquelles le Plugin doit démarrer automatiquement, supporte les caractères joker, et on peut utiliser "|" pour séparer les adresses, ex. *maxthon.com*|forum.maxthon.cn*. Si il n'est pas défini, le Plugin démarrera pour toutes les adresses, équivalent à *. Pour les Plugins de types Script et Button et pour Maxthon 2.0.5 ou supérieur.

StartAfterPageDoneURLExclude= Optionnel, définit les adresses pour lesquelles le Plugin ne doit pas démarrer automatiquement, a une priorité supérieure à startAfterPageDoneUrl. Utilise le même format que startAfterPageDoneUrl ex. forum.maxthon.cn/index.php?|*.maxthon.cn/index.php?showtopic*. Pour les Plugins de types Script et Button et pour Maxthon 2.0.5 ou supérieur.


[MyIE2Buttons] Optionnel pour définir le menu déroulant pour les Plugins de types Button et MHO_Button


Count= Le nombre d'éléments du menu déroulant

Name1= Le nom du 1er élément du menu déroulant

FileName1= Le nom du fichier, ou le nom du fichier + les paramètres pour les Plugins de type EXE, du 1er élément du menu déroulant. Pour les Plugins de type COM Button et COM MHO_Button, mettre un nom arbitraire et distinct, ex. 1 pour FileName1 et 2 pour FileName2 etc.


Installation d'un Plugin de Maxthon

Les Plugins de Maxthon sont installés dans le répertoire "Plugin" du dossier d'installation de Maxthon. Chaque Plugin possède son propre dossier dédié qui contient le fichier plugin.ini et les autres fichiers nécessaires et/ou sous-dossiers.

Un Plugin terminé, comprenant le dossier du Plugin et tous les fichiers et/ou sous-dossiers peut-être compressé dans un fichier ZIP (*.zip) pour être déployé.


Maxthon 2.0

Maxthon 2.0 supporte un pack d'installation M2P de plugins (essentiellement un *.zip renommé en *.m2p. Le Plugin sera installé lorsque le fichier M2P est double-cliqué ou par glisser/déplacer dans la fenêtre de Maxthon.

Maxthon 1.X

Les Plugins sont installés dans Maxthon 1.x en suivant cette procédure :

1. Fermer Maxthon

2. Extraire le fichier zip du Plugin dans le dossier "Plugin" du répertoire d'installation de Maxthon. En général, le fichier plugin.ini devrait se trouver dans C:\Program Files\Maxthon\Plugin\NewPlugin\plugin.ini

3. Ouvrir Maxthon, la fenêtre d'installation du Plugin devrait s'afficher

4. Confirmer l'installation du nouveau plugin

Commandes des Plugins Script de Maxthon

Maxthon propose plusieurs commandes pour améliorer la capacité des Plugins Script. Ces commandes peuvent être exécutées par l'intermédiaire de l'objet window.external. Certaines commandes nécessitent un ID de sécurité généré par Maxthon pour pouvoir s'exécuter.


Comment obtenir l'ID de sécurité

1. Les Plugins Script de type Button peuvent utiliser "%max_security_id" pour l'ID de sécurité

2. Les Plugins Script de type Sidebar et les Plugins HTML de type Button doivent charger "max.src", un script généré par Maxthon. Ensuite "max_security_id" peut être utilisé :

	<script src=max.src></script>


Référence des commandes des Plugins de Maxthon

Sauf indication contraire, les commandes suivantes sont applicables pour Maxthon 2.0 et Maxthon 1.X :

1. max_version - retourne le numéro de version de Maxthon

Exemple :

	alert(external.max_version);

2. max_language_id - retourne l'ID de langue de Maxthon

Exemple :

	alert(external.max_language_id);

Note : Maxthon 2.0 et Maxthon 1.X ont un format d'ID de langue différent

3. tab_count - retourne le nombre d'onglets ouverts dans Maxthon

Exemple :

	alert(external.tab_count);

4. cur_sel - retourne l'index de l'onglet en cours de Maxthon

Exemple :

	alert(external.cur_sel);

5. m2_plugin_folder( security_id , plugin_name ) - retourne le chemin du dossier du Plugin spécifié

Exemple :

	alert(external.m2_plugin_folder( %max_security_id , 'ViewSource!'));

6. m2_run_cmd( security_id , command_id ) - exécute l'ID de la commande spécifiée

Exemple :

               external. m2_run_cmd( %max_security_id , 32772 ));

Note: Maxthon 2.0 et Maxthon 1.X ont des ID de commande différents. Les ID des commandes se trouvent dans le fichier langue de Maxthon.

7. get_tab( security_id , tab_index ) - retourne l'objet Windows de l'onglet spécifié

Exemple :

	var oWin=external.get_tab(%max_security_id, 0);
	alert(oWin.document.URL);

8. activate_tab( security_id , tab_index ) - active l'onglet spécifié

Exemple :

	external.activate_tab(%max_security_id, 0);

9. close_tab( security_id , tab_index ) - ferme l'onglet spécifié

Exemple :

	external.close_tab(%max_security_id, 0);

10. readFile( security_id, plugin_name, file_name) - lit le contenu du fichier texte spécifié

Example :

	var sText=external.readFile(%max_security_id, 'ViewPage', 'readme.txt');
	alert(sText);

11. writeFile( security_id, plugin_name, file_name, content ) - écrit le contenu dans le fichier texte spécifié

Exemple :

	external.writeFile(%max_security_id, 'ViewPage', 'test.txt', 'Ceci est le contenu du fichier');

12. m2_readIni( security_id, plugin_name , file_name , section_name , key , default_value) - lit les données du fichier INI spécifié

Exemple :

	var sDownloadTool=external.m2_readIni(%max_security_id, 'ViewPage', 'plugin.ini', 'Settings', 'Tool', );
	alert(sDownloadTool);

13. m2_writeIni( security_id , plugin_name , file_name , section_name , key , value ) - écrit les données dans le fichier INI spécifié

Exemple :

	external.m2_writeIni(%max_security_id, 'ViewPage', 'test.ini', 'Config', 'height', '100px');

14. max_modelessDialog( security_id , url , option , attr , window ) - retourne une page de dialogue en mode Web

Exemple :

	var oDialog= external.max_modelessDialog( %max_security_id , 'blank.html', window , , window );
	var oDoc=oDialog.document;
	oDoc.write('Testing');
	oDoc.close();

15. max_activex(security_id ,program_id) - retourne l'objet ActiveX spécifié

Exemple :

	var oWSH=external.max_activex(%max_security_id, 'WScript.Shell');
	oWSH.run('notepad.exe');

16. m2_search_text(security_id) - retourne le texte de la barre de recherche

Exemple :

	alert(m2_search_text(%max_security_id));

17. max_callback(event_name) - une fonction qui est exécutée lorsque certains événements de Maxthon se produisent (pour les Plugins HTML de type Button et les Plugins Script de type Sidebar)

Les Plugins HTML de type Button et les Plugins Script de type Sidebar peuvent utiliser la fonction max_callback pour réagir à certains événements de Maxthon comme le changement d'onglet.

Exemple :

	function max_callback(x){
		if(x=='tab_change') alert('L'onglet en cours a changé.');
	}

En testant le paramètre de la fonction max_callback, le Plugin peut récupérer les événements suivants :

Plugins HTML de type Button

tab_change – après que l'onglet en cours ait changé

document_Complete - après que l'onglet en cours soit entièrement chargé

self_destroy - lorsque le HTML est déchargé, normalement lorsque Maxthon est fermé


Plugins Script de type Sidebar

sidebar_tab_change - après changement de l'onglet actif

sidebar_activate - lorsque le Plugin Sidebar est activé

sidebar_deactivate - lorsque le Plugin Sidebar est désactivé

sidebar_unload - lorsque le Plugin Sidebar est déchargé (Maxthon est fermé)


18. max_getObj (pour Maxthon 2.0 seulement) - retourne plusieurs objets de Maxthon :

Info - information générale sur Maxthon

Adhunter – à propos du tueur de pubs

FavManager – à propos des Favoris

RssManager – à propos des flux RSS

PluginManager - à propos des Plugins, pour Maxthon 2.0.5 ou supérieur


Exemple :

	var oInfo=external.max_getObj(%max_security_id, 'info');


L'objet Info supporte les propriétés et méthodes suivantes :

Propriétés :

fileProxy - en lecture seule, retourne le chemin du document de configuration du Proxy utilisateur en cours.

Exemple :

	var oInfo=external.max_getObj(%max_security_id, 'info');
	alert(oInfo.fileProxy);

folderUser - en lecture seule, retourne le chemin du dossier du profil de l'utilisateur en cours

Exemple :

	var oInfo=external.max_getObj(%max_security_id, 'info');
	alert(oInfo. folderUser);

Méthodes :

getFolderPluginData(plugin_name) - obtient le chemin du dossier de stockage des données d'un Plugin pour l'utilisateur en cours et le Plugin indiqué

Exemple :

	var oInfo=external.max_getObj(%max_security_id, 'info');
	alert(oInfo.getFolderPluginData('ViewSource!'));


L'object AdHunter supporte les méthodes suivantes :

Méthodes :

reloadFilter(filter_name) – recharge le filtre de Maxthon spécifié (actuellement seulement les filtres de contenu) après avoir modifié le filtre en question

Exemple :

	var oAdHunter=external.max_getObj(%max_security_id, 'AdHunter');
	oAdHunter.reloadFilter('content');

enableFilter(filter_name, bEnable) – active ou désactive le filtre de 'contenu' ou de 'Popup' de Maxthon

Exemple :

	var oAdHunter=external.max_getObj(%max_security_id, 'AdHunter');
	oAdHunter.enableFilter ('content', false);


L'objet PluginManager supporte les méthodes suivantes :

getPluginFolder - retourne le chemin du dossier principal du Plugin de Maxthon

Exemple :

	var oPluginManager=external.max_getObj(%max_security_id, 'PluginManager');
	alert(oPluginManager.getPluginFolder)

getCount - retourne le total de tous les Plugins installés, qu'ils soient activés ou non

Exemple :

	var oPluginManager=external.max_getObj(%max_security_id, 'PluginManager');
	alert(oPluginManager.getCount)

getList - retourne une liste qui contient des informations comme le nom, l'auteur, etc. de tous les Plugins

Exemple :

	var oPluginManager=external.max_getObj(%max_security_id, 'PluginManager');
	alert(oPluginManager.getList)

getPlugin(Index) - Index est un nombre, retourne les objets du Plugin correspondant

Exemple :

	var oPluginManager=external.max_getObj(%max_security_id, 'PluginManager');
	var oPlugin=oPluginManager.getPlugin(0);


L'objet Plugin retourné de getPlugin(Index) supporte les propriétés et méthodes suivantes :

Propriétés :

title - lecture seule, retourne le nom du Plugin

Exemple :

	alert(oPlugin.title);

folderName - lecture seule, retourne le nom du dossier du Plugin

Exemple :

	alert(oPlugin.folderName);

fullPath - lecture seule, retourne le chemin complet du dossier du Plugin

Exemple :

	alert(oPlugin.fullPath);

enable - lecture/écriture, retourne ou définit si le Plugin est actif

Exemple :

	oPlugin.enable=false;
	alert(oPlugin.enable);
	oPlugin.enable=true;
	alert(oPlugin.enable);

startAfterPageDone - lecture/écriture, retourne ou définit si le Plugin est en démarrage automatique

Exemple :

	oPlugin.startAfterPageDone = true;
	alert(oPlugin.startAfterPageDone);
	oPlugin.startAfterPageDone = false;
	alert(oPlugin.startAfterPageDone);

startAfterPageDoneUrl - lecture/écriture, retourne ou définit l'adresse pour laquelle le Plugin sera démarré automatiquement

Exemple :

	oPlugin.startAfterPageDoneUrl='*maxthon.com*|*maxthon.cn*';
	alert(oPlugin.startAfterPageDoneUrl);

Mêthodes :

config() - ouvre la boîte de dialogue de configuration du Plugin (config.html)

Exemple :

	oPlugin.config();

remove() - supprime le Plugin

Exemple :

	oPlugin.remove();

Mscript

Maxthon 2.0 supporte des mscripts personnalisés en plus des scripts pour les Plugins de type Button. Contrairement aux scripts normaux, les mscripts ne sont pas exécutés sur des pages Web ,ainsi les mscripts ne sont pas sujets aux restrictions de sécurité imposées aux scripts normaux,et on ne doit donc pas craindre qu'ils soient exploités par des pages Web. Les mscripts peuvent grandement améliorer les fonctionnalités des Plugins car ils peuvent fonctionner malgré la désactivation des scripts classiques et aussi accéder aux contenus des différentes frames d'une page web même si elles ne sont pas dans le même domaine. Pour utiliser mscript dans un Plugin de type Button, remplacez la balise <script...> par <mscript...>


Exemple - le Plugin de type Button peut désactiver les scripts dans la page en cours en modifiant le contrôle de contenu de Maxthon :

<script language="javascript">
external.m2_run_cmd(%max_security_id, 33175);
</script>

Mais après que les scripts aient été désactivés, le Plugin ne peut plus fonctionner. Ainsi, il ne pourra plus réactiver les scripts dans la page en cours. Au contraire, le Plugin mscript suivant peut fonctionner avec les scripts désactivés, ainsi il pourra réactiver les scripts dans la page en cours.

<mscript language="javascript">
external.m2_run_cmd(0, 33175);
</script>

Notez qu'un nombre arbitraire peut être utilisé comme %max_security_id lorsque le mscript est utilisé.


Créer un Plugin multilingue

Lien original :[1]

Il existe plusieurs façons de faire un Plugin multilingue. Personnellement j'ai utilisé la méthode suivante que je trouve assez pratique pour les auteurs et les traducteurs de Plugins :

Pour les auteurs de Plugins

  1. Dans le dossier des Plugins, créer un sous-dossier "Language" qui contiendra les fichiers de langue
  2. Créer le fichier de langue anglaise par défaut (créer un fichier texte et le nommer "0x0409.ini", "0x0409" est l'ID de la langue anglaise)
  3. Ouvrir le fichier avec un éditeur de texte et ajouter les chaînes de caractères nécessaires, eg.


[General]
01=Hello!
02=This is testing.
...

Ici les chaînes de caractères "01", "02", "..." etc. sont ajoutées sous la section "General".


Pour les Plugins de barre de boutons, ajouter la fonction suivante (remplacer "Test" par le nom de votre Plugin) dans le script du Plugin :


function getStr(x){
   var sString=external.m2_readIni(%max_security_id, 'Test', 'Language/'+external.max_language_id+'.ini', 'General', x, '');
   if(!sString) sString=external.m2_readIni(%max_security_id, 'Test', 'Language/0x0409.ini', 'General', x, '');
   return(sString);
}


Pour les Plugin de Barre latérale, ajouter les scripts suivants dans l'entête de la section du fichier HTML :


<script src=max.src></script>
<script>
function getStr(x){
   var sString=external.m2_readIni(max_security_id, 'Test', 'Language/'+external.max_language_id+'.ini', 'General', x, '');
   if(!sString) sString=external.m2_readIni(max_security_id, 'Test', 'Language/0x0409.ini', 'General', x, '');
   return(sString);
}
</script>

Maintenant la fonction "getStr" peut être utilisée pour récupérer les chaînes de caractères à partir des fichiers de langue. Par exemple "getStr('01')" essayera de récupérer chaîne de caractères "01" à partir du fichier langue qui correspond à la langue sélectionnée dans Maxthon. Si le fichier langue n'est pas trouvé, il récupèrera la chaîne de caractères "01" à partir du fichier de langue anglaise par défaut.


Pour les traducteurs

  1. Récupérer l'identifiant de langue approprié pour votre traduction ici
  2. Dupliquer le fichier de langue anglaise et renommer le avec l'ID de langue adéquat, ex. 0x040c.ini pour français
  3. Ouvrir le fichier avec un éditeur de texte et traduire les chaînes de caractères "01=", "02=", "..." etc.
  4. Enregistrer le fichier au format Unicode pour ne pas avoir de problème d'encodage
  5. Envoyer le fichier sur le forum ou à l'auteur du Plugin

Mettre le fichier de langue dans le dossier "Language" du Plugin. Il fonctionnera immédiatement si l'utilisateur sélectionne la langue adéquate.


Traduire Plugin.ini

En plus de la traduction des chaînes de caractères utilisées par les scripts du Plugin, il est recommandé aux traducteurs de traduire le fichier plugin.ini également. Dans ce cas, les commentaires et le menu déroulant du Plugin, s'ils sont présents, seront affichés dans la langue adéquate. Pour traduire le plugin.ini :

  1. Récupérer l'identifiant de langue approprié pour votre traduction ici
  2. Dupliquer le fichier plugin.ini et renommez-le par ex. plugin0x040c.ini pour le français
  3. Ouvrir le fichier avec un éditeur de texte et traduire les chaînes de caractères pour "Comments", et s'il y en a dans la section "[MyIE2Buttons]", traduire également "Name1", "Name2", ...
  4. Enregistrer le fichier au format Unicode pour ne pas avoir de problème d'encodage
  5. Envoyer le fichier sur le forum ou à l'auteur du Plugin

Mettre le fichier plugin.ini dans le dossier du Plugin. Il fonctionnera après le redémarrage de Maxthon et la réinitialisation de la barre de Plugins si l'utilisateur sélectionne la langue adéquate.


Exemple

Le Plugin "Test" contient 2 langues, English (par défaut - 0x0409) et Chinois Simplifié (简体中文 - 0x0804). Essayez de changer la langue de Maxthon et cliquez sur le bouton du Plugin (redémarrer Maxthon et réinitialiser la barre de Plugins est nécessaire pour charger le plugin.ini pour une nouvelle langue). Essayez également d'ajouter un nouveau fichier de langue et un plugin.ini pour votre langue.


Texte original : Plugin Reference - Maxthon 2.x traduit par Ldfa et corrigé par Ray1, POLAURENT, Ricouz et Vee.


Base de connaissances de Maxthon 2.0