Plugins de Maxthon - Comment faire
Tout développer /Tout replier

pour Maxthon Version 1.2.1

Questions générales à propos des Plugins : (+)

  1. Object COM :

    L'objet COM doit être implémenté dans l'interface IMyIEClient. Se reporter à IMyIE.h.

  2. Fichier Exe :

    Tous fichier win32 exécutables peuvent être utilisés comme plugin. Maxthon enverra differents paramètres dans certaines circonstances.
    Paramètre général :
    a. "-h=handle" : handle est le Wnd handle de la fenêtre principale de Maxthon, de format décimal.

  3. Fichier Script :

    Les fichiers de Script doivent être écris suivant le format suivant :

    Exemple :
    <script language="Javascript">
    alert(document.lastModified);
    </script>

    Le 'langage' doit être n'importe quel langage valide supporté par Internet Explorer.

Haut

Comment implémenter la fonction "Config" d'un Plugin ? (+)

Il y a un bouton 'Configurer' dans la page des options des 'Plugins de Maxthon'. Maxthon appellera la fonction 'Configurer' correspondante au plugin, lorsque l'utilisateur cliquera sur le bouton 'Configurer'.

  1. Objet COM :

    L'objet COM IMyIEClient::Config doit être appelé avec comme paramètre le hWnd handle de la boite de dialogue de configuration.

  2. Fichier Exe :

    Le fichier doit être appelé avec le paramètre "-setup". Par exemple, si le fichier est "abc.exe", alors Maxthon appellera "abc.exe -setup ..." .

  3. Fichier Script : (Disponible pour Maxthon version 1.1.067 et supérieure)

    Lorsque l'utilisateur clique sur le bouton 'configurer' dans la boite de dialogue de configuration des plugins, Maxthon essayera d'ouvrir le fichier 'config.html' de votre répertoire des plugins. Et un fichier 'max.src' sera crée pour permettre à votre plugin de récupérer le security_id, afin d'appeler certaines fonctions de Maxthon. Vous pouvez utiliser les réglages suivant pour préciser les dimensions de la boite de dialogue.
    <meta name="Dialog-Width" content="110">
    <meta name="Dialog-Height" content="120">

Haut

Comment ajouter ou modifier un protocole ? (+)

Avec Maxthon, le plugin peut établir un nouveau protocole, comme book://, ou modifier un protocole existant, comme ftp://. Lorsque l'utilisateur saisi le protocole dans la barre d'adresse ou clique sur le protocole sur la page Web, Maxthon appelera le plugin.

  1. Objet COM :

    Non supporté actuellement...

  2. Fichier Exe :

    Le fichier doit être appelé avec le paramètre "-u=url", où l'url est l'adresse que l'utilisateur veut visiter, comme book://www.mysite.com/abc.pdf, ou ftp://www.google.com.

  3. Fichier Script :

    Non supporté actuellement...

Haut
Comment créer un plugin de type "Bouton" ? (+)

Maxthon supporte des plugins de type "Bouton", qui peuvent être placés dans la barre des "Extensions d'IE". Le plugin est appelé lorsque l'utilisateur clique sur le bouton correspondant. Le 'Bouton' du plugin peut être implémenté en utilisant la méthode suivante.

  1. Objet COM :

    Lorsque l'utilisateur clique sur le bouton, Maxthon appelle l'interface Com IOleCommandTarget et IObjectWithSite en passant le pointeur IWebBrowser2 de la page courrante à la fonction IObjectWithSite::SetSite, puis appelle la fonction IOleCommandTarget::Exec. Ceci est identique à l'implémentation des boutons d'IE. Se reporter à MSDN pour plus d'informations.

    Fichier Plugin.ini :

    [General]
    Name=ComButton
    Author=bloodchen
    Version=1.0
    ModuleType=COM
    FileName=ComButton.dll
    CLSID={96E78121-9FF2-466D-B6CD-4038CAC1BB79}
    Comments=Bouton de type Com
    Type=M2Plugin_BUTTON
    HotIcon=hot.ico
    Icon=cold.ico


  2. Fichier Exe :

    Lorsque l'utilisateur cliquera sur le bouton, Maxthon appellera le fichier avec comme paramètres l'adresse courante et le handle de la fenêtre principale de Maxthon. Par exemple, si le fichier est abc.exe, alors Maxthon appellera abc.exe -h=23424 -u=http://www.yahoo.com, où 23424 est le handle de la fenêtre principale de Maxthon et http://www.yahoo.com est l'URL de la page courante.

    Fichier Plugin.ini :

    [General]
    Name=ExeButton
    Author=BloodChen
    Version=1.0
    ModuleType=EXE
    FileName=abc.exe
    Comments=Bouton de type Exe
    Type=M2Plugin_BUTTON
    Icon=p.ico

  3. Fichier Script :

    Lorsque l'utilisateur cliquera sur le bouton, Maxthon exécutera le script sur la page Web en cours.

    Fichier Plugin.ini :
    [General]
    Name=LastModified
    Author=bloodchen
    Version=1.0
    ModuleType=SCRIPT
    FileName=LastModified.htm
    Comments=Voir la date de dernière modification de la page en cours
    Type=M2Plugin_BUTTON
    HotIcon=hot.ico
    Icon=cold.ico

Haut

Comment créer un plugin de type "Volet latéral" ? (+)

Maxthon supporte des plugins de type "Volet latéral". Ce type de plugin se trouvent dans le volet latéral de Maxthon, en utilisant un fichier Html.

  1. HTML :

    Lorsque l'utilisateur clique sur le bouton, Maxthon charge le fichier Html dans le volet latéral, qui est indiqué dans le fichier Plugin.ini.

    Exemple Plugin.ini:

    [General]
    Name=Calculator++ 1.2
    Author=SiC
    Version=1.2
    ModuleType=SCRIPT
    FileName=calculator.htm
    Comments=Calculatrice programmable scientifique.
    Type=M2Plugin_Sidebar
    HotIcon=cpp.ico
    Icon=cpp.ico

  2. COM :

    Lorsque l'utilisateur clic sur le bouton, Maxthon chargera le contrôle COM dans la volet latéral, qui est défini dans le fichier plugin.ini.

    Exemple Plugin.ini:

    [General]
    Name=AXSidebar sample
    Author=bloodchen
    Version=1.0
    ModuleType=COM
    Comments=Simple contrôle ActiveX de volet latéral
    Type=M2Plugin_SideBar
    FileName=AXSidebar.dll
    CLSID={108C8E56-90AF-408B-873F-8AE3480BE090}
    HotIcon=ax.ico
    Icon=ax.ico

    Le plugin COM peut être implémenté de 2 façons :

    1. Un objet COM identique à l'implémentation de IE. Il doit utiliser l'interface IObjectWithSite,
      IDeskBand et optionellement IInputObject. Le plugin de volet latéral Net Snippet en est un exemple.

    2. Un contrôle activex. N'importe quel contrôle activex valide peut-être utilisé, fournissant le CLSID correcte. Le contrôle activex peut implémenter optionellement l'interface IObjectWithSite , à partir de laquelle Maxthon passera l'interface IWebBrowser2 de l'onglet actif. Si le contrôle activex n'est pas enregistré dans le système de l'utilisateur et que le nom de fichier n'est pas vide, Maxthon essayera d'enregistrer le fichier et de charger le contrôle de nouveau. Le plugin AXSidebar en est un exemple (avec code source).

Haut

Support étendu du DHTML (+)

Maxthon a étendu le support du DHTML en ajoutant un certains nombre de nouvelles commandes qui peuvent être appelées par le langage de script. Le code HTML ou script peut appeler la fonction par l'objet 'window.external'. La fonction peut être appelée à partir du script dans une page HTML ou un script de plugin.

Notez : Certaines fonctions nécessite un security_id comme premier paramètre qui n'était pas nécessaire dans les anciennes versions de MyIE2. Les plugins qui utilisent cette commande doivent être modifiés pour utiliser le security_id .

Comment récupérer le security_id ?
1. Pour les plugins de barre de boutons, vous devez avoir un %max_security_id dans vos fichiers de script, comme 'var security_id=%max_security_id", ainsi vous pourrez utiliser de security_id dans vos scripts.

2. Pour les plugins de barre latérale, un fichier nommé "max.src" doit être crée dans le répertoire de votre plugin et doit contenir "max_security_id=id". Vous pouvez inclure ce fichier dans votre page html pour récupérer l'id.


  1. addFavorite( url , title ) , addFavorite( url )

    Cette fonction demandera à l'utilisateur d'ajouter l''url' dans les favories, en utilisant 'title' comme nom d'url.

    Exemple 1: external.addFavorite( "http://www.google.com" ); Démo
    Exemple 2: external.addFavorite( "http://www.google.com","C'est google"); Démo

  2. 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.

    Exemple: external.addProxy("Mon proxy","192.168.1.0:8080",1,0); Démo

  3. 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.

    Exemple 1: external.addFilter("http://www.yahoo.com/ad*"); Démo
    Exemple 2: external.addFilter("http://www.yahoo.com/img/*", 0); Démo

  4. readFile( security_id, plugin_name, file_name)

    Cette fonction ne peut être utilisée que dans un script de plugin, pour des raisons de sécurité. Le 'plugin_name' se réfère au nom du plugin défini dans plugin.ini et le 'file_name' indique le nom du fichier qui doit être lu. La fonction retournera contenu du fichier. Si le plugin n'est pas capable de lire ou que le nom du plugin est erroné ou non trouvé, la fonction se terminera sur une erreur et retournera null.

    Exemple: var text = external.readFile(%max_security_id,"Test plugin","plugin.ini");

  5. 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é. Le 'plugin_name' se réfère au nom du plugin défini dans plugin.ini et le 'file_name' indique le nom du fichier qui doit être écrit. Le '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.
    Notez SVP: Le fichier sera écrasé à partir du début.

    Exemple: external.writeFile(%max_security_id,"Test plugin","setting.ini","username=abc\npass=qwrxcv");

  6. tab_count

    Cette commande returne le nombre total d'onglets sous la forme d'un entier.

    Exemple: var total_tab = external.tab_count ; Démo

  7. activate_tab( security_id , index )

    Cette fonction active l'onglet numéro 'index' de Maxthon.

    Exemple: external.activate_tab(%max_security_id,2)

  8. get_tab( security_id , index )

    Cette fonction retourne la page web de l'onglet index.

    Exemple: external.get_tab(%max_security_id,2)

  9. cur_sel

    Cette fonction retourne le numéro de l'onglet courant sous la forme d'un entier.

    Exemple: var cur_tab = external.cur_sel; Démo

  10. close_tab( security_id , index )

    Cette fonction ferme l'onglet numéro 'index' de Maxthon.

    Exemple: external.close_tab(%max_security_id,2)

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

    Cette fonction lit la clé utilisant la default_value dans le fichier ini spécifié par file_name dans le répertoire du plugin.

    Exemple: path = external.m2_readIni(%max_security_id,"testplugin","settings.ini","general","save","0");

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

    Cette fonction écrit la clé avec la valeur dans le fichier ini spécifié par file_name.

    Exemple: external.m2_writeIni(%max_security_id,"testplugin","settings.ini","general","save","true");

  13. m2_search_text( security_id )

    Cette propriété retourne le texte dans la barre de recherche de Maxthon.

    Exemple: var text = external.m2_search_text(%max_security_id)

  14. m2_run_cmd( security_id , id )

    Cette fonction appelle une commande de Maxthon avec l'ID. L'id de chaque commande sera présent dans le fichier de chaque langue.

    Exemple: external.m2_run_cmd(%max_security_id,32772); //Ceci ouvre une page vierge.

  15. m2_plugin_folder( security_id , plugin_name )

    Cette fonction retourne le répertoire local du plugin.

    Exemple: var folder = external.m2_plugin_folder(%max_security_id,"ViewSource!");
    Ceci retourne par exemple : "C:\Program Files\Maxthon\Plugin\ViewSource!\"

  16. max_actSideBarItem( plugin_name )

    Cette fonction active le plugin de la barre latérale du nom de 'plugin_name'.

    Exemple: external.max_actSideBarItem("Calculator++");

  17. max_modelessDialog( security_id , url , option , attr , window )

    Cette fonction ouvre un modelessDialog. C'est la même chose que la fonction window.ShowModelessDialog. Le dernire paramètre 'window' est l'objet fenêtre de la page web.

    Exemple: external.max_modelessDialog(%max_security_id,'example.htm',window,'status:no;help:no;resizable:yes;scroll:yes;',window)

  18. m2_callerName( security_id, plugin_name)

    Cette fonction indique à Maxthon que l'appel est réalisé à partir du 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.

    Exemple: external.m2_callerName(%max_security_id,"ViewSource!")

  19. max_showConfig( security_id, plugin_name)

    Cette fonction affiche la boîte de dialogue de configuration des plugins.

    Exemple: external.max_showConfig(%max_security_id,"ViewSource!")

  20. max_activex(security_id, prog_id)

    Cette fonction crée l'ActiveX avec le prog_id.

    Exemple: var XML=external.max_activex(%max_security_id,"Microsoft.XMLDOM")

  21. max_language_id

    Cette propriété représente la langue utilisée.
    Vous pouvez visualiser toutes les langues ici

    Exemple: var language=external.max_language_id

Haut

Fonctions callback des plugins de barre latérale : (+)

Dans un plugin de barre latéral, vous pouvez utiliser une fonction de script appelée max_callback(status).

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

Liens utiles :

Haut