diff options
Diffstat (limited to 'files/pt-br/mozilla/add-ons/sdk')
29 files changed, 0 insertions, 5370 deletions
diff --git a/files/pt-br/mozilla/add-ons/sdk/guides/index.html b/files/pt-br/mozilla/add-ons/sdk/guides/index.html deleted file mode 100644 index 1f7e439322..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/guides/index.html +++ /dev/null @@ -1,367 +0,0 @@ ---- -title: Guides -slug: Mozilla/Add-ons/SDK/Guides -tags: - - Add-on SDK - - NeedsTranslation - - TopicStub -translation_of: Archive/Add-ons/Add-on_SDK/Guides ---- -<p> </p> - -<div class="warning"> -<p>Support for extensions using XUL/XPCOM or the Add-on SDK was removed in Firefox 57, released November 2017. As there is no supported version of Firefox enabling these technologies, this page will be removed by December 2020.</p> - -<p>Add-ons using the techniques described in this document are considered a legacy technology in Firefox. Don't use these techniques to develop new add-ons. Use <a href="/en-US/Add-ons/WebExtensions">WebExtensions</a> instead. If you maintain an add-on which uses the techniques described here, consider migrating it to use WebExtensions.</p> - -<p><strong>Starting from <a href="https://wiki.mozilla.org/RapidRelease/Calendar">Firefox 53</a>, no new legacy add-ons will be accepted on addons.mozilla.org (AMO) for desktop Firefox and Firefox for Android.</strong></p> - -<p><strong>Starting from <a href="https://wiki.mozilla.org/RapidRelease/Calendar">Firefox 57</a>, only extensions developed using WebExtensions APIs will be supported on Desktop Firefox and Firefox for Android. </strong></p> - -<p>Even before Firefox 57, changes coming up in the Firefox platform will break many legacy extensions. These changes include multiprocess Firefox (e10s), sandboxing, and multiple content processes. Legacy extensions that are affected by these changes should migrate to use WebExtensions APIs if they can. See the <a href="https://blog.mozilla.org/addons/2017/02/16/the-road-to-firefox-57-compatibility-milestones/">"Compatibility Milestones" document</a> for more information.</p> - -<p>A wiki page containing <a href="https://wiki.mozilla.org/Add-ons/developer/communication">resources, migration paths, office hours, and more</a>, is available to help developers transition to the new technologies.</p> -</div> - -<section class="Quick_links" id="Quick_Links"> -<ol> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions"><strong>Browser extensions</strong></a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions#Getting_started">Getting started</a> - <ol> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/What_are_WebExtensions">What are extensions?</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Your_first_WebExtension">Your first extension</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Your_second_WebExtension">Your second extension</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Anatomy_of_a_WebExtension">Anatomy of an extension</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Examples">Example extensions</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/What_next_">What next?</a></li> - </ol> - </li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions#Concepts">Concepts</a> - <ol> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Using_the_JavaScript_APIs">Using the JavaScript APIs</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Content_scripts">Content scripts</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Match_patterns">Match patterns</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Working_with_files">Working with files</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Internationalization">Internationalization</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Security_best_practices">Security best practices</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Content_Security_Policy">Content Security Policy</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_messaging">Native messaging</a></li> - </ol> - </li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions#User_Interface">User interface</a> - <ol> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/user_interface">User Interface</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/user_interface/Browser_action">Toolbar button</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/user_interface/Page_actions">Address bar button</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/user_interface/Sidebars">Sidebars</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/user_interface/Context_menu_items">Context menu items</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/user_interface/Options_pages">Options page</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/user_interface/Extension_pages">Extension pages</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/user_interface/Notifications">Notifications</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/user_interface/Omnibox">Address bar suggestions</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/user_interface/devtools_panels">Developer tools panels</a></li> - </ol> - </li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions#How_to">How to</a> - <ol> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Intercept_HTTP_requests">Intercept HTTP requests</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Modify_a_web_page">Modify a web page</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Safely_inserting_external_content_into_a_page">Insert external content</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Add_a_button_to_the_toolbar">Add a button to the toolbar</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Implement_a_settings_page">Implement a settings page</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Working_with_the_Tabs_API">Work with the Tabs API</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Work_with_the_Bookmarks_API">Work with the Bookmarks API</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Work_with_the_Cookies_API">Work with the Cookies API</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Work_with_contextual_identities">Work with contextual identities</a></li> - </ol> - </li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions#Porting">Porting</a> - <ol> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Porting_a_Google_Chrome_extension">Porting a Google Chrome extension</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Porting_a_legacy_Firefox_add-on">Porting a legacy Firefox extension</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Embedded_WebExtensions">Embedded WebExtensions</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Comparison_with_the_Add-on_SDK">Comparison with the Add-on SDK</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Comparison_with_XUL_XPCOM_extensions">Comparison with XUL/XPCOM extensions</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Chrome_incompatibilities">Chrome incompatibilities</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Differences_between_desktop_and_Android">Differences between desktop and Android</a></li> - </ol> - </li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions#Firefox_workflow">Firefox workflow</a> - <ol> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/User_experience_best_practices">User Experience</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Temporary_Installation_in_Firefox">Temporary Installation in Firefox</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Debugging">Debugging</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Testing_persistent_and_restart_features">Testing persistent and restart features</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Developing_WebExtensions_for_Firefox_for_Android">Developing for Firefox for Android</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Getting_started_with_web-ext">Getting started with web-ext</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/web-ext_command_reference">web-ext command reference</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/WebExtensions_and_the_Add-on_ID">Extensions and the Add-on ID</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Request_the_right_permissions">Request the right permissions</a></li> - </ol> - </li> - <li data-default-state="closed"><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API">JavaScript APIs</a> - <ol> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Browser_support_for_JavaScript_APIs">Browser support for JavaScript APIs</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/alarms">alarms</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/bookmarks">bookmarks</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/browserAction">browserAction</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/browserSettings">browserSettings</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/browsingData">browsingData</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/clipboard">clipboard</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/commands">commands</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/contentScripts">contentScripts</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/contextualIdentities">contextualIdentities</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/cookies">cookies</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/devtools.inspectedWindow">devtools.inspectedWindow</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/devtools.network">devtools.network</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/devtools.panels">devtools.panels</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/dns">dns</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/downloads">downloads</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/events">events</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/extension">extension</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/extensionTypes">extensionTypes</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/find">find</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/history">history</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/i18n">i18n</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/identity">identity</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/idle">idle</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/management">management</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/menus">menus</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/notifications">notifications</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/omnibox">omnibox</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/pageAction">pageAction</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/permissions">permissions</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/pkcs11">pkcs11</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/privacy">privacy</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/proxy">proxy</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime">runtime</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/search">search</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/sessions">sessions</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/sidebarAction">sidebarAction</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/storage">storage</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/tabs">tabs</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/theme">theme</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/topSites">topSites</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/types">types</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/webNavigation">webNavigation</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/webRequest">webRequest</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/API/windows">windows</a></li> - </ol> - </li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json">Manifest keys</a> - <ol> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/applications">applications</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/author">author</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/background">background</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/browser_action">browser_action</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/chrome_settings_overrides">chrome_settings_overrides</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/chrome_url_overrides">chrome_url_overrides</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/commands">commands</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/content_scripts">content_scripts</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/content_security_policy">content_security_policy</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/default_locale">default_locale</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/description">description</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/developer">developer</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/devtools_page">devtools_page</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/homepage_url">homepage_url</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/icons">icons</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/incognito">incognito</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/manifest_version">manifest_version</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/name">name</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/omnibox">omnibox</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/optional_permissions">optional_permissions</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/options_ui">options_ui</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/page_action">page_action</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/permissions">permissions</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/protocol_handlers">protocol_handlers</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/short_name">short_name</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/sidebar_action">sidebar_action</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/theme">theme</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/version">version</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/version_name">version_name</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/web_accessible_resources">web_accessible_resources</a></li> - </ol> - </li> - <li><a href="/en-US/docs/Mozilla/Add-ons/Themes"><strong>Themes</strong></a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/Themes/Theme_concepts">Browser themes</a> - <ol> - <li><a href="/en-US/docs/Mozilla/Add-ons/Themes/Theme_concepts">Browser theme concepts</a></li> - </ol> - </li> - <li><a href="/en-US/docs/Mozilla/Add-ons/Themes/Lightweight_themes">Lightweight themes</a> - <ol> - <li><a href="/en-US/docs/Mozilla/Add-ons/Themes/Lightweight_themes">Lightweight themes</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/Themes/Lightweight_Themes/FAQ">Lightweight themes FAQ</a></li> - </ol> - </li> - <li><a href="/en-US/docs/Mozilla/Add-ons/Distribution"><strong>Publishing and Distribution</strong></a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/Distribution">Publishing add-ons</a> - <ol> - <li><a href="/en-US/docs/Mozilla/Add-ons/Distribution">Signing and distribution overview</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Package_your_extension_">Package your extension</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/Distribution/Submitting_an_add-on">Submit an add-on</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/Source_Code_Submission">Source code submission</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/Distribution/Resources_for_publishers">Resources for publishers</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/Listing">Creating an appealing listing</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/AMO/Policy/Reviews">Review policies</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/AMO/Policy/Agreement">Developer agreement</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/AMO/Policy/Featured">Featured add-ons</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/Distribution/Retiring_your_extension">Retiring your extension</a></li> - </ol> - </li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Alternative_distribution_options">Distributing add-ons</a> - <ol> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Alternative_distribution_options/Sideloading_add-ons">For sideloading</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Alternative_distribution_options/Add-ons_for_desktop_apps">For desktop apps</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Alternative_distribution_options/Add-ons_in_the_enterprise">For an enterprise</a></li> - </ol> - </li> - <li><a href="https://discourse.mozilla.org/c/add-ons"><strong>Community and Support</strong></a></li> - <li><a href="#">Channels</a> - <ol> - <li><a href="https://blog.mozilla.org/addons">Add-ons blog</a></li> - <li><a href="https://discourse.mozilla.org/c/add-ons">Add-on forums</a></li> - <li><a href="http://stackoverflow.com/questions/tagged/firefox-addon">Stack Overflow</a></li> - <li><a href="/en-US/docs/Mozilla/Add-ons/#Contact_us">Contact us</a></li> - </ol> - </li> -</ol> -</section> - -<p> </p> - -<p>This page lists more theoretical in-depth articles about the SDK.</p> - -<hr> -<h3 id="Contributor's_guide"><a name="contributors-guide">Contributor's guide</a></h3> - -<div class="column-container"> -<div class="column-half"> -<dl> - <dt><a href="Guides/Getting_Started">Getting Started</a></dt> - <dd>Learn how to contribute to the SDK: getting the code, opening/taking a bug, filing a patch, getting reviews, and getting help.</dd> - <dt><a href="Guides/Modules">Modules</a></dt> - <dd>Learn about the module system used by the SDK (which is based on the CommonJS specification), how sandboxes and compartments can be used to improve security, and about the built-in SDK module loader, known as Cuddlefish.</dd> - <dt><a href="Guides/Classes_and_Inheritance">Classes and Inheritance</a></dt> - <dd>Learn how classes and inheritance can be implemented in JavaScript, using constructors and prototypes, and about the helper functions provided by the SDK to simplify this.</dd> -</dl> -</div> - -<div class="column-half"> -<dl> - <dt><a href="Guides/Private_Properties">Private Properties</a></dt> - <dd>Learn how private properties can be implemented in JavaScript using prefixes, closures, and WeakMaps, and how the SDK supports private properties by using namespaces (which are a generalization of WeakMaps).</dd> - <dt><a href="Guides/Content_Processes">Content Processes</a></dt> - <dd>The SDK was designed to work in an environment where the code to manipulate web content runs in a different process from the main add-on code. This article highlights the main features of that design.</dd> - <dt><a href="Guides/Testing_the_Add-on_SDK">Testing the Add-on SDK</a></dt> - <dd>Learn how to run the Add-on SDK test suites.</dd> -</dl> -</div> -</div> - -<hr> -<h3 id="SDK_infrastructure"><a name="sdk-infrastructure">SDK infrastructure</a></h3> - -<div class="column-container"> -<div class="column-half"> -<dl> - <dt><a href="Guides/Module_structure_of_the_SDK">Module structure of the SDK</a></dt> - <dd>The SDK, and add-ons built using it, are of composed from reusable JavaScript modules. This explains what these modules are, how to load modules, and how the SDK's module tree is structured.</dd> - <dt><a href="Guides/SDK_API_Lifecycle">SDK API lifecycle</a></dt> - <dd>Definition of the lifecycle for the SDK's APIs, including the stability ratings for APIs.</dd> -</dl> -</div> - -<div class="column-half"> -<dl> - <dt><a href="Guides/Program_ID">Program ID</a></dt> - <dd>The Program ID is a unique identifier for your add-on. This guide explains how it's created, what it's used for and how to define your own.</dd> - <dt><a href="Guides/Firefox_Compatibility">Firefox compatibility</a></dt> - <dd>Working out which Firefox releases a given SDK release is compatible with, and dealing with compatibility problems.</dd> -</dl> -</div> -</div> - -<hr> -<h3 id="SDK_idioms"><a name="sdk-idioms">SDK idioms</a></h3> - -<div class="column-container"> -<div class="column-half"> -<dl> - <dt><a href="Guides/Working_with_Events">Working With Events</a></dt> - <dd>Write event-driven code using the the SDK's event emitting framework.</dd> - <dt><a href="Guides/Content_Scripts">Content scripts guide</a></dt> - <dd>An overview of content scripts, including: what they are, what they can do, how to load them, how to communicate with them.</dd> -</dl> -</div> - -<div class="column-half"> -<dl> - <dt><a href="Guides/Two_Types_of_Scripts">Two Types of Scripts</a></dt> - <dd>This article explains the differences between the APIs available to your main add-on code and those available to content scripts.</dd> -</dl> -</div> -</div> - -<hr> -<h3 id="XUL_migration"><a name="xul-migration">XUL migration</a></h3> - -<div class="column-container"> -<div class="column-half"> -<dl> - <dt><a href="Guides/XUL_Migration_Guide">XUL Migration Guide</a></dt> - <dd>Techniques to help port a XUL add-on to the SDK.</dd> - <dt><a href="Guides/XUL_vs_SDK">XUL versus the SDK</a></dt> - <dd>A comparison of the strengths and weaknesses of the SDK, compared to traditional XUL-based add-ons.</dd> -</dl> -</div> - -<div class="column-half"> -<dl> - <dt><a href="Guides/Porting_the_Library_Detector">Porting Example</a></dt> - <dd>A walkthrough of porting a relatively simple XUL-based add-on to the SDK.</dd> -</dl> -</div> -</div> - -<hr> -<h3 id="Multiprocess_Firefox"><a name="multiprocess-firefox">Multiprocess Firefox</a></h3> - -<div class="column-container"> -<div class="column-half"> -<dl> - <dt><a href="Guides/Multiprocess_Firefox_and_the_SDK">Multiprocess Firefox and the SDK</a></dt> - <dd>How to check whether your add-on is compatible with multiprocess Firefox, and fix it if it isn't.</dd> -</dl> -</div> - -<div class="column-half"> </div> -</div> - -<hr> -<div> -<div class="overheadIndicator communitybox" dir="ltr"> -<div class="column-container"> -<h2 id="Join_the_Add-on_SDK_community">Join the Add-on SDK community</h2> - -<div class="column-half"> -<div class="communitysubhead">Choose your preferred method for joining the discussion:</div> - -<ul class="communitymailinglist"> - <li><a href="https://lists.mozilla.org/listinfo/">Mailing list</a></li> - <li><a href="https://twitter.com/mozillajetpack">Twitter</a></li> - <li><a href="http://stackoverflow.com/questions/tagged/firefox-addon-sdk">Stack Overflow</a></li> - <li><a href="http://groups.google.com/group/mozilla-labs-jetpack">Newsgroup</a></li> - <li><a href="http://groups.google.com/group/mozilla-labs-jetpack/feeds">RSS feed</a></li> -</ul> -</div> - -<div class="column-half"> -<ul class="communitycontact"> - <li><strong>IRC: </strong><a href="irc://irc.mozilla.org/jetpack">#jetpack</a> <span class="smaller">(<a href="https://wiki.mozilla.org/IRC">learn more</a>)</span></li> - <li><strong>Team info: </strong><a href="https://wiki.mozilla.org/Jetpack" title="Designs and plans for the SDK tools">Jetpack Wiki</a></li> -</ul> -</div> -</div> -</div> -</div> diff --git a/files/pt-br/mozilla/add-ons/sdk/guides/working_with_events/index.html b/files/pt-br/mozilla/add-ons/sdk/guides/working_with_events/index.html deleted file mode 100644 index 9c51d1328f..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/guides/working_with_events/index.html +++ /dev/null @@ -1,154 +0,0 @@ ---- -title: Trabalhando com Eventos -slug: Mozilla/Add-ons/SDK/Guides/Working_with_Events -translation_of: Archive/Add-ons/Add-on_SDK/Guides/Working_with_Events ---- -<p>O Add-on SDK suporta programação dirigida a evento.</p> - -<p>Objetos emitem eventos sobre mudança de estados que devem ser interessantes ao código do add-on, tais como abertura de janelas, carregamento de páginas, requisições de rede completas, e cliques de mouse. Pelo registro de uma função de escuta para um emissor de evento um add-on pode receber notificações destes eventos.</p> - -<p><span>Nós falamos sobre scripts de conteúdo em mais detalhes no guia <a href="/en-US/Add-ons/SDK/Guides/Content_Scripts">Working with Content Scripts</a>.</span></p> - -<p>Adicionalmente, se você está usando scripts de conteúdo para interagir com o conteúdo web, você pode definir seus próprios eventos e usá-los para comunicar entre o código principal do add-on e os scripts de conteúdo. <span id="result_box" lang="pt"><span class="hps">Neste caso,</span> <span class="hps">uma extremidade</span> <span class="hps">da conversa</span> <span class="hps">emite</span> <span class="hps">os</span> <span class="hps">eventos</span><span>,</span> <span class="hps">e</span> <span class="hps">a outra extremidade</span> <span class="hps">ouve</span></span>.</p> - -<p>Portanto, há dois modos principais que você interagirá com o framework emissor de eventos:</p> - -<ul> - <li> - <p><strong>escutando eventos embutidos</strong> emitidos pelos objetos no SDK, tais como abertura de tab, carregamento de páginas, cliques de mouse</p> - </li> - <li> - <p><strong>enviando e recebendo eventos definidos pelos usuários</strong> entre scripts de conteúdo e o código do add-on</p> - </li> -</ul> - -<p>Este guia cobre somente o primeiro destes; o segundo é explicado no guia <a href="/en-US/Add-ons/SDK/Guides/Content_Scripts">Working with Content Scripts</a>.</p> - -<h2 id="Adicionando_Escutadores">Adicionando Escutadores</h2> - -<p>Você pode adicionar um escutador para um emissor de evento pela chamada ao seu método<code> on(type, listener)</code>.</p> - -<p>Ele leva dois parâmetros:</p> - -<ul> - <li> - <p><strong><code>type</code></strong>: o tipo de evento que nós estamos interessado, identificado por uma string. Muitos emissores de evento devem emitir mais do que um tipo de evento: por exemplo, a janela do navegador deve emitir ambos os eventos <code>open</code> e <code>close</code>. A lista de tipos de eventos válidos é específica a cada emissor de evento e é incluída em sua documentação.</p> - </li> - <li> - <p><strong><code>listener</code></strong>: o escutador em si. Esta é uma função que será chamada sempre que o evento ocorrer. O argumento que será passado para o escutador é específico a um tipo de evento e é documentado com o emissor de evento.</p> - </li> -</ul> - -<p>Por exemplo, o seguinte add-on registra uma escuta com o módulo <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs"><code>tabs</code></a> para esperar pelo evento <code>ready</code>, e registra uma string no console reportando o evento:</p> - -<pre class="brush: js">var tabs = require("sdk/tabs"); - -tabs.on("ready", function () { - console.log("tab loaded"); -}); -</pre> - -<p>Não é possível enumerar o conjunto de escutas para um dado evento.</p> - -<p>O valor de <code>this</code> na função de escuta é o objeto que emitiu o evento.</p> - -<h3 id="Escutando_Todos_os_Eventos">Escutando Todos os Eventos</h3> - -<p>Você pode passar o curinga "*" como o argumento <code>type</code>. Se você fizer isso, a escuta será chamada para qualquer evento emitido por qualquer objeto, e seu argumento será o nome do evento:</p> - -<pre class="brush: js">var ui = require("sdk/ui"); -var panels = require("sdk/panel"); -var self = require("sdk/self"); - -var panel = panels.Panel({ - contentURL: self.data.url("panel.html") -}); - -panel.on("*", function(e) { - console.log("event " + e + " was emitted"); -}); - -var button = ui.ActionButton({ - id: "my-button", - label: "my button", - icon: "./icon-16.png", - onClick: handleClick -}); - -function handleClick(state) { - panel.show({ - position: button - }); -}</pre> - -<p>Esta característica do curinga não funciona ainda nos módulos<a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs"><code> tabs</code></a> ou <a href="/en-US/Add-ons/SDK/High-Level_APIs/windows"><code>window</code></a>.</p> - -<h3 id="Adicionando_escutas_em_construtores">Adicionando escutas em construtores</h3> - -<p>Emissores de evento podem ser módulos como no caso do evento <code>ready</code> acima, ou eles podem ser objetos retornados pelos construtores.</p> - -<p>No último caso o objeto <code>options</code> passado para o construtor tipicamente define propriedades cujos nomes são nomes de tipos de eventos suportados prefixados com "on": por exemplo, "onOpen", "onReady" e assim por diante. Então o construtor pode atribuir uma função de escuta para aquela propriedade como uma alternativa a chamada do método do objeto <code>on()</code>.</p> - -<p>Por exemplo: o objeto <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_action"><code>ActionButton</code></a> emite um evento quando o botão é clicado.</p> - -<p>O add-on a seguir cria um botão e atribui uma escuta para a propriedade <code>onClick</code> do objeto fornecida no <code>options</code> do construtor do objeto botão. A escuta carrega https://developer.mozilla.org/:</p> - -<pre class="brush: js">require("sdk/ui/button/action").ActionButton({ - id: "visit-mozilla", - label: "Visit Mozilla", - icon: "./icon-16.png", - onClick: function() { - require("sdk/tabs").open("https://developer.mozilla.org/"); - } -}); -</pre> - -<p>Isto é exatamente equivalente a construir o botão e então chamar o método <code>on()</code> do botão</p> - -<pre class="brush: js">var button = require("sdk/ui/button/action").ActionButton({ - id: "visit-mozilla", - label: "Visit Mozilla", - icon: "./icon-16.png" -}); - -button.on("click", function() { - require("sdk/tabs").open("https://developer.mozilla.org/"); -}); -</pre> - -<h2 id="Removendo_Escutas_de_Evento">Removendo Escutas de Evento</h2> - -<p>Escutas de evento pode ser removidos pela chamada de <code>removeListener(type, listener)</code>, fornecendo o tipo do evento e escuta a remover.</p> - -<p>A escuta deve ter sido previamente adicionada usando um dos métodos descritos acima.</p> - -<p>No add-on a seguir, nós adicionamos duas escutas para o <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/tabs#ready">evento <code>ready</code> do módulo<code> tab</code></a>. Uma das funções de manipulação remove a escuta.</p> - -<p>Então nós abrimos duas abas.</p> - -<pre class="brush: js">var tabs = require("sdk/tabs"); - -function listener1() { - console.log("Listener 1"); - tabs.removeListener("ready", listener1); -} - -function listener2() { - console.log("Listener 2"); -} - -tabs.on("ready", listener1); -tabs.on("ready", listener2); - -tabs.open("https://www.mozilla.org"); -tabs.open("https://www.mozilla.org"); -</pre> - -<p>Nós devemos ver a saída como esta:</p> - -<pre>info: tabevents: Listener 1 -info: tabevents: Listener 2 -info: tabevents: Listener 2 -</pre> - -<p>As escutas serão removidas automaticamente quando o add-on for descarregado.</p> diff --git a/files/pt-br/mozilla/add-ons/sdk/high-level_apis/index.html b/files/pt-br/mozilla/add-ons/sdk/high-level_apis/index.html deleted file mode 100644 index 2537723562..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/high-level_apis/index.html +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: High-Level APIs -slug: Mozilla/Add-ons/SDK/High-Level_APIs -tags: - - Add-on SDK - - NeedsTranslation - - TopicStub -translation_of: Archive/Add-ons/Add-on_SDK/High-Level_APIs ---- -<p>Modules listed on this page implement high-level APIs for building add-ons: creating user interfaces, interacting with the web, and interacting with the browser.</p> -<p>Unless the documentation explicitly says otherwise, all these modules are "Stable": we'll avoid making incompatible changes to them. {{ LandingPageListSubpages ("/en-US/Add-ons/SDK/High-Level_APIs", 5) }}</p> diff --git a/files/pt-br/mozilla/add-ons/sdk/high-level_apis/request/index.html b/files/pt-br/mozilla/add-ons/sdk/high-level_apis/request/index.html deleted file mode 100644 index 01937e2036..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/high-level_apis/request/index.html +++ /dev/null @@ -1,214 +0,0 @@ ---- -title: request -slug: Mozilla/Add-ons/SDK/High-Level_APIs/request -translation_of: Archive/Add-ons/Add-on_SDK/High-Level_APIs/request ---- -<div class="note"> -<p>Stable</p> -</div> - -<p><span class="seoSummary">Faça requesições simples de rede. Para uso mais avançado, cheque os módulos</span> <a href="/en-US/Add-ons/SDK/Low-Level_APIs/net_xhr">net/xhr</a>, baseado no objeto <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest">XMLHttpRequest</a> do navegador.</p> - -<h2 id="Globals">Globals</h2> - -<h3 id="Constructors">Constructors</h3> - -<h4 class="addon-sdk-api-name" id="Request(options)"><code>Request(options)</code></h4> - -<p>Este construtor cria um objeto request que pode ser usado para fazer requisições de rede. O construtor leva um único parâmetro <code>options</code> que é usado para configurar várias propriedades no resultado do <code>Request</code>.</p> - -<h5 id="Parâmetros">Parâmetros</h5> - -<p><strong>options : object</strong><br> - Opções opcionais:</p> - -<table class="standard-table"> - <thead> - <tr> - <th scope="col">Name</th> - <th scope="col">Type</th> - <th scope="col"> </th> - </tr> - </thead> - <tbody> - <tr> - <td>url</td> - <td>string,url</td> - <td> - <p>This is the url to which the request will be made. Can either be a <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String">String</a> or an instance of the SDK's <a href="/en-US/Add-ons/SDK/High-Level_APIs/url">URL</a>.</p> - </td> - </tr> - <tr> - <td>onComplete</td> - <td>function</td> - <td> - <p>This function will be called when the request has received a response (or in terms of XHR, when <code>readyState == 4</code>). The function is passed a <code>Response</code> object.</p> - </td> - </tr> - <tr> - <td>headers</td> - <td>object</td> - <td> - <p>An unordered collection of name/value pairs representing headers to send with the request.</p> - </td> - </tr> - <tr> - <td>content</td> - <td>string,object</td> - <td> - <p>The content to send to the server. If <code>content</code> is a string, it should be URL-encoded (use <code>encodeURIComponent</code>). If <code>content</code> is an object, it should be a collection of name/value pairs. Nested objects & arrays should encode safely.</p> - - <p>For <code>GET</code> <span style="line-height: 1.5;">and </span><code style="font-style: normal; line-height: 1.5;">HEAD</code><span style="line-height: 1.5;"> requests, the query string (</span><code style="font-style: normal; line-height: 1.5;">content</code><span style="line-height: 1.5;">) will be appended to the URL. For </span><code style="font-style: normal; line-height: 1.5;">POST</code><span style="line-height: 1.5;"> and </span><code style="font-style: normal; line-height: 1.5;">PUT</code><span style="line-height: 1.5;"> requests, it will be sent as the body of the request.</span></p> - </td> - </tr> - <tr> - <td>contentType</td> - <td>string</td> - <td> - <p>The type of content to send to the server. This explicitly sets the <code>Content-Type</code> header. The default value is <code>application/x-www-form-urlencoded</code>.</p> - </td> - </tr> - <tr> - <td>overrideMimeType</td> - <td>string</td> - <td> - <p>Use this string to override the MIME type returned by the server in the response's Content-Type header. You can use this to treat the content as a different MIME type, or to force text to be interpreted using a specific character.</p> - - <p>For example, if you're retrieving text content which was encoded as ISO-8859-1 (Latin 1), it will be given a content type of "utf-8" and certain characters will not display correctly. To force the response to be interpreted as Latin-1, use <code>overrideMimeType</code>:</p> - - <pre class="brush: js"> -var Request = require("sdk/request").Request; -var quijote = Request({ - url: "http://www.latin1files.org/quijote.txt", - overrideMimeType: "text/plain; charset=latin1", - onComplete: function (response) { - console.log(response.text); - } -}); - -quijote.get();</pre> - </td> - </tr> - <tr> - <td>anonymous</td> - <td>boolean</td> - <td>If <code>true</code>, the request will be sent without cookies or authentication headers. This option sets the <a href="/en/docs/Web/API/XMLHttpRequest#Non-standard_properties"><code>mozAnon</code></a> property in the underlying XMLHttpRequest object. Defaults to <code>false</code>.</td> - </tr> - </tbody> -</table> - -<h2 id="Request">Request</h2> - -<p>The <code>Request</code> object is used to make <code>GET</code>, <code style="font-style: normal; line-height: 1.5;"><code style="font-style: normal;">HEAD</code></code>, <code style="font-style: normal; line-height: 1.5;"><code style="font-style: normal;">POST</code></code><span style="line-height: 1.5;">, </span><code style="font-style: normal; line-height: 1.5;">PUT</code><span style="line-height: 1.5;">,</span><span style="line-height: 1.5;"> </span><span style="line-height: 1.5;">or </span><code style="font-style: normal; line-height: 1.5;">DELETE</code><span style="line-height: 1.5;"> network requests. It is constructed with a URL to which the request is sent. Optionally the user may specify a collection of headers and content to send alongside the request and a callback which will be executed once the request completes.</span></p> - -<p>Once a <code>Request</code> object has been created a <code>GET</code> request can be executed by calling its <code>get()</code> method, a <code>POST</code> request by calling its <code>post()</code> method, and so on.</p> - -<p>When the server completes the request, the <code>Request</code> object emits a "complete" event. Registered event listeners are passed a <code>Response</code> object.</p> - -<p>Each <code>Request</code> object is designed to be used once. Attempts to reuse them will throw an error.</p> - -<p>Since the request is not being made by any particular website, requests made here are not subject to the same-domain restriction that requests made in web pages are subject to.</p> - -<p>With the exception of <code>response</code>, all of a <code>Request</code> object's properties correspond with the options in the constructor. Each can be set by simply performing an assignment. However, keep in mind that the same validation rules that apply to <code>options</code> in the constructor will apply during assignment. Thus, each can throw if given an invalid value.</p> - -<p>The example below shows how to use Request to get the most recent tweet from the <a href="https://twitter.com/mozhacks">@mozhacks</a> account:</p> - -<pre class="brush: js">var Request = require("sdk/request").Request; -var latestTweetRequest = Request({ - url: "https://api.twitter.com/1/statuses/user_timeline.json?screen_name=mozhacks&count=1", - onComplete: function (response) { - var tweet = response.json[0]; - console.log("User: " + tweet.user.screen_name); - console.log("Tweet: " + tweet.text); - } -}); - -// Be a good consumer and check for rate limiting before doing more. -Request({ - url: "http://api.twitter.com/1/account/rate_limit_status.json", - onComplete: function (response) { - if (response.json.remaining_hits) { - latestTweetRequest.get(); - } else { - console.log("You have been rate limited!"); - } - } -}).get();</pre> - -<h3 id="Methods">Methods</h3> - -<h4 class="addon-sdk-api-name" id="get()"><code>get()</code></h4> - -<p>Make a <code>GET</code> request.</p> - -<h4 class="addon-sdk-api-name" id="head()" style="line-height: 18px; font-size: 1.28571428571429rem;"><code>head()</code></h4> - -<p>Make a <code>HEAD</code> request.</p> - -<h4 class="addon-sdk-api-name" id="post()"><code>post()</code></h4> - -<p>Make a <code>POST</code> request.</p> - -<h4 class="addon-sdk-api-name" id="put()"><code>put()</code></h4> - -<p>Make a <code>PUT</code> request.</p> - -<h4 class="addon-sdk-api-name" id="delete()"><span style="font-family: courier new,andale mono,monospace; font-size: 1.28571428571429rem; font-style: inherit; font-weight: inherit;">delete()</span></h4> - -<p>Make a <code>DELETE</code> request.</p> - -<h3 id="Properties">Properties</h3> - -<h4 class="addon-sdk-api-name" id="url"><code>url</code></h4> - -<h4 class="addon-sdk-api-name" id="headers"><code>headers</code></h4> - -<h4 class="addon-sdk-api-name" id="content"><code>content</code></h4> - -<h4 class="addon-sdk-api-name" id="contentType"><code>contentType</code></h4> - -<h4 class="addon-sdk-api-name" id="response"><code>response</code></h4> - -<h3 id="Events">Events</h3> - -<h4 class="addon-sdk-api-name" id="complete"><code>complete</code></h4> - -<p>The <code>Request</code> object emits this event when the request has completed and a response has been received.</p> - -<h5 id="Arguments">Arguments</h5> - -<p><strong>Response</strong> : Listener functions are passed the response to the request as a <code>Response</code> object.</p> - -<h2 id="Response">Response</h2> - -<p>The Response object contains the response to a network request issued using a <code>Request</code> object. It is returned by the <code>get()</code>, <code style="font-style: normal; line-height: 1.5;">head()</code><span style="line-height: 1.5;">, </span><code style="font-style: normal; line-height: 1.5;">post()</code><span style="line-height: 1.5;">, </span><code style="font-style: normal; line-height: 1.5;">put()</code><span style="line-height: 1.5;"> </span><span style="line-height: 1.5;">or </span><code style="font-style: normal; line-height: 1.5;">delete()</code><span style="line-height: 1.5;"> method of a </span><code style="font-style: normal; line-height: 1.5;">Request</code><span style="line-height: 1.5;"> object.</span></p> - -<p>All members of a <code>Response</code> object are read-only.</p> - -<h3 id="Properties_2">Properties</h3> - -<h4 class="addon-sdk-api-name" id="text"><code>text</code></h4> - -<p>The content of the response as plain text.</p> - -<h4 class="addon-sdk-api-name" id="json"><code>json</code></h4> - -<p>The content of the response as a JavaScript object. The value will be <code>null</code> if the document cannot be processed by <code>JSON.parse</code>.</p> - -<h4 class="addon-sdk-api-name" id="status"><code>status</code></h4> - -<p>The HTTP response status code (e.g. <em>200</em>).</p> - -<h4 class="addon-sdk-api-name" id="statusText"><code>statusText</code></h4> - -<p>The HTTP response status line (e.g. <em>OK</em>).</p> - -<h4 class="addon-sdk-api-name" id="headers_2"><code>headers</code></h4> - -<p>The HTTP response headers represented as key/value pairs.</p> - -<p>To print all the headers you can do something like this:</p> - -<pre class="brush: js">for (var headerName in response.headers) { - console.log(headerName + " : " + response.headers[headerName]); -}</pre> diff --git a/files/pt-br/mozilla/add-ons/sdk/high-level_apis/tabs/index.html b/files/pt-br/mozilla/add-ons/sdk/high-level_apis/tabs/index.html deleted file mode 100644 index 22493dce1d..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/high-level_apis/tabs/index.html +++ /dev/null @@ -1,671 +0,0 @@ ---- -title: tabs -slug: Mozilla/Add-ons/SDK/High-Level_APIs/tabs -tags: - - Guías - - Tab -translation_of: Archive/Add-ons/Add-on_SDK/High-Level_APIs/tabs ---- -<div class="note"> -<p>Stable</p> -</div> - -<p><span class="seoSummary">Abre, manipula, e acessa tabs, e recebe eventos de tabs</span></p> - -<h2 id="Uso">Uso</h2> - -<h3 id="Abrir_uma_tab">Abrir uma tab</h3> - -<p>Você pode abrir uma nova tab, especificando várias propriedades incluindo localização:</p> - -<pre class="brush: js">var tabs = require("sdk/tabs"); -tabs.open("http://www.Exemplo.com");</pre> - -<h3 id="Rastrear_tabs">Rastrear tabs</h3> - -<p>Você pode registrar eventos de escuta para ser notificado quando a tabs abre, fecha, termina o carregamento de conteúdo DOM, ou tornam-se ativa ou inativa:</p> - -<pre class="brush: js">var tabs = require("sdk/tabs"); - -// Listen for tab openings. -tabs.on('open', function onOpen(tab) { - myOpenTabs.push(tab); -}); - -// Listen for tab content loads. -tabs.on('ready', function(tab) { - console.log('tab is loaded', tab.title, tab.url); -});</pre> - -<h3 id="Accessar_tabs">Accessar tabs</h3> - -<p>O módulo por ele mesmo pode ser usado como uma lista de todas as tabs abertas em todos os navegadores. Em particular, você pode enumerá-las:</p> - -<pre class="brush: js">var tabs = require('sdk/tabs'); -for (let tab of tabs) - console.log(tab.title);</pre> - -<p>Você também pode acessar tabs individual pelo índice:</p> - -<pre class="brush: js">var tabs = require('sdk/tabs'); - -tabs.on('ready', function () { - console.log('first: ' + tabs[0].title); - console.log('last: ' + tabs[tabs.length-1].title); -});</pre> - -<p>Você pode acessar a tab ativa atualmente:</p> - -<pre class="brush: js">var tabs = require('sdk/tabs'); - -tabs.on('activate', function () { - console.log('active: ' + tabs.activeTab.url); -});</pre> - -<h3 id="Rastrear_uma_única_tab">Rastrear uma única tab</h3> - -<p>Dada uma tab, você pode registrar escutas para eventos serem notificados quando a tab é fechada, ativada ou desativada, ou quando a página hospedad pela tab é carregada ou recuperada do <a href="https://developer.mozilla.org/en-US/docs/Working_with_BFCache">"back-forward cache"</a>:</p> - -<pre class="brush: js">var tabs = require("sdk/tabs"); - -function onOpen(tab) { - console.log(tab.url + " is open"); - tab.on("pageshow", logShow); - tab.on("activate", logActivate); - tab.on("deactivate", logDeactivate); - tab.on("close", logClose); -} - -function logShow(tab) { - console.log(tab.url + " is loaded"); -} - -function logActivate(tab) { - console.log(tab.url + " is activated"); -} - -function logDeactivate(tab) { - console.log(tab.url + " is deactivated"); -} - -function logClose(tab) { - console.log(tab.url + " is closed"); -} - -tabs.on('open', onOpen);</pre> - -<h3 id="Manipular_uma_tab">Manipular uma tab</h3> - -<p>Você pode conseguir e configurar várias propriedades de tabs (mas note que propriedades relacionadas ao conteúdo da tab, tal como URL, não conterão valores válidos até depois do evento <code>ready</code> disparar). Pela configuração da propriedade <code>url</code> você pode carregar uma nova página na tab:</p> - -<pre class="brush: js">var tabs = require("sdk/tabs"); -tabs.on('activate', function(tab) { - tab.url = "http://www.Exemplo.com"; -});</pre> - -<h3 id="Execute_scripts_em_um_tab">Execute scripts em um tab</h3> - -<p>Você pode anexar um script de <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/Content_Scripts">conteúdo a página</a> hospedad na tab, e usar aquele para acessar e manipular o conteúdo da página (veja o tutorial <a href="/en-US/Add-ons/SDK/Tutorials/Modifying_the_Page_Hosted_by_a_Tab">Modifying the Page Hosted by a Tab</a>):</p> - -<pre class="brush: js">var tabs = require("sdk/tabs"); - -tabs.on('activate', function(tab) { - var worker = tab.attach({ - contentScript: 'self.port.emit("html", document.body.innerHTML);' - }); - worker.port.on("html", function(message) { - console.log(message) - }) -});</pre> - -<p>Observe que <code>tab.attach</code> é centrado na tab: se o usuário navegar para uma nova página na mesma tab, então o trabalho e scripts de conteúdo serão reanexados á nova página.</p> - -<h3 id="Anexação_de_stylesheets">Anexação de stylesheets</h3> - -<div class="geckoVersionNote"> -<p>Novo no Firefox 34.</p> -</div> - -<p>Você não pode anexar folhas de estilo para uma tab usando <code>tab.attach()</code>, mas do Firefox 34 em diante você pode anexar e desanexa-los usando APIs de baixo nível <a href="/en-US/Add-ons/SDK/Low-Level_APIs/stylesheet_style">stylesheet/style</a> e <a href="/en-US/Add-ons/SDK/Low-Level_APIs/content_mod">content/mod</a>. Aqui está um add-on que usa botões alternados para anexar uma folha de estilo a tab ativa, e desanexar novamente. A folha de estilo é chamada "style.css" e está localizada no diretório "data":</p> - -<pre class="brush: js">var tabs = require("sdk/tabs"); -var { attach, detach } = require('sdk/content/mod'); -var { Style } = require('sdk/stylesheet/style'); -var { ToggleButton } = require("sdk/ui/button/toggle"); - -var style = Style({ - uri: './style.css' -}); - -var button = ToggleButton({ - id: "stylist", - label: "stylist", - icon: "./icon-16.png", - onChange: function(state) { - if (state.checked) { - attach(style, tabs.activeTab); - } - else { - detach(style, tabs.activeTab); - } - } -});</pre> - -<h3 id="Janelas_Privadas">Janelas Privadas</h3> - -<p>Se o seu add-on não optou por entrar em navegação privada, então você não verá quaisquer tabs pela janela de navegação privada.</p> - -<p>Tabs hospedadas por janelas em navegação privada não serão vista se você enumerar o módulo <code>tab</code> por si mesmo, e você não receberá quaisquer eventos deles.</p> - -<p>Para aprender mais sobre janelas privadas, como optar por entrar em navegação privada, e como suportar navegação privada, dirija-se à <a href="/en-US/Add-ons/SDK/High-Level_APIs/private-browsing">documentação do módulo para <code>private-browsing</code></a>.</p> - -<h3 id="Converção_para_XUL_tabs">Converção para XUL tabs</h3> - -<p>Para converter de um objeto <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs#Tab"><code>Tab</code></a> de alto nível usando esta API para um objeto <a href="/en-US/docs/Mozilla/Tech/XUL/tab">XUL <code>tab</code></a> de baixo nível usado na API <a href="/en-US/Add-ons/SDK/Low-Level_APIs/tabs_utils"><code>tabs/utils</code></a> e por add-ons tradicionais, use a função <code>viewFor()</code> exportada pelo móduloa <code>viewFor</code>.</p> - -<p>Para converter de volta, de uma <code>tab</code> XUL para um objeto <code>Tab</code> de alto nível, use a função <code>modelFor(),</code> exportada pelo módulo <code>modelFor</code>.</p> - -<p>Aqui está um exemplo covertendo de uma <code>Tab </code>de alto nível para uma <code>tab XUL</code> e então converte de volta:</p> - -<pre class="brush: js">var { modelFor } = require("sdk/model/core"); -var { viewFor } = require("sdk/view/core"); - -var tabs = require("sdk/tabs"); -var tab_utils = require("sdk/tabs/utils"); - -function mapHighLevelToLowLevel(tab) { - // get the XUL tab that corresponds to this high-level tab - var lowLevelTab = viewFor(tab); - // now we can, for Exemplo, access the tab's content directly - var browser = tab_utils.getBrowserForTab(lowLevelTab); - console.log(browser.contentDocument.body.innerHTML); - // get the high-level tab back from the XUL tab - var highLevelTab = modelFor(lowLevelTab); - console.log(highLevelTab.url); -} - -tabs.on("ready", mapHighLevelToLowLevel); -</pre> - -<p>Observe que acessar objetos XUL diretamente e conteúdo web como este significa que você não está protegido pelas garantias de compatibilidades feitas pelas APIs de alto nível do SDK. Em particular, seu código não deve trabalhar com <a href="http://billmccloskey.wordpress.com/2013/12/05/multiprocess-firefox/">multiprocess Firefox</a>.</p> - -<h2 id="Globais">Globais</h2> - -<h3 id="Funções">Funções</h3> - -<h4 class="addon-sdk-api-name" id="open(opções)"><code>open(opções)</code></h4> - -<p>Abre uma nova tab. A nova tab abrirá na janela ativa ou na nova janela, dependendo da opção <code>inNewWindow</code>.</p> - -<p><strong>Examplo</strong></p> - -<pre class="brush: js">var tabs = require("sdk/tabs"); - -// Open a new tab on active window and make tab active. -tabs.open("http://www.mysite.com"); - -// Open a new tab in a new window and make it active. -tabs.open({ - url: "http://www.mysite.com", - inNewWindow: true -}); - -// Open a new tab on active window in the background. -tabs.open({ - url: "http://www.mysite.com", - inBackground: true -}); - -// Open a new tab as an app tab and do something once it's open. -tabs.open({ - url: "http://www.mysite.com", - isPinned: true, - onOpen: function onOpen(tab) { - // do stuff like listen for content - // loading. - } -});</pre> - -<h5 id="Parâmetros">Parâmetros</h5> - -<p><strong>opção: object</strong><br> - Opções necessárias:</p> - -<table class="standard-table"> - <thead> - <tr> - <th scope="col">Name</th> - <th scope="col">Type</th> - <th scope="col"> </th> - </tr> - </thead> - <tbody> - <tr> - <td>url</td> - <td>string</td> - <td> - <p>URL a ser aberta na nova tab. Esta é uma propriedade necessária.</p> - </td> - </tr> - </tbody> -</table> - -<p>Opções opcionais:</p> - -<table class="standard-table"> - <thead> - <tr> - <th scope="col">Name</th> - <th scope="col">Type</th> - <th scope="col"> </th> - </tr> - </thead> - <tbody> - <tr> - <td>isPrivate</td> - <td>boolean</td> - <td> - <p>Boolean que determinará se a nova tab deve ser privada ou não. Se seu add-on não suporta navegação privada isto não terá efeito. Veja a documentação de <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/private-browsing">navegação privada</a> para mais informação. O padrão é <code>false</code>.</p> - </td> - </tr> - <tr> - <td>inNewWindow</td> - <td>boolean</td> - <td> - <p>Se presente e true, uma nova janela de navegação será aberta e na primeira tab naquela janela. Esta é uma propriedade opcional.</p> - </td> - </tr> - <tr> - <td>inBackground</td> - <td>boolean</td> - <td> - <p>Se presente e true, a nova tab será aberta à direita da tab ativa e não estará ativa. Esta é uma propriedade opcional.</p> - </td> - </tr> - <tr> - <td>isPinned</td> - <td>boolean</td> - <td> - <p>Se presente e true, a nova tab será anexada como um <a href="http://support.mozilla.com/en-US/kb/what-are-app-tabs">app tab</a>.</p> - </td> - </tr> - <tr> - <td>onOpen</td> - <td>function</td> - <td> - <p>Uma função que será registrada para o evento 'open'. Esta é uma propriedade opcional.</p> - </td> - </tr> - <tr> - <td>onClose</td> - <td>function</td> - <td> - <p>Uma função de callback que será registrada para o evento 'close'. Esta é uma propriedade opcional.</p> - </td> - </tr> - <tr> - <td>onReady</td> - <td>function</td> - <td> - <p>Uma função de callback que será registrada para o evento 'ready'. Esta é uma propriedade opcional.</p> - </td> - </tr> - <tr> - <td>onLoad</td> - <td>function</td> - <td> - <p>Uma função de callback que será registrada para o evento 'load'. Esta é uma propriedade opcional.</p> - </td> - </tr> - <tr> - <td>onPageShow</td> - <td>function</td> - <td> - <p>Uma função de callback que será registrada para o evento 'pageshow'. Esta é uma propriedade opcional.</p> - </td> - </tr> - <tr> - <td>onActivate</td> - <td>function</td> - <td> - <p>Uma função de callback que será registrada para o evento 'activate'. Esta é uma propriedade opcional.</p> - </td> - </tr> - <tr> - <td>onDeactivate</td> - <td>function</td> - <td> - <p>Uma função de callback que será registrada para o evento 'deactivate'. Esta é uma propriedade opcional.</p> - </td> - </tr> - </tbody> -</table> - -<h3 id="Propriedades">Propriedades</h3> - -<h4 class="addon-sdk-api-name" id="activeTab"><code>activeTab</code></h4> - -<p>A tab ativa na janela ativa. Esta propriedade é somente leitura. Para ativar um objeto<code> Tab</code>, chame seu método <code>activate</code>.</p> - -<p><strong>Exemplo</strong></p> - -<pre class="brush: js">// Get the active tab's title. -var tabs = require("sdk/tabs"); -console.log("title of active tab is " + tabs.activeTab.title);</pre> - -<h4 class="addon-sdk-api-name" id="length"><code>length</code></h4> - -<p>O número de tabs abertas em todas as janelas.</p> - -<h3 id="Eventos">Eventos</h3> - -<h4 class="addon-sdk-api-name" id="open"><code>open</code></h4> - -<p>Este evento é emitido quando uma nova tab é aberta. Isto não significa que o conteúdo carregou, somente que o navegador está inteiramente visível para o usuário.</p> - -<p>Propriedades relacionadas à conteúdo da tab (por exemplo: <code>title</code>, <code>favicon</code>, e <code>url</code>) não serão corrigidas neste ponto. Se você precisar acessar estas propriedades, escute o evento <code>ready</code>:</p> - -<pre class="brush: js">var tabs = require("sdk/tabs"); -tabs.on('open', function(tab){ - tab.on('ready', function(tab){ - console.log(tab.url); - }); -});</pre> - -<h5 id="Argumentos">Argumentos</h5> - -<p><strong>Tab</strong> : Escutas são passadas ao objeto tab que acaba de abrir.</p> - -<h4 class="addon-sdk-api-name" id="close"><code>close</code></h4> - -<p>Este evento é emitido quando a tab é fechada. Quando a janela é fechada este evento será emitido para cada uma das tabs abertas naquela janela.</p> - -<h5 id="Argumentos_2">Argumentos</h5> - -<p><strong>Tab</strong> : Escutas são passadas ao objeto tab que fechou.</p> - -<h4 class="addon-sdk-api-name" id="ready"><code>ready</code></h4> - -<p>Este evento é emitido quando o DOM para o conteúdo da página estiver preparado. É equivalmente ao evento <code>DOMContentLoaded</code> para conteúdo da página dada.</p> - -<p>Um única tab emitirá este evento toda vez todas às vezes que o DOM for carregado: então será emitido novamente se o endereço da página mudar ou o conteúdo for recarregado.</p> - -<p>Depois que este evento for emitido, todas as propriedades relacionadas ao conteúdo da página poderão ser usadas.</p> - -<h5 id="Argumentos_3">Argumentos</h5> - -<p><strong>Tab</strong> : Escutas são passadas ao objeto tab que carregou.</p> - -<h4 class="addon-sdk-api-name" id="activate"><code>activate</code></h4> - -<p>Este evento é emitido quando uma tab inativa torna-se ativa.</p> - -<h5 id="Argumentos_4">Argumentos</h5> - -<p><strong>Tab</strong> : Escutas são passadas para o objeto tab que torna-se ativa.</p> - -<h4 class="addon-sdk-api-name" id="deactivate"><code>deactivate</code></h4> - -<p>Este evento é emitido quando a tab ativa torna-se inativa.</p> - -<h5 id="Argumentos_5">Argumentos</h5> - -<p><strong>Tab</strong> : Escutas são passadas para o objeto tab que tornou-se inativo.</p> - -<h2 id="Tab">Tab</h2> - -<p>Uma instância Tab representa um única tab aberta. Ele contém várias propriedades, vários métodos para manipulação, assim como registração de evento por tab.</p> - -<p>Tabs emitem todos os eventos descritos na seção de Eventos. Escutas são passadas ao objeto <code>Tab</code> que lança eventos.</p> - -<h3 id="Métodos">Métodos</h3> - -<h4 class="addon-sdk-api-name" id="pin()"><code>pin()</code></h4> - -<p>Anexa a tab como uma <a href="http://support.mozilla.com/en-US/kb/what-are-app-tabs">app tab</a>.</p> - -<h4 class="addon-sdk-api-name" id="unpin()"><code>unpin()</code></h4> - -<p>Desanexa esta tab.</p> - -<h4 class="addon-sdk-api-name" id="close(callback)"><code>close(callback)</code></h4> - -<p>Fecha esta tab.</p> - -<h5 id="Parâmetros_2">Parâmetros</h5> - -<p><strong>callback : function</strong><br> - Uma função será chamada quanto a tab termine seu processo de fechamento. Este é uma argumento opcional.</p> - -<h4 class="addon-sdk-api-name" id="reload()"><code>reload()</code></h4> - -<p>Recarrega esta tab.</p> - -<h4 class="addon-sdk-api-name" id="activate()"><code>activate()</code></h4> - -<p>Torna esta tab ativa, que trará esta tab para o primeiro plano.</p> - -<h4 class="addon-sdk-api-name" id="getThumbnail()"><code>getThumbnail()</code></h4> - -<p>Retorna o dado thumbnail da URI da página atualmente carregada nesta tab.</p> - -<h4 class="addon-sdk-api-name" id="attach(options)"><code>attach(options)</code></h4> - -<p>Anexa um ou mais scripts ao documento carregado na tab. Observe que este é centrado na tab: se o usuário navega para uma nova página na mesma tab, então o script de conteúdo será reanexado à nova página.</p> - -<p><strong>Exemplo</strong></p> - -<pre class="brush: js">var tabs = require("sdk/tabs"); - -tabs.on('ready', function(tab) { - var worker = tab.attach({ - contentScript: - 'document.body.style.border = "5px solid red";' - }); -});</pre> - -<h5 id="Parâmetros_3">Parâmetros</h5> - -<p><strong>options : objeto</strong><br> - Opções opcionais:</p> - -<table class="standard-table"> - <thead> - <tr> - <th scope="col">Name</th> - <th scope="col">Type</th> - <th scope="col"> </th> - </tr> - </thead> - <tbody> - <tr> - <td>contentScriptFile</td> - <td>string,array</td> - <td> - <p>As URLs dos arquivos locais dos scripts de conteúdo carregados. Scripts de conteúdo especificados por esta opção são carregados <em>antes </em>daqueles especificados pela opção <code>contentScript</code>. Opcional.</p> - </td> - </tr> - <tr> - <td>contentScript</td> - <td>string,array</td> - <td> - <p>Uma string ou uma array de strings do código para ser avaliado no contexto. Scripts de conteúdo especificados por esta opção são carregados <em>depois</em> daqueles especificados pela opção <code>contentScriptFile</code>. Opcional.</p> - </td> - </tr> - <tr> - <td>contentScriptOptions</td> - <td>object</td> - <td> - <p>Você pode usar esta opção para definir valores somente leitura para seus scripts de conteúdo.</p> - - <p>A opção consiste de uma listagem de objetos literais no formato pares <code>name:value</code> para os valores que você quer fornecer para o script de conteúdo. Por exemplo:</p> - - <pre class="brush: js"> -// main.js - -const tabs = require("sdk/tabs"); - -tabs.open({ - url: "./page.html", - onReady: function(tab) { - tab.attach({ - contentScriptFile: "./content-script.js", - contentScriptOptions: { - a: "blah" - } - }); - } -});</pre> - - <p>Os valores são acessíveis ao script de conteúdo via propriedade <code>self.options</code>:</p> - - <pre class="brush: js"> -// content-script.js - -alert(self.options.a);</pre> - </td> - </tr> - <tr> - <td>onMessage</td> - <td>function</td> - <td> - <p>Uma função chamada quando o conteúdo de trabalho recebe uma mensagem dos scripts de conteúdo. Escutas são passadas como um único argumento, a mensagem postada do script de conteúdo.</p> - </td> - </tr> - <tr> - <td>onError</td> - <td>function</td> - <td> - <p>Uma função chamada quando o trabalhador de conteúdo recebe um erro dos scripts de conteúdo. Escutas são passar como um único argumento, <code>error</code>, que é erro postado do script de conteúdo e um objeto do tipo <a href="/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>. Opcional.</p> - </td> - </tr> - </tbody> -</table> - -<h5 id="Retorno">Retorno</h5> - -<p><strong>Worker</strong> : O objeto <a href="/en-US/Add-ons/SDK/Low-Level_APIs/content_worker">Worker</a> pode ser usado para comunicar com o script de conteúdo. Veja o <a href="/en-US/Add-ons/SDK/Guides/Content_Scripts">guia de scripts de conteúdo</a> para aprender os detalhes.</p> - -<h3 id="Propriedades_2">Propriedades</h3> - -<h4 class="addon-sdk-api-name" id="id"><code>id</code></h4> - -<p>O único id para a tab. Esta propriedade é somente leitura.</p> - -<h4 class="addon-sdk-api-name" id="title"><code>title</code></h4> - -<p>O título da tab (normalmente o título da página atualmente carregada na tab). Esta propriedade pode ser configurada para mudar o título da tab.</p> - -<h4 class="addon-sdk-api-name" id="url"><code>url</code></h4> - -<p>A URL da página atualmente carregada na tab. Esta propriedade pode ser configurada para carregar uma URL diferente na tab.</p> - -<h4 class="addon-sdk-api-name" id="favicon"><code>favicon</code></h4> - -<p>A URL do favicon para a página atualmente carregada na tab. Esta propriedade é somente para leitura.</p> - -<div class="warning">Esta propriedade está desatualizada. Da versão 1.15, use a função <a href="/en-US/Add-ons/SDK/Low-Level_APIs/places_favicon">getFavicon() do módulo favicon</a> ao invés.</div> - -<h4 class="addon-sdk-api-name" id="contentType"><code>contentType</code></h4> - -<div class="experimental"><strong>Esta é uma API experimental atualmente, então nós devemos mudar ele em lançamentos futuros. </strong> - -<p>Retorna o tipo MIME que o documento atualmente tem carregado na tab sendo desenhada. Ele deve vir do cabeçalho do HTTP ou outra fonte de informação MIME, e deve ser afetado pela conversão de tipo automática executada pelo navegador ou extensão. Esta propriedade é somente leitura.</p> -</div> - -<h4 class="addon-sdk-api-name" id="index"><code>index</code></h4> - -<p>O índice da tab relativa a outras tabs na janela da aplicação. Esta propriedade pode ser configurada para mudar sua posição relativa.</p> - -<h4 class="addon-sdk-api-name" id="isPinned"><code>isPinned</code></h4> - -<p>Se ou não esta tab é anexável como uma <a href="http://support.mozilla.com/en-US/kb/what-are-app-tabs">app tab</a>. Esta propriedade é somente leitura.</p> - -<h4 class="addon-sdk-api-name" id="window"><code>window</code></h4> - -<p>O objeto <a href="/en-US/Add-ons/SDK/High-Level_APIs/windows#BrowserWindow"><code>window</code></a> para esta tab.</p> - -<h4 class="addon-sdk-api-name" id="readyState"><code>readyState</code></h4> - -<div class="geckoVersionNote"> -<p>Novo no Firefox 33.</p> -</div> - -<p>Uma string dizendo a você qual o estado de carga do documento hospedado por esta tab. Isto corresponde diretamente ao <a href="/en-US/docs/Web/API/document.readyState"><code>Document.readyState</code></a>. Ele tem um de quatro valores possíveis:</p> - -<ul> - <li>"uninitialized": o documento da tab não está ainda carregado</li> - <li>"loading": o documento da tab está ainda em processo de carga</li> - <li>"interactive": o documento da tab carregou e está analisado, mas os recursos tais como imagens e folhas de escilo devem ainda ser carregados</li> - <li>"complete": o documento da tab e todos os recursos estão inteiramente carregados</li> -</ul> - -<p>Uma vez que o <code>readyState</code> da tab entrou no "interactive", você pode pegar as propriedades tais como a URL do documento.</p> - -<h3 id="Eventos_2">Eventos</h3> - -<h4 class="addon-sdk-api-name" id="close_2"><code>close</code></h4> - -<p>Este evento é emitido quando a tab é fechada. Ele também é emitido quando a janela da tab é fechada.</p> - -<h5 id="Argumentos_6">Argumentos</h5> - -<p><strong>Tab</strong> : Escutas são passadas ao objeto tab.</p> - -<h4 class="addon-sdk-api-name" id="ready_2"><code>ready</code></h4> - -<p>Este evento é emitido quando o DOM para o conteúdo da tab estiver preparado. Ele é equivalente ao evento <a href="https://developer.mozilla.org/en-US/docs/Web/Reference/Events/DOMContentLoaded"><code>DOMContentLoaded</code></a> para o dado conteúdo da página. Neste ponto o documento por si só está inteiramente carreado e analisado, mas recursos tais como folhas de estilo e imagens devem estar ainda carregando.</p> - -<p>Uma única tab emitirá este evento todas às vezes que o DOM estiver carregado: então ela será emitida novamente se o endereço da tab mudar ou o conteúdo for recarregado. Depois deste evento ser emitido, todas as propriedades relacionadas ao conteúdo da tab podem ser usadas.</p> - -<h5 id="Argumentos_7">Argumentos</h5> - -<p><strong>Tab</strong> : Escutas são passadas ao objeto tab.</p> - -<h4 class="addon-sdk-api-name" id="load"><code>load</code></h4> - -<p>Este evento é emitido quando a página do conteúdo da tab estiver carregada. É equivalente ao evento <a href="https://developer.mozilla.org/en-US/docs/Web/Reference/Events/load"><code>load</code></a> para o dado conteúdo da página. Neste ponto o documento e seus recursos, tais como imagens e folhas de estilo, terminaram o carregamento.</p> - -<p>Este evento pode ser usado por páginas que não tem um evento <code>DOMContentLoaded</code>, como imagens. Para páginas que tem um evento<code> DOMContentLoaded</code>, <code>load</code> é disparado depois do <code>ready</code>.</p> - -<p>Uma única tab emitirá este evento toda vez que a página for carregada: então ele será emitido novamente se o endereço da tab mudar ou o conteúdo for recarregado. Depois deste evento ser emitido, todas as propriedades relacionadas ao conteúdo da tab podem ser usados</p> - -<h5 id="Argumentos_8">Argumentos</h5> - -<p><strong>Tab</strong> : Escutas são passadas para o objeto tab.</p> - -<h4 class="addon-sdk-api-name" id="pageshow"><code>pageshow</code></h4> - -<p>O evento <code>pageshow</code> é emitido quando a página para o conteúdo da tab for carregado. É equivalente ao evento <a href="https://developer.mozilla.org/en-US/docs/DOM/Mozilla_event_reference/pageshow"><code>pageshow</code></a> para um dado conteúdo da página.</p> - -<p>Este evento é similar aos eventos <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs#load"><code>load</code></a> e <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs#ready"><code>ready</code></a>, exceto que diferente de <code>load</code> e <code>ready</code>, <code>pageshow</code> é lançado se a página for recuperada do <a href="https://developer.mozilla.org/en-US/docs/Working_with_BFCache">bfcache.</a> Isto significa que se o usuário carrega a página, carrega uma nova página, então se move para a página anterior usando o botão "Back", o evento <code>pageshow</code> é emitido quando o usuário volta a página, enquanto os eventos <code>load</code> e <code>ready</code> não são.</p> - -<p>Este evento <em>não</em> é emitido quando a tab fica ativa: para conseguir ser notificado sobre isso, você precisa escutar o evento <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs#activate"><code>activate</code></a>.</p> - -<p>Depois que este evento foi emitido, todas as propriedades relacionadas ao conteúdo da tab podem ser usadas. Ele é emitido depois do <code>load</code> e <code>ready</code>.</p> - -<h5 id="Argumentos_9">Argumentos</h5> - -<p><strong>Tab</strong> : Escutas são passadas ao objeto tab.</p> - -<p><strong>persisted</strong> : Escutas são passadas um valor booleano indicando se ou não a página foi carregada do <a href="https://developer.mozilla.org/en-US/docs/Working_with_BFCache">bfcache</a>.</p> - -<h4 class="addon-sdk-api-name" id="activate_2"><code>activate</code></h4> - -<p>Este evento é emitido quando a tab torna-se ativa.</p> - -<p>Observe que você não pode garantir que o conteúdo da tab, ou mesmo sua <code>url</code>, estão inicializados na hora que o <code>activate</code> foi emitido. Isto porque quando uma nova tab é aberta, seu evento activate pode ser emitido antes do conteúdo ser carregado.</p> - -<p>Você pode usar a propriedade <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs#readyState"><code>readyState</code></a> da tab para determinar se o conteúdo da tab e <code>url</code> estão disponíveis: se o <code>readyState</code> está <code>uninitialized</code> ou <code>loading</code>, então você não pode acessar as propriedades da tab e deve esperar pelo evento <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs#ready_2"><code>ready</code></a> da tab.</p> - -<h5 id="Argumentos_10">Argumentos</h5> - -<p><strong>Tab</strong> : Escutas são passadas ao objeto.</p> - -<h4 class="addon-sdk-api-name" id="deactivate_2"><code>deactivate</code></h4> - -<p>Este evento é emitido quando a tab torna-se inativa.</p> - -<h5 id="Argumentos_11">Argumentos</h5> - -<p><strong>Tab</strong> : Escutas são passadas ao objeto tab.</p> diff --git a/files/pt-br/mozilla/add-ons/sdk/high-level_apis/windows/index.html b/files/pt-br/mozilla/add-ons/sdk/high-level_apis/windows/index.html deleted file mode 100644 index 35c0b6bdb3..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/high-level_apis/windows/index.html +++ /dev/null @@ -1,303 +0,0 @@ ---- -title: Janelas -slug: Mozilla/Add-ons/SDK/High-Level_APIs/windows -tags: - - Add-on SDK -translation_of: Archive/Add-ons/Add-on_SDK/High-Level_APIs/windows ---- -<div class="note"> -<p>Stable</p> -</div> - -<p><span class="seoSummary">Enumera e examina janelas do navegador abertas, abre novas janelas, e escuta por eventos de janela.</span></p> - -<h2 id="Uso">Uso</h2> - -<p>O módulo <code>windows</code> fornece funções básicas para trabalhar janelas de navegador. Com este módulo, você pode:</p> - -<ul> - <li><a href="/en-US/Add-ons/SDK/High-Level_APIs/windows#open(options)">enumerar as janeals abertas atualmente</a></li> - <li><a href="/en-US/Add-ons/SDK/High-Level_APIs/windows#open(options)">abrir novas janelas do navegador</a></li> - <li><a href="/en-US/Add-ons/SDK/High-Level_APIs/windows#Events">criar escutas para eventos comuns de janela tais como open e close</a></li> -</ul> - -<h3 id="Janelas_Privadas">Janelas Privadas</h3> - -<p>Se seu add-on não optou pela navegação privada, então você não verá qualquer janela de navegação privada. Janelas de navegação privada não aparecerão na propriedade <a href="/en-US/Add-ons/SDK/High-Level_APIs/windows#browserWindows"><code>browserWindows</code></a>, você não receberá qualquer evento de janela, e você não será capaz de abrir janelas privadas.</p> - -<p>Para aprender mais sobre navegação privada, como optar pela navegação privada, e como suportar navegação privada dirija-se à <a href="/en-US/Add-ons/SDK/High-Level_APIs/private-browsing">documentação para o módulo <code>private-browsing</code></a>.</p> - -<h3 id="Converção_para_as_Janelas_Chrome">Converção para as Janelas Chrome</h3> - -<p>Para converter do objeto <a href="/en-US/Add-ons/SDK/High-Level_APIs/windows#BrowserWindow"><code>BrowserWindow</code></a> usando nesta API para o objeto chrome <a href="/en-US/docs/Web/API/Window"><code>window</code></a> usado na API <a href="/en-US/Add-ons/SDK/Low-Level_APIs/window_utils"><code>window/utils</code></a>, use a função <code>viewFor()</code> expotada pelo módulo <code>viewFor()</code>.</p> - -<p>Para converter de vola, de uma janela chrome para um objeto <code>BrowserWindow</code>, use a função <code>modelFor()</code>, exportada pelo módulo <code>modelFor</code>.</p> - -<p>Aqui está um exemplo convertendo do alto nível <code>BrowserWindow</code> para uma janela chrome, e então voltando para o outro modo:</p> - -<pre class="brush: js">var { modelFor } = require("sdk/model/core"); -var { viewFor } = require("sdk/view/core"); - -var browserWindows = require("sdk/windows").browserWindows; - -function convertToChromeAndBack(browserWindow) { - // get the chrome window for this BrowserWindow - var chromeWindow = viewFor(browserWindow); - // now we can use the chrome window API - console.log(chromeWindow.document.location.href); - // -> "chrome://browser/content/browser.xul" - - // convert back to the high-level window - var highLevelWindow = modelFor(chromeWindow); - // now we can use the SDK's high-level window API - console.log(highLevelWindow.title); -} - -browserWindows.on("open", convertToChromeAndBack);</pre> - -<p>Note que acessar diretamente os objetos chrome de baixo nível significa que você não está protegido pelas garantias de compatibilidade das APIs de alto nível do SDK. Em particular, dependendo de o que você faz com estes objetos, seu código não deve trabalhar com <a href="http://billmccloskey.wordpress.com/2013/12/05/multiprocess-firefox/">multiprocess Firefox</a>.</p> - -<h2 id="Globais">Globais</h2> - -<h3 id="Funções">Funções</h3> - -<h4 class="addon-sdk-api-name" id="open(options)"><code>open(options)</code></h4> - -<p>Abre uma nova janela.</p> - -<pre class="brush: js">var windows = require("sdk/windows").browserWindows; - -// Open a new window. -windows.open("http://www.example.com"); - -// Open a new window and set a listener for "open" event. -windows.open({ - url: "http://www.example.com", - onOpen: function(window) { - // do stuff like listen for content - // loading. - } -});</pre> - -<p>Retorna a janela que foi aberta:</p> - -<pre class="brush: js">var windows = require("sdk/windows").browserWindows; -var example = windows.open("http://www.example.com"); - -require("sdk/ui/button/action").ActionButton({ - id: "read", - label: "Read", - icon: "./read.png", - onClick: function() { - example.close(); - } -}); -</pre> - -<div class="note"> -<p>Este exemplo usa a API <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_action">action button</a>, que está disponível somente do Firefox 29 em frente.</p> -</div> - -<h5 id="Parâmetros">Parâmetros</h5> - -<p><strong>options : object</strong><br> - Opções requeridas:</p> - -<table class="standard-table"> - <thead> - <tr> - <th scope="col">Name</th> - <th scope="col">Type</th> - <th scope="col"> </th> - </tr> - </thead> - <tbody> - <tr> - <td>url</td> - <td>string</td> - <td> - <p>String com a URL a ser aberta na nova janela. É uma propriedade necessária.</p> - </td> - </tr> - <tr> - <td>isPrivate</td> - <td>boolean</td> - <td> - <p>Boleano que determinará se a nova janela seria privada ou não. Se seus add-ons não suportam navegação privada isto não terá efeito. Veja a documentação sobre <a href="/en-US/Add-ons/SDK/High-Level_APIs/private-browsing">private-browsing</a> para mais informação.</p> - </td> - </tr> - </tbody> -</table> - -<p>Opções opcionais:</p> - -<table class="standard-table"> - <thead> - <tr> - <th scope="col">Name</th> - <th scope="col">Type</th> - <th scope="col"> </th> - </tr> - </thead> - <tbody> - <tr> - <td>onOpen</td> - <td>function</td> - <td> - <p>Uma função de retorno que é chamada quando a janela está aberta. Isto não significa que o conteúdo da URL foi carregado, somente que a janela por si está inteiramente funcional e suas propriedades podem ser acessadas. Isto é uma propriedade opcional.</p> - </td> - </tr> - <tr> - <td>onClose</td> - <td>function</td> - <td> - <p>Uma função de retorno que é chamada quando a janela será chamada. Isto é uma propriedade opcional.</p> - </td> - </tr> - <tr> - <td>onActivate</td> - <td>function</td> - <td> - <p>Uma função de retorno que é chamada quando a janela está ativa. Isto é uma propriedade opcional.</p> - </td> - </tr> - <tr> - <td>onDeactivate</td> - <td>function</td> - <td> - <p>Uma função de retorno que é chamada quando a janela não está ativa. Isto é uma propriedade opcional.</p> - </td> - </tr> - </tbody> -</table> - -<h5 id="Retorna">Retorna</h5> - -<p><strong>BrowserWindow</strong> :</p> - -<h3 id="Properties">Properties</h3> - -<h4 class="addon-sdk-api-name" id="browserWindows"><code>browserWindows</code></h4> - -<p><code>browserWindows</code> fornece acesso a todas as janelas de navegadores abertas com os objetos <a href="/en-US/Add-ons/SDK/High-Level_APIs/windows#BrowserWindow">BrowserWindow</a>.</p> - -<pre class="brush: js">var windows = require("sdk/windows"); -for (let window of windows.browserWindows) { - console.log(window.title); -} - -console.log(windows.browserWindows.length);</pre> - -<p>Este objeto emite todos os eventos listados na seção "Eventos':</p> - -<pre class="brush: js">var windows = require("sdk/windows").browserWindows; - -// add a listener to the 'open' event -windows.on('open', function(window) { - myOpenWindows.push(window); -}); - -// add a listener to the 'close' event -windows.on('close', function(window) { - console.log("A window was closed."); -}); - -// add a listener to the 'activate' event -windows.on('activate', function(window) { - console.log("A window was activated."); -}); - -// add a listener to the 'deactivate' event -windows.on('deactivate', function(window) { - console.log("A window was deactivated."); -});</pre> - -<p>A janela ativa atual é data pelo <code>BrowserWindows.activeWindow</code>:</p> - -<pre class="brush: js">var windows = require("sdk/windows").browserWindows; - -windows.on('activate', function(window) { - console.log("A window was activated."); - var activeWindowTitle = windows.activeWindow.title; - console.log("Active window title is: " + activeWindowTitle); -});</pre> - -<h3 id="Eventos">Eventos</h3> - -<h4 class="addon-sdk-api-name" id="open"><code>open</code></h4> - -<p>Evento emitido quando uma nova janela é aberta. Isso não significa que o conteúdo foi carregado, somente que a janela do navegador por si só está inteiramente visível ao usuário.</p> - -<h5 id="Argumentos">Argumentos</h5> - -<p><strong>Window</strong> : Escutas são passadas para o objeto <code>window</code> que desencadeou o evento.</p> - -<h4 class="addon-sdk-api-name" id="close"><code>close</code></h4> - -<p>Evento emitido quando uma janela é fechada. Você não pode sempre confiar na recepção do evento close para todas as janelas abertas. Em particular, se o usuário fechar o navegador de forma preciptada o que pode fechar o add-on antes das janelas serem fechadas.</p> - -<h5 id="Argumentos_2">Argumentos</h5> - -<p><strong>Window</strong> : escutas são passadas para o objeto <code>window</code> lançou o evento.</p> - -<h4 class="addon-sdk-api-name" id="activate"><code>activate</code></h4> - -<p>Evento emitido quando uma janela inativa é tornada ativa.</p> - -<h5 id="Argumentos_3">Argumentos</h5> - -<p><strong>Window</strong> : Escutas são passadas para o objeto <code>window</code> que torna ativa.</p> - -<h4 class="addon-sdk-api-name" id="deactivate"><code>deactivate</code></h4> - -<p>Evento emitido quando a janela ativa se torna inativa.</p> - -<h5 id="Arguments">Arguments</h5> - -<p><strong>Window</strong> : Escutas são passadas para o objeto<code> window</code> que se tornou inativa.</p> - -<h2 id="BrowserWindow">BrowserWindow</h2> - -<p>Uma instância <code>BrowserWindow</code> representa uma única janela aberta. Elas podem ser recuperadas da propriedade <code>browserWindows</code> exportadas pelo módulo.</p> - -<pre class="brush: js">var windows = require("sdk/windows").browserWindows; - -//Print how many tabs the current window has -console.log("The active window has " + - windows.activeWindow.tabs.length + - " tabs."); - -// Print the title of all browser windows -for (let window of windows) { - console.log(window.title); -} - -// close the active window -windows.activeWindow.close(function() { - console.log("The active window was closed"); -});</pre> - -<h3 id="Métodos">Métodos</h3> - -<h4 class="addon-sdk-api-name" id="activate()"><code>activate()</code></h4> - -<p>Torna a janela ativa, que focará aquela janela e trará ela para o primeiro plano.</p> - -<h4 class="addon-sdk-api-name" id="close(callback)"><code>close(callback)</code></h4> - -<p>Fecha a janela.</p> - -<h5 id="Parâmetros_2">Parâmetros</h5> - -<p><strong>callback : function</strong><br> - Uma função chamada quando a janela termina seu processo de fechamento. É um argumento opcional.</p> - -<h3 id="Propriedades">Propriedades</h3> - -<h4 class="addon-sdk-api-name" id="title"><code>title</code></h4> - -<p>O título atual da janela. Normalmente o título da tab ativa, mais um identificador da app. Esta propriedade é somente leitura.</p> - -<h4 class="addon-sdk-api-name" id="tabs"><code>tabs</code></h4> - -<p>Uma lista ao vivo das tabs na janela. Esse objeto tem as mesma interface da API <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs"><code>tabs</code></a>, exceto que ele contem somente as tabs nesta janela, não todas as tabs em todas as janelas. Esta propriedade é somente leitura.</p> diff --git a/files/pt-br/mozilla/add-ons/sdk/index.html b/files/pt-br/mozilla/add-ons/sdk/index.html deleted file mode 100644 index 88ed15ad16..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/index.html +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: Add-on SDK -slug: Mozilla/Add-ons/SDK -tags: - - Add-on SDK - - Extensões -translation_of: Archive/Add-ons/Add-on_SDK ---- -<p>Usando a SDK de Add-ons você pode criar add-ons para Firefox usando tecnologias web padrão: Javascript, HTML e CSS. A SDK inclui APIs Javascript as quais você pode utilizar para criar add-ons, além de ferramentas para rodar, testar e empacotar os mesmos.</p> -<hr> -<h3 id="Tutoriais">Tutoriais</h3> -<div class="column-container"> - <div class="column-half"> - <dl> - <dt> - <a href="/en-US/Add-ons/SDK/Tutorials#getting-started">Começando</a></dt> - <dd> - Como <a href="/en-US/Add-ons/SDK/Tutorials/Installation">instalar a SDK</a> e <a href="/en-US/Add-ons/SDK/Tutorials/Getting_Started_With_cfx">usar a ferramenta cfx</a> para desenvolver, testar e empacotar add-ons.</dd> - <dt> - <a href="/en-US/Add-ons/SDK/Tutorials#interact-with-the-browser">Interagindo com o Navegador</a></dt> - <dd> - <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Open_a_Web_Page">Abrir páginas web</a>, <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Listen_For_Page_Load">escutar por carregamento de páginas</a> e <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/List_Open_Tabs">listar páginas abertas.</a></dd> - <dt> - <a href="/en-US/Add-ons/SDK/Tutorials#development-techniques">Técnicas de Desenvolvimento</a></dt> - <dd> - Aprenda técnicas comúns de desenvolvimento, tal como <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Unit_testing">testes unitários</a>, <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Logging">registramento</a>, <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Creating_Reusable_Modules">criando módulos reutilizáveis</a>, <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/l10n">localização</a> e <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Mobile_development">desenvolvimento mobile</a>.</dd> - </dl> - </div> - <div class="column-half"> - <dl> - <dt> - <a href="/en-US/Add-ons/SDK/Tutorials#create-user-interfaces">Crie componentes de Interface de Usuário</a></dt> - <dd> - Crie componentes de interface de usuário tais como <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Adding_a_Button_to_the_Toolbar">botões de toolbar</a>, <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Add_a_Context_Menu_Item">menus de contexto</a>, <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Add_a_Menu_Item_to_Firefox">itens de menu</a> e <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Display_a_Popup">dialogs</a>.</dd> - <dt> - <a href="/en-US/Add-ons/SDK/Tutorials#modify-web-pages">Modifique páginas Web</a></dt> - <dd> - Modifique páginas que <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Modifying_Web_Pages_Based_on_URL">verificam um padrão de URL</a> ou dinamicamente <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Modifying_the_Page_Hosted_by_a_Tab">modifique uma aba em particular</a>.</dd> - <dt> - <a href="/en-US/Add-ons/SDK/Tutorials/Annotator">Juntando Tudo</a></dt> - <dd> - Um guia sobre o exemplo do add-on Annotator</dd> - </dl> - </div> -</div> -<hr> -<h3 id="Guia">Guia</h3> -<div class="column-container"> - <div class="column-half"> - <dl> - <dt> - <a href="/en-US/Add-ons/SDK/Guides#contributors-guide">Guia do Contribuidor</a></dt> - <dd> - Aprenda sobre <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/Getting_Started">como começar a contribuir</a> para a SDK e sobre os idiomas mais importantes utilizados no código da SDK, tal como <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/Modules">módulos</a>, <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/Classes_and_Inheritance">classes e herança</a>, <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/Private_Properties">propriedades privadas</a> e <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/Content_Processes">processos de conteúdo</a>.</dd> - <dt> - <a href="/en-US/Add-ons/SDK/Guides#sdk-infrastructure">Infraestrutura da SDK</a></dt> - <dd> - Aspectos da tecnologia fundamental da SDK: <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/Module_structure_of_the_SDK">módulos</a>, o <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/Program_ID">ID de Programa</a> e regras que definem <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/Firefox_Compatibility">compatibilidade do Firefox</a>.</dd> - <dt> - <a href="/en-US/Add-ons/SDK/Guides/Content_Scripts">Content scripts</a></dt> - <dd> - Um guia detalhado sobre <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/Content_Scripts">trabalhar com content scripts</a>, incluindo: <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/Loading_content_scripts">como carregar content scripts</a>, <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/Accessing_the_DOM">que objetos content scripts podem acessar</a> e <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/Communicating_with_other_scripts">como comunicar entre content scripts e o resto do add-on</a>.</dd> - </dl> - </div> - <div class="column-half"> - <dl> - <dt> - <a href="/en-US/Add-ons/SDK/Guides#sdk-idioms">Idiomas da SDK</a></dt> - <dd> - O <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/Working_with_Events">event framework</a> da SDK e uma <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/Two_Types_of_Scripts">distinção entre scripts add-on e content scripts</a>.</dd> - <dt> - <a href="/en-US/Add-ons/SDK/Guides/XUL_Migration_Guide">Migração de XUL</a></dt> - <dd> - Um guia sobre <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/XUL_Migration_Guide">como portar add-ons XUL para a SDK</a>. Este guia inclui uma <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/XUL_vs_SDK">comparação das duas ferramentas</a> e um <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Guides/Porting_the_Library_Detector">exemplo funcionando</a> de como portal um add-on XUL.</dd> - </dl> - </div> -</div> -<hr> -<h3 id="Referência">Referência</h3> -<div class="column-container"> - <div class="column-half"> - <dl> - <dt> - <a href="/en-US/Add-ons/SDK/High-Level_APIs">APIs Alto Nível</a></dt> - <dd> - Documentação referência para as APIs de Alto nível da SDK.</dd> - <dt> - <a href="/en-US/Add-ons/SDK/Tools">Referência de Ferramentas</a></dt> - <dd> - Documentação referência para a <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tools/cfx">ferramenta cfx</a> usada para desenvolver, testar e empacotar add-ons, o <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tools/console">console</a> global usado para registro e o arquivo <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tools/package_json">package.json</a>.</dd> - </dl> - </div> - <div class="column-half"> - <dl> - <dt> - <a href="/en-US/Add-ons/SDK/Low-Level_APIs">APIs Baixo Nível</a></dt> - <dd> - Documentação referência para as APIs baixo nível.</dd> - </dl> - </div> -</div> -<p> </p> diff --git a/files/pt-br/mozilla/add-ons/sdk/low-level_apis/index.html b/files/pt-br/mozilla/add-ons/sdk/low-level_apis/index.html deleted file mode 100644 index 8cd08458f0..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/low-level_apis/index.html +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Low-Level APIs -slug: Mozilla/Add-ons/SDK/Low-Level_APIs -tags: - - NeedsTranslation - - TopicStub -translation_of: Archive/Add-ons/Add-on_SDK/Low-Level_APIs ---- -<p>Modules in this section implement low-level APIs. These modules fall roughly into three categories:</p> -<ul> - <li> - <p>fundamental utilities such as <a href="/en-US/Add-ons/SDK/Low-Level_APIs/util_collection">collection</a>. Many add-ons are likely to want to use modules from this category.</p> - </li> - <li> - <p>building blocks for higher level modules, such as <a href="/en-US/Add-ons/SDK/Low-Level_APIs/event_core">events</a> and <a href="/en-US/Add-ons/SDK/Low-Level_APIs/content_worker">worker</a>. You're more likely to use these if you are building your own modules that implement new APIs, thus extending the SDK itself.</p> - </li> - <li> - <p>privileged modules that expose powerful low-level capabilities such as <a href="/en-US/Add-ons/SDK/Low-Level_APIs/window_utils">window/utils</a> and <a href="/en-US/Add-ons/SDK/Low-Level_APIs/net_xhr">net/xhr</a>. You can use these modules in your add-on if you need to, but should be aware that the cost of privileged access is the need to take more elaborate security precautions. In many cases these modules have simpler, more restricted analogs among the "High-Level APIs" (for example, <a href="/en-US/Add-ons/SDK/High-Level_APIs/windows">windows</a> or <a href="/en-US/Add-ons/SDK/High-Level_APIs/request">request</a>).</p> - </li> -</ul> -<p>These modules are still in active development, and we expect to make incompatible changes to them in future releases.</p> -<p>{{ LandingPageListSubpages ("/en-US/Add-ons/SDK/Low-Level_APIs", 5) }}</p> -<p> </p> diff --git a/files/pt-br/mozilla/add-ons/sdk/low-level_apis/ui_sidebar/index.html b/files/pt-br/mozilla/add-ons/sdk/low-level_apis/ui_sidebar/index.html deleted file mode 100644 index a8bd2be2eb..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/low-level_apis/ui_sidebar/index.html +++ /dev/null @@ -1,455 +0,0 @@ ---- -title: ui/sidebar -slug: Mozilla/Add-ons/SDK/Low-Level_APIs/ui_sidebar -translation_of: Archive/Add-ons/Add-on_SDK/Low-Level_APIs/ui_sidebar ---- -<p>{{AddonSidebar}}</p> - -<div class="note"> -<p>Experimental</p> -</div> - -<p><span class="seoSummary">Enables you to create sidebars.</span> A sidebar is a vertical strip of user interface real estate for your add-on that's attached to the left-hand side of the browser window. You specify its content using HTML, CSS, and JavaScript, and the user can show or hide it in the same way they can show or hide the built-in sidebars.</p> - -<h2 id="Usage">Usage</h2> - -<h3 id="Creating_showing_and_hiding_sidebars">Creating, showing, and hiding sidebars</h3> - -<p>You construct a <code>Sidebar</code> object using the <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_sidebar#Sidebar(options)"><code>Sidebar()</code></a> constructor.</p> - -<p>Once you've done that, you can show the sidebar by calling the Sidebar's <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_sidebar#show()"><code>show()</code></a> method. If a new window is opened from a window that has a sidebar visible, the new window gets a sidebar, too.</p> - -<p>You can hide the sidebar by calling its <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_sidebar#hide()"><code>hide()</code></a> method.</p> - -<p>Called with no arguments, <code>show()</code> and <code>hide()</code> will operate on the currently active window. From Firefox 33 onwards you can pass a <a href="/en-US/Add-ons/SDK/High-Level_APIs/windows#BrowserWindow"><code>BrowserWindow</code></a> into these methods, and they will then operate on the specified window.</p> - -<p>Alternatively, the View->Sidebar submenu in Firefox will contain a new item which the user can use to show or hide the sidebar:</p> - -<p><img alt="" src="https://mdn.mozillademos.org/files/6667/sidebar-menu.png" style="display: block; height: 229px; margin-left: auto; margin-right: auto; width: 518px;">The sidebar generates a <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_sidebar#show"><code>show</code></a> event when it is shown and a <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_sidebar#hide"><code>hide</code></a> event when it is hidden.</p> - -<p>Once you've finished using the sidebar you can destroy it by calling its <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_sidebar#dispose()"><code>dispose()</code></a> method.</p> - -<p>To show what a sidebar looks like, here's a sidebar that displays the results of running the <a href="http://validator.w3.org/">W3C Validator</a> on the current page:</p> - -<p><img alt="" src="https://mdn.mozillademos.org/files/6669/sidebar.png" style="display: block; margin-left: auto; margin-right: auto;"></p> - -<h3 id="Specifying_sidebar_content">Specifying sidebar content</h3> - -<p>O conteúdo de uma barra lateral é especificado usando HTML, que é carregado a partir da URL fornecida na opção url do construtor da barra lateral. Ao contrário de módulos como <a href="/en-US/Add-ons/SDK/High-Level_APIs/panel"><code>panel</code></a>, o conteúdo deve ser local, normalmente carregado do diretório de dados ('data') da extensão, através de um URL contruída usando <a href="/en-US/Add-ons/SDK/High-Level_APIs/self#data"><code>self.data.url()</code></a>:</p> - -<pre class="brush: js">var sidebar = require("sdk/ui/sidebar").Sidebar({ - id: 'my-sidebar', - title: 'My sidebar', - url: require("sdk/self").data.url("sidebar.html") -});</pre> - -<div class="note"> -<p>From Firefox 34, you can use <code>"./sidebar.html"</code> as an alias for <code>self.data.url("sidebar.html")</code>. So you can rewrite the above code like this:</p> - -<pre class="brush: js">var sidebar = require("sdk/ui/sidebar").Sidebar({ - id: 'my-sidebar', - title: 'My sidebar', - url: "./sidebar.html" -});</pre> -</div> - -<p>Você pode incluir JavaScript e CSS no HTML como faria com qualquer página da web, por exemplo, usando tags <script> e <link> contendo o caminho relativo ao próprio arquivo HTML.</p> - -<pre class="brush: html"><!DOCTYPE HTML> -<html> - <head> - <link href="stuff.css" type="text/css" rel="stylesheet"> - </head> - <body> - <script type="text/javascript" src="stuff.js"></script> - </body> -</html> - -</pre> - -<p>You can update the sidebar's content by setting the sidebar's <code>url</code> property. This will change the sidebar's content across all windows.</p> - -<h3 id="Communicating_with_sidebar_scripts">Communicating with sidebar scripts</h3> - -<p>You can't directly access your sidebar's content from your main add-on code, but you can send messages between your main add-on code and scripts loaded into your sidebar.</p> - -<p>On the sidebar end of the conversation, sidebar scripts get a global variable <code>addon</code> that contains a <code>port</code> for sending and receiving messages.</p> - -<p>On the add-on side, you need to get a <code>worker</code> object for the sidebar before you can send or receive messages. There are two events emitted by the sidebar which will give you a worker: <code>attach</code> and <code>ready</code>. Listen to <code>attach</code> if the first message in your add-on goes from the sidebar scripts to the main add-on code, and listen to <code>ready</code> if the first message goes from the main add-on code to the sidebar script.</p> - -<h4 id="Using_attach">Using attach</h4> - -<p>The <code>attach</code> event is triggered whenever the DOM for a new sidebar instance is loaded and its scripts are attached. The sidebar script may not be initialized yet, so you can't reliably send messages to the sidebar script right away: however, you can start listening to messages from the script.</p> - -<p>Here's a simple but complete add-on that shows how to set up communication between main.js and a script in a sidebar, in the case where the sidebar script initiates communication:</p> - -<p>The HTML file includes just a script, "sidebar.js":</p> - -<pre class="brush: html"><!DOCTYPE HTML> -<html> - <body> - Content for my sidebar - <script type="text/javascript" src="sidebar.js"></script> - </body> -</html> - -</pre> - -<p>The "sidebar.js" file sends a <code>ping</code> message to main.js using <code>port.emit()</code> as soon as it loads, and adds a listener to the <code>pong</code> message.</p> - -<pre class="brush: js">addon.port.emit("ping"); - -addon.port.on("pong", function() { - console.log("sidebar script got the reply"); -});</pre> - -<p>The "main.js" file creates a sidebar object and adds a listener to its <code>attach</code> event. On attach, "main.js" starts listening to the <code>ping</code> message, and responds with a <code>pong</code>:</p> - -<pre class="brush: js">var sidebar = require("sdk/ui/sidebar").Sidebar({ - id: 'my-sidebar', - title: 'My sidebar', - url: require("sdk/self").data.url("sidebar.html"), - onAttach: function (worker) { - worker.port.on("ping", function() { - console.log("add-on script got the message"); - worker.port.emit("pong"); - }); - } -});</pre> - -<p>Try running the add-on, and showing the sidebar using the "View->Sidebar->My sidebar" menu item. You should see console output like:</p> - -<pre>console.log: add-on: add-on script got the message -console.log: add-on: sidebar script got the reply -</pre> - -<h4 id="Using_ready">Using ready</h4> - -<p>The <code>ready</code> event is emitted when the DOM for the sidebar's content is ready. It is equivalent to the <code>DOMContentLoaded</code> event. At this point the sidebar script is initialized, so you can send messages to the sidebar script and be confident that they will not be lost. Listen to this event if your add-on initiates the conversation.</p> - -<p>Here's a simple but complete add-on that shows how to set up communication between main.js and a script in a sidebar, in the case where the main.js script initiates communication:</p> - -<p>The HTML file includes just a script, "sidebar.js":</p> - -<pre class="brush: html"><!DOCTYPE HTML> -<html> - <body> - Content for my sidebar - <script type="text/javascript" src="sidebar.js"></script> - </body> -</html> - -</pre> - -<p>The "sidebar.js" file listens to the <code>ping</code> message from main.js, and responds with a <code>pong</code> message.</p> - -<pre class="brush: js">addon.port.on("ping", function() { - console.log("sidebar script got the message"); - addon.port.emit("pong"); -});</pre> - -<p>The "main.js" file creates a sidebar object and adds a listener to its <code>attach</code> event. On attach, "main.js" sends the <code>ping</code> message, and starts listening for the <code>pong</code>:</p> - -<pre class="brush: js">var sidebar = require("sdk/ui/sidebar").Sidebar({ - id: 'my-sidebar', - title: 'My sidebar', - url: require("sdk/self").data.url("sidebar.html"), - onReady: function (worker) { - worker.port.emit("ping"); - worker.port.on("pong", function() { - console.log("add-on script got the reply"); - }); - } -});</pre> - -<p>Try running the add-on, and showing the sidebar using the "View->Sidebar->My sidebar" menu item. You should see console output like:</p> - -<pre>console.log: add-on: sidebar script got the message -console.log: add-on: add-on script got the reply -</pre> - -<p> </p> - -<h2 id="Globals">Globals</h2> - -<h3 id="Constructors">Constructors</h3> - -<h4 class="addon-sdk-api-name" id="Sidebar(options)"><code>Sidebar(options)</code></h4> - -<p>Creates a sidebar.</p> - -<pre class="brush: js">var sidebar = require("sdk/ui/sidebar").Sidebar({ - id: 'my-sidebar', - title: 'My sidebar', - url: require("sdk/self").data.url("sidebar.html"), - onAttach: function (worker) { - console.log("attaching"); - }, - onShow: function () { - console.log("showing"); - }, - onHide: function () { - console.log("hiding"); - }, - onDetach: function () { - console.log("detaching"); - } -});</pre> - -<h5 id="Parameters">Parameters</h5> - -<p><strong>options : object</strong><br> - Required options:</p> - -<table class="standard-table"> - <thead> - <tr> - <th scope="col">Name</th> - <th scope="col">Type</th> - <th scope="col"> </th> - </tr> - </thead> - <tbody> - <tr> - <td>title</td> - <td>string</td> - <td> - <p>A title for the sidebar. This will be used for the label for your sidebar in the "Sidebar" submenu in Firefox, and will be shown at the top of your sidebar when it is open.</p> - </td> - </tr> - <tr> - <td>url</td> - <td>string</td> - <td> - <p>The URL of the content to load in the sidebar. This must be a local URL (typically, loaded from the "data" folder using <code>self.data.url()</code>).</p> - - <div class="note"> - <p>From Firefox 34, you can use <code>"./myFile.html"</code> as an alias for <code>self.data.url("myFile.html")</code>.</p> - </div> - </td> - </tr> - </tbody> -</table> - -<p>Optional options:</p> - -<table class="standard-table"> - <thead> - <tr> - <th scope="col">Name</th> - <th scope="col">Type</th> - <th scope="col"> </th> - </tr> - </thead> - <tbody> - <tr> - <td>id</td> - <td>string</td> - <td> - <p>The <code>id</code> of the sidebar. This used to identify this sidebar in its chrome window. It must be unique.</p> - - <div class="geckoVersionNote"> - <p>This option was mandatory before Firefox 28.</p> - </div> - </td> - </tr> - <tr> - <td>onAttach</td> - <td>function</td> - <td> - <p>Listener for the sidebar's <code>attach</code> event.</p> - </td> - </tr> - <tr> - <td>onDetach</td> - <td>function</td> - <td> - <p>Listener for the sidebar's <code>detach</code> event.</p> - </td> - </tr> - <tr> - <td>onShow</td> - <td>function</td> - <td> - <p>Listener for the sidebar's <code>show</code> event.</p> - </td> - </tr> - <tr> - <td>onHide</td> - <td>function</td> - <td> - <p>Listener for the sidebar's <code>hide</code> event.</p> - </td> - </tr> - </tbody> -</table> - -<h2 id="Sidebar">Sidebar</h2> - -<p>The Sidebar object. Once a sidebar has been created it can be shown and hidden in the active window using its <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_sidebar#show()"><code>show()</code></a> and <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_sidebar#hide()"><code>hide()</code></a> methods. Once a sidebar is no longer needed it can be destroyed using <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_sidebar#dispose()"><code>dispose()</code></a>.</p> - -<h3 id="Methods">Methods</h3> - -<h4 class="addon-sdk-api-name" id="dispose()"><code>dispose()</code></h4> - -<p>Destroys the sidebar. Once destroyed, the sidebar can no longer be used.</p> - -<h4 class="addon-sdk-api-name" id="show(window)"><code>show(window)</code></h4> - -<p>Displays the sidebar.</p> - -<h5 id="Parameters_2">Parameters</h5> - -<p><strong>window : BrowserWindow</strong><br> - The window in which to show the sidebar, specified as a <a href="/en-US/Add-ons/SDK/High-Level_APIs/windows#BrowserWindow"><code>BrowserWindow</code></a>. This parameter is optional. If it is omitted, then the sidebar will be shown in the currently active window. This parameter is new in Firefox 33.</p> - -<h4 class="addon-sdk-api-name" id="hide(window)"><code>hide(window)</code></h4> - -<p>Hides the sidebar.</p> - -<h5 id="Parameters_3">Parameters</h5> - -<p><strong>window : BrowserWindow</strong><br> - The window for which to hide the sidebar, specified as a <a href="/en-US/Add-ons/SDK/High-Level_APIs/windows#BrowserWindow"><code>BrowserWindow</code></a>. This parameter is optional. If it is omitted, then the sidebar will be hidden for the currently active window. This parameter is new in Firefox 33.</p> - -<h4 class="addon-sdk-api-name" id="on(type_listener)"><code>on(type, listener)</code></h4> - -<p>Registers an event listener with the sidebar.</p> - -<h5 id="Parameters_4">Parameters</h5> - -<p><strong>type : string</strong><br> - The type of event to listen for.</p> - -<p><strong>listener : function</strong><br> - The listener function that handles the event.</p> - -<h4 class="addon-sdk-api-name" id="once(type_listener)"><code>once(type, listener)</code></h4> - -<p>Registers an event listener with the sidebar. The difference between <code>on</code> and <code>once</code> is that <code>on</code> will continue listening until it is removed, whereas <code>once</code> is removed automatically upon the first event it catches.</p> - -<h5 id="Parameters_5">Parameters</h5> - -<p><strong>type : string</strong><br> - The type of event to listen for.</p> - -<p><strong>listener : function</strong><br> - The listener function that handles the event.</p> - -<h4 class="addon-sdk-api-name" id="removeListener(type_listener)"><code>removeListener(type, listener)</code></h4> - -<p>Unregisters/removes an event listener from the sidebar.</p> - -<h5 id="Parameters_6">Parameters</h5> - -<p><strong>type : string</strong><br> - The type of event for which <code>listener</code> was registered.</p> - -<p><strong>listener : function</strong><br> - The listener function that was registered.</p> - -<h3 id="Properties">Properties</h3> - -<h4 class="addon-sdk-api-name" id="id"><code>id</code></h4> - -<p>The id of the sidebar. This used to identify this sidebar in its chrome window. It must be unique.</p> - -<h4 class="addon-sdk-api-name" id="title"><code>title</code></h4> - -<p>The title of the sidebar. This will be used for the label for your sidebar in the "Sidebar" submenu in Firefox, and will be shown at the top of your sidebar when it is open.</p> - -<h4 class="addon-sdk-api-name" id="url"><code>url</code></h4> - -<p>The URL of the content to load in the sidebar. This must be a local URL (typically, loaded from the "data" folder using <code>self.data.url()</code>).</p> - -<h3 id="Events">Events</h3> - -<h4 class="addon-sdk-api-name" id="attach"><code>attach</code></h4> - -<p>This event is emitted when a worker is attached to a sidebar, as a result of any of the following:</p> - -<ul> - <li>calling the sidebar's <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_sidebar#show()"><code>show()</code></a> method, when the sidebar is not shown in the currently active window</li> - <li>changing the sidebar's <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_sidebar#url"><code>url</code></a> property</li> - <li>the user switching the sidebar on using the "Sidebar" submenu in Firefox, when the sidebar is not shown in the currently active window</li> - <li>the user opening a new window from a window that has the sidebar showing</li> -</ul> - -<p>It is passed a <a href="/en-US/Add-ons/SDK/Low-Level_APIs/content_worker"><code>worker</code></a> as an argument, which defines <code>port.emit()</code> and <code>port.on()</code> methods that you can use to send messages to, and receive messages from, scripts loaded into the sidebar.</p> - -<p>This is the event you should listen to if your main add-on code needs to communicate with the scripts loaded into the sidebar, and the sidebar scripts start the conversation.</p> - -<p>See <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_sidebar#Using_attach">Using attach</a> for an example.</p> - -<h4 class="addon-sdk-api-name" id="ready"><code>ready</code></h4> - -<p>This event is emitted after the DOM content for a sidebar has been loaded, as a result of any of:</p> - -<ul> - <li>calling the sidebar's <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_sidebar#show()"><code>show()</code></a> method, when the sidebar is not shown in the currently active window</li> - <li>changing the sidebar's <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_sidebar#url"><code>url</code></a> property</li> - <li>the user switching the sidebar on using the "Sidebar" submenu in Firefox, when the sidebar is not shown in the currently active window</li> - <li>the user opening a new window from a window that has the sidebar showing</li> -</ul> - -<p>It is passed a <a href="/en-US/Add-ons/SDK/Low-Level_APIs/content_worker"><code>worker</code></a> as an argument, which defines <code>port.emit()</code> and <code>port.on()</code> methods that you can use to send messages to, and receive messages from, scripts loaded into the sidebar.</p> - -<p>This is the event you should listen to if your main add-on code needs to communicate with the scripts loaded into the sidebar and the main add-on code starts the conversation.</p> - -<p>See <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_sidebar#Using_ready">Using ready</a> for an example.</p> - -<h4 class="addon-sdk-api-name" id="detach"><code>detach</code></h4> - -<p>This event is emitted when a worker is detached from a sidebar, as a result of either of the following:</p> - -<ul> - <li>calling the sidebar's <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_sidebar#hide()"><code>hide()</code></a> method, when the sidebar is being shown in the currently active window</li> - <li>the user switching the sidebar off using the "Sidebar" submenu in Firefox, when the sidebar is being shown in the currently active window</li> -</ul> - -<p>The <code>detach</code> listener receives a <a href="/en-US/Add-ons/SDK/Low-Level_APIs/content_worker"><code>worker</code></a> object as a parameter. This object is the same as the worker passed into the corresponding <code>attach</code> event. After <code>detach</code>, this worker can no longer be used to communicate with the scripts in that sidebar instance, because it has been unloaded.</p> - -<p>If you listen to <code>attach</code>, and in the listener take a reference to the worker object that's passed into it, so you can send it messages later on, then you should probably listen to <code>detach</code>, and in its handler, remove your reference to the worker.</p> - -<p>Here's an add-on that adds each worker to an array in the <code>attach</code> handler, and makes sure that its references are cleaned up by listening to <code>detach</code> and removing workers as they are detached:</p> - -<pre class="brush: js">var workerArray = []; - -function attachWorker(worker) { - workerArray.push(worker); -} - -function detachWorker(worker) { - var index = workerArray.indexOf(worker); - if(index != -1) { - workerArray.splice(index, 1); - } -} - -var sidebar = require("sdk/ui/sidebar").Sidebar({ - id: 'my-sidebar', - title: 'My Sidebar', - url: require("sdk/self").data.url("sidebar.html"), - onAttach: attachWorker, - onDetach: detachWorker -});</pre> - -<h4 class="addon-sdk-api-name" id="show"><code>show</code></h4> - -<p>This event is emitted when the sidebar is shown, as a result of any of the following:</p> - -<ul> - <li>calling the sidebar's <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_sidebar#show()"><code>show()</code></a> method, when the sidebar is not shown in the currently active window</li> - <li>changing the sidebar's <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_sidebar#url"><code>url</code></a> property</li> - <li>the user switching the sidebar on using the "Sidebar" submenu in Firefox, when the sidebar is not shown in the currently active window</li> - <li>the user opening a new window from a window that has the sidebar showing</li> -</ul> - -<h4 class="addon-sdk-api-name" id="hide"><code>hide</code></h4> - -<p>This event is emitted when the sidebar is hidden, as a result of either of the following:</p> - -<ul> - <li>calling the sidebar's <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_sidebar#hide()"><code>hide()</code></a> method, when the sidebar is being shown in the currently active window</li> - <li>the user switching the sidebar off using the "Sidebar" submenu in Firefox, when the sidebar is being shown in the currently active window</li> -</ul> diff --git a/files/pt-br/mozilla/add-ons/sdk/low-level_apis/window_utils/index.html b/files/pt-br/mozilla/add-ons/sdk/low-level_apis/window_utils/index.html deleted file mode 100644 index 5ceef79058..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/low-level_apis/window_utils/index.html +++ /dev/null @@ -1,386 +0,0 @@ ---- -title: window/utils -slug: Mozilla/Add-ons/SDK/Low-Level_APIs/window_utils -translation_of: Archive/Add-ons/Add-on_SDK/Low-Level_APIs/window_utils ---- -<div class="note"> -<p>Unstable</p> -</div> - -<div class="note"> -<p>Note that this module includes functions that give you direct access to web content. These functions are not safe to call in multiprocess Firefox. See <a href="/en-US/Add-ons/SDK/Guides/Multiprocess_Firefox_and_the_SDK">Multiprocess Firefox and the SDK</a> for more details.</p> -</div> - -<p><span class="seoSummary">Functions for working with browser windows.</span></p> - -<h2 id="Usage">Usage</h2> - -<h3 id="Private_windows">Private windows</h3> - -<p>With this module your add-on will see private browser windows even if it has not explicitly opted into private browsing, so you need to take care not to store any user data derived from private browser windows.<br> - <br> - The exception is the windows() function which returns an array of currently opened windows. Private windows will not be included in this list if your add-on has not opted into private browsing.<br> - <br> - To learn more about private windows, how to opt into private browsing, and how to support private browsing, refer to the documentation for the private-browsing module.</p> - -<h2 id="Globals">Globals</h2> - -<h3 id="Functions">Functions</h3> - -<h4 class="addon-sdk-api-name" id="getMostRecentBrowserWindow()"><code>getMostRecentBrowserWindow()</code></h4> - -<p>Get the topmost browser window, as an nsIDOMWindow instance.</p> - -<h5 id="Returns">Returns</h5> - -<p><strong>nsIDOMWindow</strong>: the topmost browser window.</p> - -<h4 class="addon-sdk-api-name" id="getInnerId(window)"><code>getInnerId(window)</code></h4> - -<p>Returns the ID of the specified window's current inner window. This function wraps nsIDOMWindowUtils.currentInnerWindowID.</p> - -<h5 id="Parameters">Parameters</h5> - -<p><strong>window : nsIDOMWindow</strong><br> - The window whose inner window we are interested in.</p> - -<h5 id="Returns_2">Returns</h5> - -<p><strong>ID</strong>: the given window's ID.</p> - -<h4 class="addon-sdk-api-name" id="getOuterId(window)"><code>getOuterId(window)</code></h4> - -<p>Returns the ID of the specified window's outer window. This function wraps nsIDOMWindowUtils.outerWindowID.</p> - -<h5 class="addon-sdk-api-name" id="Parameters_2">Parameters</h5> - -<p><strong>window : nsIDOMWindow</strong><br> - The window whose outer window we are interested in.</p> - -<h5 id="Returns_3">Returns</h5> - -<p><strong>ID</strong>: the outer window's ID.</p> - -<h4 class="addon-sdk-api-name" id="getXULWindow(window)"><code>getXULWindow(window)</code></h4> - -<p>Returns the nsIXULWindow for the given nsIDOMWindow:</p> - -<pre class="brush: js">var { Ci } = require('chrome'); -var utils = require('sdk/window/utils'); -var active = utils.getMostRecentBrowserWindow(); -active instanceof Ci.nsIXULWindow // => false -utils.getXULWindow(active) instanceof Ci.nsIXULWindow // => true</pre> - -<h5 id="Parameters_3">Parameters</h5> - -<p><strong>window : nsIDOMWindow</strong></p> - -<h5 id="Returns_4">Returns</h5> - -<p><strong>nsIXULWindow</strong></p> - -<h4 class="addon-sdk-api-name" id="getBaseWindow(window)"><code>getBaseWindow(window)</code></h4> - -<p>Returns the nsIBaseWindow for the given nsIDOMWindow:</p> - -<pre class="brush: js">var { Ci } = require('chrome'); -var utils = require('sdk/window/utils'); -var active = utils.getMostRecentBrowserWindow(); -active instanceof Ci.nsIBaseWindow // => false -utils.getBaseWindow(active) instanceof Ci.nsIBaseWindow // => true</pre> - -<h5 id="Parameters_4">Parameters</h5> - -<p><strong>window : nsIDOMWindow</strong></p> - -<h5 id="Returns_5">Returns</h5> - -<p><strong>nsIBaseWindow</strong></p> - -<h4 class="addon-sdk-api-name" id="getToplevelWindow(window)"><code>getToplevelWindow(window)</code></h4> - -<p>Returns the toplevel nsIDOMWindow for the given child nsIDOMWindow:</p> - -<pre class="brush: js">var { Ci } = require('chrome'); -var utils = require('sdk/window/utils'); -var browserWindow = utils.getMostRecentBrowserWindow(); -var window = browserWindow.content; // `window` object for the current webpage -utils.getToplevelWindow(window) == browserWindow // => true</pre> - -<h5 id="Parameters_5">Parameters</h5> - -<p><strong>window : nsIDOMWindow</strong></p> - -<h5 id="Returns_6">Returns</h5> - -<p><strong>nsIDOMWindow</strong></p> - -<h4 class="addon-sdk-api-name" id="getWindowDocShell(window)"><code>getWindowDocShell(window)</code></h4> - -<p>Returns the nsIDocShell for the tabbrowser element.</p> - -<h5 id="Parameters_6">Parameters</h5> - -<p><strong>window : nsIDOMWindow</strong></p> - -<h5 id="Returns_7">Returns</h5> - -<p><strong>nsIDocShell</strong></p> - -<h4 class="addon-sdk-api-name" id="getWindowLoadingContext(window)"><code>getWindowLoadingContext(window)</code></h4> - -<p>Returns the nsILoadContext.</p> - -<h5 id="Parameters_7">Parameters</h5> - -<p><strong>window : nsIDOMWindow</strong></p> - -<h5 id="Returns_8">Returns</h5> - -<p><strong>nsILoadContext</strong></p> - -<h4 class="addon-sdk-api-name" id="open(uri_options)"><code>open(uri, options)</code></h4> - -<p>This function is used to open top level (application) windows. It takes the uri of the window document as its first argument and an optional hash of options as its second argument.</p> - -<pre class="brush: js">var { open } = require('sdk/window/utils'); -var window = open('data:text/html,Hello Window');</pre> - -<p>This function wraps <a href="/en-US/docs/Mozilla/Tech/XPCOM/Reference/Interface/nsIWindowWatcher">nsIWindowWatcher</a>.openWindow.</p> - -<h5 id="Parameters_8">Parameters</h5> - -<p><strong>uri : string</strong><br> - URI of the document to be loaded into the window. Only chrome, resource, and data schemes are accepted.</p> - -<p><strong>options : object</strong><br> - Options for the function, with the following properties:</p> - -<table class="standard-table"> - <thead> - <tr> - <th scope="col">Name</th> - <th scope="col">Type</th> - <th scope="col"> </th> - </tr> - </thead> - <tbody> - <tr> - <td>parent</td> - <td>nsIDOMWindow</td> - <td>Parent for the new window. Optional, defaults to null.</td> - </tr> - <tr> - <td>name</td> - <td>string</td> - <td>Name that is assigned to the window. Optional, defaults to null.</td> - </tr> - <tr> - <td>features</td> - <td>object</td> - <td> - <p>Map of features to set for the window, defined like this: { width: 10, height: 15, chrome: true }.</p> - - <p>See the window.open features documentation for more details.</p> - - <p>Optional, defaults to an empty map: {}.</p> - - <pre class="brush: js"> -var { open } = require('sdk/window/utils'); -var window = open('data:text/html,Hello Window', { - name: 'jetpack window', - features: { - width: 200, - height: 50, - popup: true - } -});</pre> - </td> - </tr> - <tr> - <td>args</td> - <td>object</td> - <td>Extra argument(s) to be attached to the new window as the window.arguments property.</td> - </tr> - </tbody> -</table> - -<h5 id="Returns_9"><br> - Returns</h5> - -<p><strong>nsIDOMWindow</strong></p> - -<h4 class="addon-sdk-api-name" id="openDialog(options)"><code>openDialog(options)</code></h4> - -<p>Opens a top level window and returns its nsIDOMWindow representation. This is the same as open, but you can supply more features. It wraps window.openDialog.</p> - -<h5 id="Parameters_9">Parameters</h5> - -<p><strong>options : object</strong><br> - Options for the function, with the following properties:</p> - -<table class="standard-table"> - <thead> - <tr> - <th scope="col">Name</th> - <th scope="col">Type</th> - <th scope="col"> </th> - </tr> - </thead> - <tbody> - <tr> - <td>url</td> - <td>string</td> - <td>URI of the document to be loaded into the window. Defaults to "chrome://browser/content/browser.xul".</td> - </tr> - <tr> - <td>name</td> - <td>string</td> - <td>Optional name that is assigned to the window. Defaults to "_blank".</td> - </tr> - <tr> - <td>features</td> - <td>string</td> - <td> - <p>Map of features to set for the window, defined like: { width: 10, height: 15, chrome: true }.</p> - - <p>For the set of features you can set, see the window.openDialog documentation.</p> - - <p>Optional, defaults to: 'chrome,all,dialog=no'.</p> - </td> - </tr> - <tr> - <td>args</td> - <td>object</td> - <td>Extra argument(s) to be attached to the new window as the window.arguments property.</td> - </tr> - </tbody> -</table> - -<h5 id="Returns_10">Returns</h5> - -<p><strong>nsIDOMWindow</strong></p> - -<h4 class="addon-sdk-api-name" id="windows()"><code>windows()</code></h4> - -<p>Returns an array of all currently opened windows. Note that these windows may still be loading.</p> - -<p>In order to see private windows in this list, your add-on must have <a href="/en-US/Add-ons/SDK/High-Level_APIs/private-browsing#Opting_into_private_browsing">opted into private browsing</a> and you must include the <code>includePrivate</code> key in the list of options:</p> - -<pre class="brush: js"> var allWindows = window_utils.windows(null, {includePrivate:true}); -</pre> - -<h5 id="Parameters_10">Parameters</h5> - -<p><strong>type : string</strong><br> - String identifying the type of window to return. This is passed directly into <a href="/en-US/docs/Mozilla/Tech/XPCOM/Reference/Interface/nsIWindowMediator#getEnumerator()"><code>nsIWindowMediator.getEnumerator()</code></a>, so its possible values are the same as those expected by that function. In particular:</p> - -<ul> - <li><code>null</code>: get all window types</li> - <li><code>navigator:browser</code>: get "normal" browser windows</li> - <li><code>devtools:scratchpad</code>: get <a href="/en-US/docs/Tools/Scratchpad">Scratchpad</a> windows</li> - <li><code>navigator:view-source</code>: get <a href="/en-US/docs/View_source">view source</a> windows</li> -</ul> - -<p>If you're not also passing options, you can omit this, and it's the same as passing <code>null</code>.</p> - -<p><strong>options : object</strong><br> - Options object containing the following property:</p> - -<table class="standard-table"> - <thead> - <tr> - <th scope="col">Name</th> - <th scope="col">Type</th> - <th scope="col"> </th> - </tr> - </thead> - <tbody> - <tr> - <td>includePrivate</td> - <td>boolean</td> - <td>Whether to include private windows. Defaults to false. The add-on must also have opted into private windows for this to have an effect.</td> - </tr> - </tbody> -</table> - -<h5 id="Returns_11">Returns</h5> - -<p><strong>Array</strong>: array of nsIDOMWindow instances.</p> - -<h4 class="addon-sdk-api-name" id="isDocumentLoaded(window)"><code>isDocumentLoaded(window)</code></h4> - -<p>Check if the given window's document is completely loaded. This means that its "load" event has been fired and all content is loaded, including the whole DOM document, images, and any other sub-resources.</p> - -<h5 id="Parameters_11">Parameters</h5> - -<p><strong>window : nsIDOMWindow</strong></p> - -<h5 id="Returns_12">Returns</h5> - -<p><strong>boolean</strong>: true if the document is completely loaded.</p> - -<h4 class="addon-sdk-api-name" id="isBrowser(window)"><code>isBrowser(window)</code></h4> - -<p>Returns true if the given window is a Firefox browser window: that is, its document has a "windowtype" of "chrome://browser/content/browser.xul".</p> - -<h5 id="Parameters_12">Parameters</h5> - -<p><strong>window : nsIDOMWindow</strong></p> - -<h5 id="Returns_13">Returns</h5> - -<p><strong>boolean</strong></p> - -<h4 class="addon-sdk-api-name" id="getWindowTitle(window)"><code>getWindowTitle(window)</code></h4> - -<p>Get the title of the document hosted by the given window</p> - -<h5 id="Parameters_13">Parameters</h5> - -<p><strong>window: nsIDOMWindow</strong></p> - -<h5 id="Returns_14">Returns</h5> - -<p><strong>string</strong>: this document's title.</p> - -<h4 class="addon-sdk-api-name" id="isXULBrowser(window)"><code>isXULBrowser(window)</code></h4> - -<p>Returns true if the given window is a XUL window.</p> - -<h5 id="Parameters_14">Parameters</h5> - -<p><strong>window : nsIDOMWindow</strong></p> - -<h5 id="Returns_15">Returns</h5> - -<p><strong>boolean</strong></p> - -<h4 class="addon-sdk-api-name" id="getFocusedWindow()"><code>getFocusedWindow()</code></h4> - -<p>Gets the child window within the topmost browser window that is focused. See nsIFocusManager for more details.</p> - -<h5 id="Returns_16">Returns</h5> - -<p><strong>nsIDOMWindow</strong></p> - -<h4 class="addon-sdk-api-name" id="getFocusedElement()"><code>getFocusedElement()</code></h4> - -<p>Get the element that is currently focused. This will always be an element within the document loaded in the focused window, or null if no element in that document is focused.</p> - -<h5 id="Returns_17">Returns</h5> - -<p><strong>nsIDOMElement</strong></p> - -<h4 class="addon-sdk-api-name" id="getFrames(window)"><code>getFrames(window)</code></h4> - -<p>Get the frames contained by the given window.</p> - -<h5 id="Parameters_15">Parameters</h5> - -<p><strong>window : nsIDOMWindow</strong></p> - -<h5 id="Returns_18">Returns</h5> - -<p><strong>array</strong>: array of frames.<br> - </p> diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/abra_uma_página_web/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/abra_uma_página_web/index.html deleted file mode 100644 index defcedcee2..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/tutorials/abra_uma_página_web/index.html +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Abra uma Página Web -slug: Mozilla/Add-ons/SDK/Tutorials/Abra_uma_Página_Web -tags: - - Add-on SDK - - Tab - - runScript - - tab.attach -translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Open_a_Web_Page ---- -<div class="note">Para seguir este tutorial você precisará ter <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Installation">instalado o SDK</a> e ter conhecimento básico <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_Started_With_cfx">sobre cfx</a>.</div> - -<p>Para abrir uma página web, você pode usar o módulo <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs"><code>tabs</code></a>:</p> - -<pre class="brush: js">var tabs = require("sdk/tabs"); -tabs.open("http://www.example.com"); -</pre> - -<p>Esta função é <span class="short_text" id="result_box" lang="pt"><span class="hps">assíncrona</span></span>, então você não recebe imediatamente um objeto <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs#Tab"><code>tab</code></a> que você possa examinar. Faça isto, passe uma função de retorno para <code>open()</code>. A função de retorno é atribuída a propriedade <code>onReady</code>, e será passada a tab como argumento:</p> - -<pre class="brush: js">var tabs = require("sdk/tabs"); -tabs.open({ - url: "http://www.example.com", - onReady: function onReady(tab) { - console.log(tab.title); - } -}); -</pre> - -<p>Mesmo assim, você não consegue acesso direto a qualquer conteúdo hospedado na tab.</p> - -<p>Para acessar conteúdo da tab você precisa anexar um script à tab usando o <code>tab.attach()</code>. Este add-on carrega uma página, então anexa um script à página que adiciona uma borda vermelha nela:</p> - -<pre class="brush: js">var tabs = require("sdk/tabs"); -tabs.open({ - url: "http://www.example.com", - onReady: runScript -}); - -function runScript(tab) { - tab.attach({ - contentScript: "document.body.style.border = '5px solid red';" - }); -} -</pre> - -<h2 id="Aprendendo_Mais">Aprendendo Mais</h2> - -<p>Para aprender mais sobre uso de tabs no SDK, veja a referência da API <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs"><code>tabs</code></a>.</p> - -<p>Para aprender mais sobre execução de scripts em tabs, veja o tutorial sobre uso de <a href="/en-US/Add-ons/SDK/Tutorials/Modifying_the_Page_Hosted_by_a_Tab"><code>tab.attach()</code></a>.</p> diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/adding_a_button_to_the_toolbar/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/adding_a_button_to_the_toolbar/index.html deleted file mode 100644 index 83b2f61907..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/tutorials/adding_a_button_to_the_toolbar/index.html +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: Adicionando um botão à barra de ferramentas -slug: Mozilla/Add-ons/SDK/Tutorials/Adding_a_Button_to_the_Toolbar -translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Adding_a_Button_to_the_Toolbar ---- -<div class="note"> -<p>Para seguir este tutorial você precisará ter <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Installation">instalado o SDK</a> e ter conhecimento <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_Started_With_cfx">básico do cfx</a>.</p> - -<p>Este tutorial usa a API <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_action">action button</a>, que está disponível somente do Firefox 29 em diante.</p> -</div> - -<p>Para adicionar um botão à barra de ferramentas, use os módulos <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_action">action button</a> ou <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_toggle">toggle button</a>.</p> - -<p>Crie um novo diretório, navegue até ele, e execute <code>cfx init</code>.</p> - -<p>Então salve estes três ícones no diretório "data":</p> - -<table class="standard-table"> - <tbody> - <tr> - <td><img alt="" src="https://mdn.mozillademos.org/files/7635/icon-16.png" style="height: 16px; width: 16px;"></td> - <td>icon-16.png</td> - </tr> - <tr> - <td><img alt="" src="https://mdn.mozillademos.org/files/7637/icon-32.png" style="height: 32px; width: 32px;"></td> - <td>icon-32.png</td> - </tr> - <tr> - <td><img alt="" src="https://mdn.mozillademos.org/files/7639/icon-64.png" style="height: 64px; width: 64px;"></td> - <td>icon-64.png</td> - </tr> - </tbody> -</table> - -<p>Então abra o arquivo chamado "main.js" no diretório "lib" e adicione o seguinte código a ele:</p> - -<pre class="brush: js">var buttons = require('sdk/ui/button/action'); -var tabs = require("sdk/tabs"); - -var button = buttons.ActionButton({ - id: "mozilla-link", - label: "Visit Mozilla", - icon: { - "16": "./icon-16.png", - "32": "./icon-32.png", - "64": "./icon-64.png" - }, - onClick: handleClick -}); - -function handleClick(state) { - tabs.open("https://www.mozilla.org/"); -}</pre> - -<p>Agora execute o add-on com <code>cfx run</code>. O botão é adicionado à barra de ferramentas no topo da janela do navegador:</p> - -<p><img alt="" src="https://mdn.mozillademos.org/files/7641/mozilla-button.png" style="display: block; height: 221px; margin-left: auto; margin-right: auto; width: 382px;">Você não pode configurar a localização inicial para o botão, mas o usuário pode mover ele usando as características de personalização do navegador. O <code>id</code> é obrigatório, e é usado para lembrar a posição do botão, então você não deve mudá-lo em versões subsequentes do add-on.</p> - -<p>Clicando no botão carrega <a href="https://www.mozilla.org/en-US/">https://www.mozilla.org/</a> em uma nova tab.</p> - -<h2 id="Especificando_o_ícone">Especificando o ícone</h2> - -<p>A propriedade ícone pode especificar um único ícone ou uma coleção de ícones em diferentes tamanhos, como o exemplo acima. Se você especificar uma coleção de ícones em diferentes tamanhos o navegador automaticamente escolherá o melhor para a resolução de tela em uso e coloca na interface de usuário do navegador que hospeda o botão. <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_action#ActionButton(options)">Leia mais sobre especificar múltiplos ícones</a>.</p> - -<p>O arquivo de ícone deve ser empacotado com seu add-on: ele não pode referenciar um arquivo remoto.</p> - -<p>Você pode mudar o ícone a qualquer hora configurando a propriedade <code>icon</code> do botão. Você pode mudar o ícone, e os outros atributos de estado, ou globalmente, para uma janela específica, ou para uma tab específica. <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_action#Updating_state">Leia mais sobre atualização de estado.</a></p> - -<h2 id="Anexando_um_painel">Anexando um painel</h2> - -<p>Se você precisar anexar um panel a um botão, use a API <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_toggle">toggle button</a>. É como a API do action button exceto que ele adiciona uma propriedade boleana <code>checked </code>que é alternada sempre que o botão é checado. Para anexar o painel, passe o método <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/panel#show(options)"><code>show()</code></a> do painel. Para mais detalhes sobre isso, veja a <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_toggle#Attaching_panels_to_buttons">documentação do toggle button</a>.</p> - -<h2 id="Mostrando_conteúdo_mais_rico">Mostrando conteúdo mais rico</h2> - -<p>Para criar conteúdo mais complexo para a interface do usuário do que é possível com apenas um botão, use a API <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Low-Level_APIs/ui_toolbar">toolbar</a>. Com a API toolbar você consegue uma faixa horizontal da interface do usuário. Você pode adicionar botões à barra de ferramentas e também <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Low-Level_APIs/ui_frame">frames</a>, que podem ter HTML, CSS, e JavaScript.</p> - -<h2 id="Aprendendo_mais">Aprendendo mais</h2> - -<ul> - <li><a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_action">Referência action button</a></li> - <li><a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_action">Referência </a><a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_toggle">toggle button</a></li> - <li><a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_action">Referência </a><a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_toolbar">toolbar</a></li> -</ul> diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/adicionar_uma_item_de_menu_ao_firefox/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/adicionar_uma_item_de_menu_ao_firefox/index.html deleted file mode 100644 index ebc4e41846..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/tutorials/adicionar_uma_item_de_menu_ao_firefox/index.html +++ /dev/null @@ -1,115 +0,0 @@ ---- -title: Adicionar um item de menu ao Firefox -slug: Mozilla/Add-ons/SDK/Tutorials/Adicionar_uma_item_de_menu_ao_Firefox -tags: - - Add-on SDK - - Menu Item -translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Add_a_Menu_Item_to_Firefox ---- -<div class="note"> -<p>Para seguir este tutorial você precisará ter <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Installation">instalado o SDK</a> e aprendido o <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Getting_Started_With_cfx">básico do cfx</a>.</p> -</div> - -<div class="note"> -<p>Se vocé estiver usando <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tools/jpm">jpm</a> ao invés de cfx, o método para usar módulos de terceiros é diferente, e você deve ler a <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Using_third-party_modules_%28jpm%29">versão jpm</a> ao invés deste guia.</p> -</div> - -<p>O SDK não tem ainda uma API para adicionar novos itens de menu ao Firefox. Mas é extensível por design, então qualquer um pode construir e publicar módulos para desenvolvedores de add-on usar. Felizmente, Erik Vold escreveu um módulo <a href="https://github.com/mykmelez/menuitems-jplib"><code>menuitems</code></a> que nos permite adicionar itens de menu.</p> - -<p>Este tutorial tem dupla função. Ele descreve o método geral para usar um externo, módulo de terceiro em seu add-on, e ele descreve como adicionar um item de menu usando o módulo <code>menuitems</code> em especial.</p> - -<p>Primeiro, crie um novo add-on. Crie um diretório chamado "clickme" onde você quiser, navegue para ele e execute <code>cfx init</code>.</p> - -<pre>mkdir clickme -cd clickme -cfx init -</pre> - -<p>A estrutura de diretório de costume será criada:</p> - -<ul> - <li>clickme - <ul> - <li>data</li> - <li>lib - <ul> - <li>main.js</li> - </ul> - </li> - <li>package.json</li> - <li>tests - <ul> - <li>test-main.js</li> - </ul> - </li> - </ul> - </li> -</ul> - -<div> </div> - -<h2 id="Inslatando_menuitems">Inslatando menuitems</h2> - -<p>Crie um diretório em "clickme" chamado "packages". Baixe o pacote <code>menuitems</code> de <a href="https://github.com/mykmelez/menuitems-jplib/zipball/4d6ae5b410d79cc16c9c76920fbaa8a367e44ca7">https://github.com/mykmelez/menuitems-jplib</a> e extrai ele dentro do diretório "packages" que você criou:</p> - -<pre>mkdir packages -cd packages -tar -xf ../erikvold-menuitems-jplib-d80630c.zip -</pre> - -<h2 id="Dependências_de_Módulo">Dependências de Módulo</h2> - -<p>Se os módulos de terceiros dependem de módulos SDK, você pode usá-los imediatamente, mas se eles dependem de módulos de terceiros, você terá de instalar essas dependências também.</p> - -<p>No diretório principal do pacote (menuitems) você encontrará um arquivo chamado "package.json". Abra ele e procure por uma entrada chamada "dependencies". A entrada para o pacote <code>menuitems</code> é:</p> - -<pre>"dependencies": ["api-utils", "vold-utils"] -</pre> - -<p>Isso nos diz que nós precisamos instalar o pacote <code>vold-utils</code>, que nós podemos fazer baixando ele de <a href="https://github.com/mykmelez/vold-utils-jplib/zipball/a321447dc5d613df33023165854957c181dc3174">https://github.com/mykmelez/vold-utils-jplib </a>e adicionando ele ao diretório packages com <code>menuitems</code>. Veja também <a href="/en-US/docs/Mozilla/QA/Mozmill_tests/Shared_Modules/UtilsAPI">api-utils Docs</a>(UtilsAPI).</p> - -<h2 id="Usando_menuitems">Usando <code>menuitems</code></h2> - -<p>A documentação para o módulo <a href="https://github.com/mykmelez/menuitems-jplib/blob/master/docs/menuitems.md"><code>menuitems</code></a> nos diz para criar um item de menu usando <code>MenuItem()</code>. Das opções aceitas pelo <code>MenuItem()</code>, nós usaremos este conjunto mínimo:</p> - -<ul> - <li><code>id</code>: identificado para este item de menu</li> - <li><code>label</code>: texto para mostrar no item</li> - <li><code>command</code>: função chamada quando o usuário seleciona o item</li> - <li><code>menuid</code>: identificador para o elemento pai do item</li> - <li><code>insertbefore</code>: identificador para o item anterior àquele que nós queremos que o item apareça</li> -</ul> - -<div> -<div> -<pre class="brush: js">var menuitem = require("menuitems").Menuitem({ - id: "clickme", - menuid: "menu_ToolsPopup", - label: "Click Me!", - onCommand: function() { - console.log("clicked"); - }, - insertbefore: "menu_pageInfo" -});</pre> - -<div> </div> -</div> -</div> - -<p>Próximo, nós temos que declarar nossa dependência do pacote <code>menuitems</code>. No <code>package.json</code> de nosso add-on adicionamos a linha:</p> - -<pre>"dependencies": "menuitems" -</pre> - -<p>Observe que devido ao <a href="https://bugzilla.mozilla.org/show_bug.cgi?id=663480">bug 663480</a>, se você adicionar uma linha <code>dependencies </code>ao <code>package.json</code>, e você usar qualquer módulo do SDK, então você deve também declarar sua dependência naquele pacote embutido, como isto:</p> - -<pre>"dependencies": ["menuitems", "addon-sdk"] -</pre> - -<p>Agora terminamos. Execute o add-on e você verá o novo item aparecer no menu de Ferramentas: selecione ele e você verá a <code>info: clicked </code>aparecer no console.</p> - -<h2 id="Cuidados">Cuidados</h2> - -<p>Módulos de terceiros são uma ótima forma de usar características não suportadas diretamente pelo SDK, mas porque módulos de terceiros usam APIs de nível baixo, eles podem quebrar quando forem lançadas novas versões do Firefox.</p> - -<p> </p> diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/adicione_um_item_ao_menu_de_contexto/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/adicione_um_item_ao_menu_de_contexto/index.html deleted file mode 100644 index d864cd3029..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/tutorials/adicione_um_item_ao_menu_de_contexto/index.html +++ /dev/null @@ -1,120 +0,0 @@ ---- -title: Adicione um Item ao Menu de Contexto -slug: Mozilla/Add-ons/SDK/Tutorials/Adicione_um_Item_ao_Menu_de_Contexto -tags: - - Add-on SDK - - Firefox - - Guide - - context-menu -translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Add_a_Context_Menu_Item ---- -<div class="note"> -<p>Para seguir este tutorial você precisará ter <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Installation">instalado o SDK</a> e ter conhecimento <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Getting_Started_With_cfx">básico sobre cfx</a>.</p> -</div> - -<p>Para adicionar itens e submenus ao menu de contexto do Firetox, use o módulo <a href="/en-US/Add-ons/SDK/High-Level_APIs/context-menu"><code>context-menu</code></a>.</p> - -<p>Aqui está um add-on que adiciona um novo item ao menu de contexto. O item é mostrado sempre que alguma coisa na página é selecionada. Quando é clicado, a seleção é enviada para o código principal do add-on, que apenas registra ele:</p> - -<pre class="brush: js">var contextMenu = require("sdk/context-menu"); - var menuItem = contextMenu.Item({ - label: "Log Selection", - context: contextMenu.SelectionContext(), - contentScript: 'self.on("click", function () {' + - ' var text = window.getSelection().toString();' + - ' self.postMessage(text);' + - '});', - onMessage: function (selectionText) { - console.log(selectionText); - } -});</pre> - -<p>Teste: execute o add-on, carregue uma página web, selecione algum texto e clique com o botão direito. Você verá o novo item aparecer:</p> - -<p><img src="https://mdn.mozillademos.org/files/6513/context-menu-selection.png" style="display: block; margin-left: auto; margin-right: auto;"></p> - -<p>Clique nele, e a seleção é <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Logging">registrada no console</a> (ou na shell, se você estiver executando uma instância do Firefox na linha de comando):</p> - -<pre>info: elephantine lizard -</pre> - -<h2 id="Detalhes">Detalhes</h2> - -<p>Tudo que este add-on faz é criar um item no menu de contexto. Você não precisa adicioná-lo: uma vez que você criou o item, ele é automaticamente adicionado no contexto correto. O construtor nesse caso possui quatro opções: <code>label</code>, <code>context</code>, <code>contentScript</code>, e <code>onMessage</code>.</p> - -<h3 id="label">label</h3> - -<p>O <code>label</code> é tão somente a string que será mostrada.</p> - -<h3 id="context">context</h3> - -<p>O <code>context</code> descreve a circunstância em que o item será mostrado. O módulo <code>context-menu</code> oferece uma série de contextos embutidos, incluindo este <code>SelectionContext()</code>, que significa: mostrar o item quando alguma coisa na página for selecionada.</p> - -<p>Se estes simples contextos não forem suficiente, você pode definir contextos mais sofisticados usando scripts.</p> - -<h3 id="contentScript">contentScript</h3> - -<p>Este anexa um script ao item. Nesse caso o script espera pelo clique do usuário no item, então envia uma mensagem para o add-on contendo do texto selecionado.</p> - -<h3 id="onMessage">onMessage</h3> - -<p>A propriedade <code>onMessage</code> oferece um modo para o código do add-on responder mensagens do script anexado ao item do menu de contexto. Nesse caso é apenas registrado o texto selecionado.</p> - -<p>Então:</p> - -<ol> - <li>O usuário clica no item</li> - <li>o conteúdo do script do evento <code>click</code> dispara, e o conteúdo do script recupera o texto selecionado e envia a mensagem para o add-on</li> - <li>o evento <code>message</code> do add-on dispara, e ao código manipulador da função é passado o texto selecionado, que é registrado</li> -</ol> - -<h2 id="Mais_opções">Mais opções</h2> - -<h3 id="Adicionando_uma_imagem">Adicionando uma imagem</h3> - -<p>Você pode adicionar uma imagem ao menu de contexto por meio da opção <code>image</code>. Isto é uma URL apontando para um ícone 16x16 que é mostrado do lado esquerdo do item do menu de contexto. Geralmente você armazenaria sua imagem no diretório "data" do seu add-on, e construiria a URL usando <code>self.data.url()</code>:</p> - -<pre class="brush: js">var self = require("sdk/self"); - -var contextMenu = require("sdk/context-menu"); -var menuItem = contextMenu.Item({ - label: "Log Selection", - context: contextMenu.SelectionContext(), - contentScript: 'self.on("click", function () {' + - ' var text = window.getSelection().toString();' + - ' self.postMessage(text);' + - '});', - image: self.data.url("icon-16.png"), - onMessage: function (selectionText) { - console.log(selectionText); - } -});</pre> - -<h3 id="Adicione_uma_tecla_de_atalho">Adicione uma tecla de atalho</h3> - -<div class="geckoVersionNote"> -<p>Novo no Firefox 35.</p> -</div> - -<p>A partir do Firefox 35 você pode especificar uma tecla de atalho usando a opção <code>accessKey</code>. Deve ser somente um caracter. Pressione a tecla selecionada na opção quando o menu de contexto estiver aberto:</p> - -<pre class="brush: js">var contextMenu = require("sdk/context-menu"); -var menuItem = contextMenu.Item({ - label: "Log Selection", - context: contextMenu.SelectionContext(), - contentScript: 'self.on("click", function () {' + - ' var text = window.getSelection().toString();' + - ' self.postMessage(text);' + - '});', - accessKey: "l", - onMessage: function (selectionText) { - console.log(selectionText); - } -}); -</pre> - -<p> </p> - -<h2 id="Aprendendo_mais">Aprendendo mais</h2> - -<p>Aprendendo mais sobre o módulo <code>context-menu</code>, veja a referência da API <a href="/en-US/Add-ons/SDK/High-Level_APIs/context-menu"><code>context-menu</code></a>.</p> diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/captura_de_carregamento_da_pagina/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/captura_de_carregamento_da_pagina/index.html deleted file mode 100644 index 1fa1ae81d6..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/tutorials/captura_de_carregamento_da_pagina/index.html +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Captura de carregamento da página -slug: Mozilla/Add-ons/SDK/Tutorials/captura_de_carregamento_da_pagina -translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Listen_for_Page_Load ---- -<div class="note"> - Para seguir esse tutorial você necessita ter <a href="/en-US/Add-ons/SDK/Tutorials/Installation">instalado o SDK</a> e aprendido <a href="/en-US/Add-ons/SDK/Tutorials/Getting_Started_With_cfx">o básico do <code>cfx</code></a>.</div> -<p>Você pode capturar notificações sobre novas páginas em carregamento usando o módulo <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs"><code>tabs</code></a>. <span id="result_box" lang="pt"><span class="hps">O</span> <span class="hps">seguinte complemento</span> captura o evento ready <span class="hps">da</span> aba <span class="hps">e</span> mostra no console <span class="hps">a</span> <span class="hps">URL</span> <span class="hps">da</span><span class="hps"> mesma, carregada pelo usuário</span><span>:</span></span></p> -<pre class="brush: js">require("sdk/tabs").on("ready", logURL); - -function logURL(tab) { - console.log(tab.url); -} -</pre> -<p><span id="result_box" lang="pt"><span class="hps">Você não</span> <span class="hps">tem acesso direto</span> <span class="hps">a qualquer</span> <span class="hps">conteúdo hospedado</span> <span class="hps">na guia</span><span>.</span></span></p> -<p><span id="result_box" lang="pt"><span class="hps">Para acessar o conteúdo</span> <span class="hps">da aba </span><span class="hps">você precisa anexar</span> <span class="hps">um script</span> <span class="hps">usando</span> <code>tab.attach()</code><span class="hps">.</span> <span class="hps">Este</span> <span class="hps">add</span><span>-on</span> <span class="hps">atribui</span> <span class="hps">um script para</span> <span class="hps">todas as</span> <span class="hps">abas abertas</span><span>.</span> <span class="hps">O</span> <span class="hps">script adiciona</span> <span class="hps">uma borda vermelha</span> <span class="hps">ao</span> <span class="hps">documento</span> <span class="hps">da aba</span><span>:</span></span></p> -<pre class="brush: js">require("sdk/tabs").on("ready", runScript); - -function runScript(tab) { - tab.attach({ - contentScript: "if (document.body) document.body.style.border = '5px solid red';" - }); -} -</pre> -<p><span id="result_box" lang="pt"><span class="hps">(Este exemplo é</span> <span class="hps">apenas para mostrar</span> <span class="hps">a idéia</span><span>:</span> <span class="hps">para implementar</span> <span class="hps">algo como isso,</span> <span class="hps">você deve usar</span> <a href="/en-US/Add-ons/SDK/High-Level_APIs/page-mod"><code>page-mod</code></a><span>,</span> <span class="hps">e especificar</span> <span class="hps">"*" como</span> <span class="hps">o match-pattern</span><span class="hps">.</span></span>)</p> -<h2 id="Aprendendo_Mais">Aprendendo Mais</h2> -<p>Para aprender mais sobre o trabalho com abas no SDK, veja a <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs">referência de tab da API</a>. <span id="result_box" lang="pt"><span class="hps">Você</span> <span class="hps">pode capturar </span><span class="hps">uma série de</span> <span class="hps">outros eventos</span> <span class="hps">da aba</span><span>, incluindo</span> <code>open</code><span class="hps">, <code>close </code></span><span class="hps">e <code>activate</code>.</span></span></p> -<p>Para ler mais sobre rodar scripts nas abas, veja o <a href="/en-US/Add-ons/SDK/Tutorials/Modifying_the_Page_Hosted_by_a_Tab">tutorial sobre como usar <code>tab.attach()</code></a>.</p> diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/chrome_authority/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/chrome_authority/index.html deleted file mode 100644 index 0e09ecdc02..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/tutorials/chrome_authority/index.html +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: Autoridade Chrome -slug: Mozilla/Add-ons/SDK/Tutorials/Chrome_Authority -translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Chrome_Authority ---- -<div class="warning"> -<p>A API usada para ganhar acesso ao Chrome atualmente é uma característica experimental do SDK, e deve mudar em lançamentos futuros.</p> -</div> - -<h2 id="Usando_Autoridade_Chrome">Usando Autoridade Chrome</h2> - -<p>Os módulos de baixo-nível mais poderosos são executados com "chrome privileges", que nos dão acesso ao infame <a href="/en-US/docs/Components_object"><code>Objeto Components</code></a>, que concede acesso irrestrito ao host. A partir daí, <span id="result_box" lang="pt"><span class="hps">o módulo</span> <span class="hps">pode fazer praticamente</span> <span class="hps">qualquer coisa que o</span> <span class="hps">navegador</span> <span class="hps">é capaz.</span> <span class="hps">Para obter estes</span> <span class="hps">privilégios</span><span>, o módulo</span> <span class="hps">deve declarar</span> <span class="hps">sua intenção</span> <span class="hps">com</span> <span class="hps">uma declaração como</span> <span class="hps">a seguinte</span></span>:</p> - -<pre class="brush: js">var {Cc, Ci} = require("chrome");</pre> - -<p>O objeto retornado pelo <code>require("chrome")</code>, quando desempacotado com a característica <a href="/en-US/docs/Web/JavaScript/New_in_JavaScript/1.7#Destructuring_assignment_(Merge_into_own_page.2Fsection)">destructuring assignment</a> disponível no ambiente JS do Mozilla, fornecerá os redutores comuns dos <code>Components.*</code>:</p> - -<p><code><strong>Cc</strong></code></p> - -<p>Um redutor para <code>Components.classes</code>.</p> - -<p><code><strong>Ci</strong></code></p> - -<p>Um redutor para <code>Components.interfaces</code>.</p> - -<p><code><strong>Cu</strong></code></p> - -<p>Um redutor para <code>Components.utils</code>.</p> - -<p><code><strong>Cr</strong></code></p> - -<p>Um redutor para <code>Components.results</code>.</p> - -<p><code><strong>Cm</strong></code></p> - -<p>Um redutor para <code>Components.manager</code>.</p> - -<p><code><strong>components</strong></code></p> - -<p>Uma outra forma de chamar <code>Components</code> por si mesmo (note as letras minúsculas). A partir daí você pode acessar propriedade de uso menos frequente como <code>Components.stack</code> e <code>Components.isSuccessCode</code>.</p> - -<p>Nota: a declaração <code>require("chrome")</code> é o <strong>único</strong> modo para acessar as funcionalidades do chrome e da API <code>Components</code>. O objeto <code>Components</code> <strong>não</strong> deve ser acessado de módulos. A ferramenta SDK emitira um aviso se ela vir código em móduo que referencie o <code>Components</code> diretamente.</p> - -<p>Seu módulo deve evitar usar privilégios do chrome a menos que seja absolutamente necessário. Uso da Autoridade do Chrome deve receber revisão extra de segurança, e a maioria dos bugs nestes módulos são críticos a segurança.</p> - -<h2 id="Geração_do_Manifesto">Geração do Manifesto</h2> - -<p>O <strong>manifesto</strong> é uma lista, incluída no XPI gerado, que especifica quais módulos requisitação accesso <code>require()</code> para quais outros módulos. Ele também grava quais módulos requisitam acesso chrome. Esta lista é gerada pelo mapeamento de todos os módulos incluído pela declaração <code>require(XYZ)</code> e grava a string "XYZ" que eles referênciam.</p> - -<p>Quando a implementação do manifesto estiver completa o carregador do programa vai impedir os módulos de usar <code>require() </code>para solicitar módulos que não estão listados no manifesto. Também, evitará que os módulos consiga autoridade chrome a menos que o manifesto indique que eles pediram para ele.<span id="result_box" lang="pt"><span class="hps"> Isto irá assegurar que</span> <span class="hps">os revisores enxerguem</span> <span class="hps">as mesmas restrições</span> <span class="hps">de autoridade</span> <span class="hps">que são aplicadas</span> <span class="hps">sobre o</span> <span class="hps">código em execução, aumentando efetivamente o tempo gasto revendo o add-on. (até que</span> <span class="hps">este trabalho</span> <span class="hps">seja concluído,</span> <span class="hps">os módulos</span> <span class="hps">podem ser capazes de</span> <span class="hps">burlar</span> <span class="hps">essas restrições).</span></span></p> - -<p>O manifesto é construído com um mapeador baseado em expressão regular, não um análisador Javascript. Os desenvolvedores devem manter as declarações <code>require</code> simples, com uma única string estática, uma por linha de código. Se o mapeador falhar para enxergar a entrada <code>require</code>, o manifesto não incluirá aquela entrada, e (uma vez que a implementação esteja completa) o código em execução lança uma exceção.</p> - -<p>Por exemplo, nenhum dos códigos a seguir serão encontrados pelo mapeamento do manifesto, levando a uma exceção em tempo de execução, quando a chamada <code>require()</code> é proibida de importar os módulos chamados:</p> - -<pre class="brush: js">// todos estes falharão -var xhr = require("x"+"hr"); -var modname = "xpcom"; -var xpcom = require(modname); -var one = require("one"); var two = require("two"); -</pre> - -<p>A intenção é que os desenvolvedores usem a declaração <code>require() </code>para dois propósitos: declarar (ao revisores de segurança) qual a classificação dos poderes que os modulos querem usar, e controlar como estes poderes serão mapeados dentro do namespace do módulo local. Suas declarações devem então ser claras e fáceis de analisar. Um formato de manifesto futuro deve mover a porção de declaração para um arquivo separado, para permitir expressões mais granuladas de autorização.</p> - -<p>Comandos que constroem um manifesto, como "<code>jpm xpi</code>" ou "<code>jpm run</code>", mapearão todos os módulos incluídos pelo uso dos atalhos <code>Cc</code>/<code>Ci</code> (ou a forma expandida <code>Components.classes</code>). Emitirá um aviso se ele visualizar a forma expandida ou ver o uso e.g. "<code>Cc</code>" sem a entrada correspondente na declaração <code>require("chrome")</code>. Estes avisos servem para guiar os desenvolvedores para o usar o padrão correto. Todos os desenvolvedores de módulos devem reparar os avisos e corrigir seus códigos até que os avisos tenham desaparecido.</p> diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/começando/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/começando/index.html deleted file mode 100644 index 1294a58ffd..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/tutorials/começando/index.html +++ /dev/null @@ -1,206 +0,0 @@ ---- -title: Começando -slug: Mozilla/Add-ons/SDK/Tutorials/Começando -tags: - - Add-on SDK - - Tutorial -translation_of: Mozilla/Add-ons/SDK/Tutorials/Getting_Started_%28jpm%29 ---- -<p>Este tutorial percorre a criação de um add-on simples usando o SDK.</p> - -<h2 id="Pré-requisitos">Pré-requisitos</h2> - -<p>Para criar add-ons para Firefox usando SDK, você primeiro precisará seguir as instruções para <a href="/en-US/Add-ons/SDK/Tutorials/Installation">instalar e ativar o SDK</a>. Uma vez que você fez isso, você estará olhando para um prompt de comando.</p> - -<h2 id="Inicializando_um_add-on_vazio">Inicializando um add-on vazio</h2> - -<p>No prompt de comando, crie um novo diretório. O diretório não precisa estar no diretório principal do SDK: você pode criar ele em qualquer lugar que você quiser. Navegue para ele, digite cfx init, e tecle enter:</p> - -<pre>mkdir my-addon -cd my-addon -cfx init -</pre> - -<p>Você verá uma saída como esta:</p> - -<pre>* lib directory created -* data directory created -* test directory created -* doc directory created -* README.md written -* package.json written -* test/test-main.js written -* lib/main.js written -* doc/main.md written -Your sample add-on is now ready for testing: -try "cfx test" and then "cfx run". Have fun!" -</pre> - -<h2 id="Implementando_o_add-on">Implementando o add-on</h2> - -<p>Agora você pode escrever o código do add-on, que vai no arquivo "main.js" em diretório "lib". Esse arquivo foi criado para você no passo anterior. Abra ele e adicione o seguinte código:</p> - -<pre class="brush: js">var buttons = require('sdk/ui/button/action'); -var tabs = require("sdk/tabs"); - -var button = buttons.ActionButton({ - id: "mozilla-link", - label: "Visite Mozilla", - icon: { - "16": "./icon-16.png", - "32": "./icon-32.png", - "64": "./icon-64.png" - }, - onClick: handleClick -}); - -function handleClick(state) { - tabs.open("https://www.mozilla.org/"); -} -</pre> - -<p>Salve o arquivo.</p> - -<p>Próximo, salve estes ícones no diretório "data" de seu add-on:</p> - -<table class="standard-table"> - <tbody> - <tr> - <td><img alt="" src="https://mdn.mozillademos.org/files/7635/icon-16.png" style="height: 16px; width: 16px;"></td> - <td>icon-16.png</td> - </tr> - <tr> - <td><img alt="" src="https://mdn.mozillademos.org/files/7637/icon-32.png" style="height: 32px; width: 32px;"></td> - <td>icon-32.png</td> - </tr> - <tr> - <td><img alt="" src="https://mdn.mozillademos.org/files/7639/icon-64.png" style="height: 64px; width: 64px;"></td> - <td>icon-64.png</td> - </tr> - </tbody> -</table> - -<p>Volte ao prompt de comando, digite:</p> - -<pre>cfx run -</pre> - -<p>Este é o comando SDK para executar uma nova instância do Firefox com seu add-on instalado. Quando o Firefox inicia, no canto de cima do lado direito do navegador você verá um ícone com o logotipo do Firefox. Clique nele, e uma nova tab abrirá com o site <a href="https://www.mozilla.org/">https://www.mozilla.org/</a> carregado nela.</p> - -<p>Isso é tudo que esse add-on faz. Ele usa dois módulos SDK: o módulo <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_action">action button</a>, que permite a você adicionar botões ao navegador, e o módulo <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs/tabs">tabs</a>, que permite a você realizar operações básicas com <em>tabs</em>. Nesse caso, nós criamos uma botão cujo ícone é o íncone do Firefox, e adicionamos um manipulador de clique que carrega a home page da Mozilla na nova tab.</p> - -<p><img alt="" src="https://mdn.mozillademos.org/files/7643/mozilla-button.png" style="display: block; height: 221px; margin-left: auto; margin-right: auto; width: 382px;">Tente editar esse arquivo. Por exemplo, nós poderíamos mudar a página que é carregada:</p> - -<pre class="brush: js">var buttons = require('sdk/ui/button/action'); -var tabs = require("sdk/tabs"); - -var button = buttons.ActionButton({ - id: "mozilla-link", - label: "Visit Mozilla", - icon: { - "16": "./icon-16.png", - "32": "./icon-32.png", - "64": "./icon-64.png" - }, - onClick: handleClick -}); - -function handleClick(state) { - tabs.open("https://developer.mozilla.org/"); -}</pre> - -<p>No promp de comando, execute novamente cfx run. Desta vez clicando levará você para <a href="https://developer.mozilla.org/">https://developer.mozilla.org/</a>.</p> - -<h2 id="Empacotando_o_add-on">Empacotando o add-on</h2> - -<p>Quando você termina o add-on e está preparado para distribui-lo, você precisa empacotá-lo como um arquivo XPI. Esse é um formato de arquivo instalável para add-ons de Firefox. Você pode distribuir arquivos XPI ou publicá-los em <a href="https://addons.mozilla.org" rel="noreferrer">https://addons.mozilla.org</a> assim outros usuários podem baixar e instalá-los.</p> - -<p>Para construir um XPI, apenas execute o comando cfx xpi do diretório do add-on:</p> - -<pre>cfx xpi -</pre> - -<p>Você deve ver uma mensagem como:</p> - -<pre>Exporting extension to my-addon.xpi. -</pre> - -<p>Para testar que funcionou, tente instalar o arquivo XPI em sua própria instalação do Firefox. Você pode fazer isso pressionando Ctrl+O (Cmd+O no Mac) de dentro do Firefox, ou selecionando o item "Abrir arquivo" do menu "Arquivo" do Firefox. Isso trará uma caixa de seleção; navegue até o arquivo "my-addon.xpi", abra-o e siga o prompt para instalar o add-on.</p> - -<h2 id="Resumo">Resumo</h2> - -<p>Neste tutorial nós construímos e empacotamos um add-on usando três comandos:</p> - -<ul> - <li><code>cfx init</code> para inicializar um modelo vazio do add-on</li> - <li><code>cfx run</code> para executar uma nova instância do Firefox com o add-on instalado, não nós testamos ele</li> - <li><code>cfx xpi</code> para empacotar o add-on dentro do arquivo XPI para distribuição</li> -</ul> - -<p>Esses são os três principais comandos que você usará quando desenvolver add-ons no SDK. Há uma abrangente <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tools/cfx">documentação de referência</a> cobrindo todos os comandos que você pode usar e todas as opções que eles possuem.</p> - -<p>O próprio código do add-on usa dois módulos do SDK, <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_action">action button</a> e <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs" rel="noreferrer">tabs</a>. Há documentação de referência para toda a API do SDK, de <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/High-Level_APIs">alto</a> e <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Low-Level_APIs">baixo nível</a>.</p> - -<h2 id="O_que_vem_a_seguir">O que vem a seguir?</h2> - -<p>Para sentir algumas das coisas que você pode fazer com a API do SDK, tente trabalhar através de alguns dos <a href="/en-US/Add-ons/SDK/Tutorials" rel="noreferrer">tutorials</a>.</p> - -<h2 id="Técnicas_avançadas">Técnicas avançadas</h2> - -<h3 id="Sobreescrevendo_os_módulos_embutidos">Sobreescrevendo os módulos embutidos</h3> - -<p>Os módulos do SDK que você usa para implementar seu add-on estão embutidas no Firefox. Quando você executa ou empacota um add-on usando <code>cfx run</code> ou <code>cfx xpi</code>, o add-on usará as versões dos módulos na versão do Firefox que hospeda elas.</p> - -<p>Como um desenvolvedor de add-on, isso é normalmente o que você quer. Mas se você está desenvolvendo os módulos SDK por si mesmo, claro, não será. Nesse caso assumimos que você pegou o SDK de seu <a href="https://github.com/mozilla/addon-sdk">repositório GitHub</a> e executará o script <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Installation">bin/activate</a> desse diretório raiz de trabalho.</p> - -<p>Então quando você invoca <code>cfx run</code> ou <code>cfx xpi</code>, você passa a opçao "-o":</p> - -<pre>cfx run -o -</pre> - -<p>Isso instrui o cfx a usar a cópia local dos módulos do SDK, não aqueles existentes no Firefox.</p> - -<h3 id="Desenvolvendo_sem_cfx_run">Desenvolvendo sem cfx run</h3> - -<p>Porque <code>cfx run</code> reinicia o navegador cada vez que você invoca ele, ele pode ser um pouco pesado se você está fazendo mudanças frequentes em um add-on. Um modelo de desenvolvimento alternativo é usar o add-on <a href="https://addons.mozilla.org/en-US/firefox/addon/autoinstaller/">Extension Auto-Installer</a>: este escuta para novos arquivos XPI em uma porta específica e instala-os automaticamente. Dessa maneira você pode testar novas mudanças sem precisar reiniciar o navegador:</p> - -<ul> - <li>faça uma mudança em seu add-on</li> - <li>execute cfx xpi</li> - <li>posta o add-on para uma porta especificada</li> -</ul> - -<p>Você poderia até mesmo automatizar esse fluxo com um script simples. Por exemplo:</p> - -<pre>while true ; do cfx xpi ; wget --post-file=codesy.xpi http://localhost:8888/ ; sleep 5 ; done -</pre> - -<p>Note que o nível de registro definido para o console é diferente quando você usa esse método, comparado com o nível de registro usado quando um add-on está executando usando <code>cfx run</code>. Isso significa que se você quiser ver a saída de mensagens do <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Logging">console.log()</a>, você terá que ajustar uma configuração. Veja a documentação no <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tools/console#Logging_Levels">nível de registros</a> para mais detalhes sobre isso.</p> - -<p>Um outro exemplo usando <a href="http://gruntjs.com/">grunt</a> e <a href="https://www.npmjs.com/package/grunt-shell">grunt-shell</a>:</p> - -<pre class="brush: js">module.exports = function(grunt) { - 'use strict'; - require('matchdep').filterDev('grunt-!(cli)').forEach(grunt.loadNpmTasks); - grunt.initConfig({ - shell: { - xpi: { - command: [ - 'cd pluginpath', - 'cfx xpi', - 'wget --post-file=pluginname.xpi http://localhost:8888/ || echo>/dev/null' - ].join('&&') - } - }, - watch: { - xpi: { - files: ['pluginpath/**'], - tasks: ['shell:xpi'] - } - } - }); - - grunt.loadNpmTasks('grunt-contrib-watch'); - grunt.loadNpmTasks('grunt-shell'); - grunt.registerTask('default', ['watch']); -};</pre> diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/creating_event_targets/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/creating_event_targets/index.html deleted file mode 100644 index d8fd6a7318..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/tutorials/creating_event_targets/index.html +++ /dev/null @@ -1,245 +0,0 @@ ---- -title: Criando Alvos de Eventos -slug: Mozilla/Add-ons/SDK/Tutorials/Creating_event_targets -translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Creating_event_targets ---- -<p><span>Este tutorial descreve o uso de APIS de baixo nível. Estas APIs estão ainda em desenvolvimento, e nós esperamos fazer mudanças incompatíveis nela em lançamentos futuros.</span></p> - -<p>O <a href="/en-US/Add-ons/SDK/Guides/Working_with_Events">guia de programação de eventos dirigidos com SDK</a> descreve como consumir eventos: isto é, como escutar eventos gerados pelo alvos de evento. Por exemplo, você pode escutar ao evento <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs#ready"><code>evento ready</code> do módulo tab</a> ou <a href="/en-US/Add-ons/SDK/High-Level_APIs/panel#show">o event<code> show do objeto Panel</code></a>.</p> - -<p>Com o SDK, também é simples implementar seus próprios alvos de eventos. Isto é especialmente útil se você quiser <a href="/en-US/Add-ons/SDK/Creating_Reusable_Modules">construir seus próprios módulos</a>, ou organizar seu add-on melhor ou permitir a outros desenvolvedores reusar seu código. Se você usa o framework de eventos do SDK para seus alvos de eventos, os usuários de seus módulos podem escutar pelos eventos usando a API de evento padrão do SDK.</p> - -<p>Neste tutorial nów criaremos parte de um módulo para acessar a <a href="https://developer.mozilla.org/en/Places">API Local</a> do navegador. Ele emitirá eventos quando o usuário adicionar e visitar um favorito, permitindo aos usuários escutar estes eventos usando a API de evento padrão do SDK.</p> - -<h2 id="Usando_a_API_Local">Usando a API Local</h2> - -<p>Primeiro, vamos escrever algun código usando a API Local que registra as URIs do favorito que o usuário adicinou.</p> - -<p>Crie uma novo diretório chamado "bookmarks", navegue até ele, e execute<code><a href="/en-US/Add-ons/SDK/Tools/jpm"> jpm init</a></code>, aceitando todos os padrões. Então abra o "index.js" e adicione o seguinte código:</p> - -<pre class="brush: js">var {Cc, Ci, Cu} = require("chrome"); -Cu.import("resource://gre/modules/XPCOMUtils.jsm", this); -var bookmarkService = Cc["@mozilla.org/browser/nav-bookmarks-service;1"] - .getService(Ci.nsINavBookmarksService); - -var bookmarkObserver = { - onItemAdded: function(aItemId, aFolder, aIndex) { - console.log("added ", bookmarkService.getBookmarkURI(aItemId).spec); - }, - onItemVisited: function(aItemId, aVisitID, time) { - console.log("visited ", bookmarkService.getBookmarkURI(aItemId).spec); - }, - QueryInterface: XPCOMUtils.generateQI([Ci.nsINavBookmarkObserver]) -}; - -exports.main = function() { - bookmarkService.addObserver(bookmarkObserver, false); -}; - -exports.onUnload = function() { - bookmarkService.removeObserver(bookmarkObserver); -} -</pre> - -<p>Tente executar este add-on, adicionando e visitando favoritos, e observando a saída no console.</p> - -<h2 id="Módulos_como_Alvos_de_Evento">Módulos como Alvos de Evento</h2> - -<p>Nós podemos adaptar esse código em módulos separados que expõe a interface de evento padrão do SDK.</p> - -<p>Para fazer isso nós usaremos o módulo <a href="/en-US/Add-ons/SDK/Low-Level_APIs/event_core"><code>event/core</code></a>.</p> - -<p>Crie um novo arquivo no "lib" chamado "bookmarks.js", e adicione o seguinte código:</p> - -<pre class="brush: js">var { emit, on, once, off } = require("sdk/event/core"); - -var {Cc, Ci, Cu} = require("chrome"); -Cu.import("resource://gre/modules/XPCOMUtils.jsm", this); -var bookmarkService = Cc["@mozilla.org/browser/nav-bookmarks-service;1"] - .getService(Ci.nsINavBookmarksService); - -var bookmarkObserver = { - onItemAdded: function(aItemId, aFolder, aIndex) { - emit(exports, "added", bookmarkService.getBookmarkURI(aItemId).spec); - }, - onItemVisited: function(aItemId, aVisitID, time) { - emit(exports, "visited", bookmarkService.getBookmarkURI(aItemId).spec); - }, - QueryInterface: XPCOMUtils.generateQI([Ci.nsINavBookmarkObserver]) -}; - -bookmarkService.addObserver(bookmarkObserver, false); - -exports.on = on.bind(null, exports); -exports.once = once.bind(null, exports); -exports.removeListener = function removeListener(type, listener) { - off(exports, type, listener); -}; -</pre> - -<p>Este código implementa um módulo que pode emitir eventos <code>added</code> e <code>visited</code>. Ele duplica o código anterior, mas com um pouco de mudanças:</p> - -<ul> - <li>importe <code>emit()</code>, <code>on()</code>, <code>once()</code>, e <code>off()</code> do <code>event/core</code></li> - <li>substitua as funções de escuta com chamadas para <code>emit()</code>, passando o tipo de evento apropriado</li> - <li>exporte sua própria API de evento. Este consiste de três funções: - <ul> - <li><code>on()</code>: inicia a escuta pelo evento ou um dado tipo</li> - <li><code>once()</code>: escuta pela ocorrência de um dado evento, e então para</li> - <li><code>removeListener()</code>: para a escuta por eventos de um dado tipo</li> - </ul> - </li> -</ul> - -<p>O <code>on()</code> e <code>once()</code> exporta delegação a uma função correspondente do <code>event/core</code>, e usa <code>bind()</code> para passar o objeto <code>exports</code> por si só como o argumento <code>target(alvo)</code> à função subjacente. A função <code>removeListener()</code> é implementada pela chamada da função subjacente <code>off()</code>.</p> - -<p>Nós podemos usar este módulo do mesmo modo que nós usamos qualquer outro módulo que emite eventos a nível de módulo, tais como <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs"><code>tabs</code></a>. Por exemplo, nós podemos adaptar o "index.js" como segue:</p> - -<pre class="brush: js">var bookmarks = require("./bookmarks"); - -function logAdded(uri) { - console.log("added: " + uri); -} - -function logVisited(uri) { - console.log("visited: " + uri); -} - -exports.main = function() { - bookmarks.on("added", logAdded); - bookmarks.on("visited", logVisited); -}; - -exports.onUnload = function() { - bookmarks.removeListener("added", logAdded); - bookmarks.removeListener("visited", logVisited); -} -</pre> - -<h2 id="Classes_como_Alvos_de_Eventos">Classes como Alvos de Eventos</h2> - -<p>Às vezes nós queremos emitir eventos à nível de objetos individuais, em vez de à nível de módulo.</p> - -<p>Para fazer isto, nós podemos herdar da classe <a href="/en-US/Add-ons/SDK/Low-Level_APIs/event_target"><code>EventTarget</code></a> do SDK. <code>EventTarget</code> fornece uma implementação das funções necessárias a adicionar e remover escutas: <code>on()</code>, <code>once()</code>, e <code>removeListener()</code>.</p> - -<p>Neste exemplo, nós poderíamos definir uma classe <code>BookmarkManager</code> que herda do <code>EventTarget</code> e emite eventos <code>added</code> e <code>visited</code>.</p> - -<p>Abra o "bookmarks.js" e substitua seu conteúdo com este código:</p> - -<pre class="brush: js">var { emit } = require("sdk/event/core"); -var { EventTarget } = require("sdk/event/target"); -var { Class } = require("sdk/core/heritage"); -var { merge } = require("sdk/util/object"); - -var {Cc, Ci, Cu} = require("chrome"); -Cu.import("resource://gre/modules/XPCOMUtils.jsm", this); -var bookmarkService = Cc["@mozilla.org/browser/nav-bookmarks-service;1"] - .getService(Ci.nsINavBookmarksService); - -function createObserver(target) { - var bookmarkObserver = { - onItemAdded: function(aItemId, aFolder, aIndex) { - emit(target, "added", bookmarkService.getBookmarkURI(aItemId).spec); - }, - onItemVisited: function(aItemId, aVisitID, time) { - emit(target, "visited", bookmarkService.getBookmarkURI(aItemId).spec); - }, - QueryInterface: XPCOMUtils.generateQI([Ci.nsINavBookmarkObserver]) - }; - bookmarkService.addObserver(bookmarkObserver, false); -} - -var BookmarkManager = Class({ - extends: EventTarget, - initialize: function initialize(options) { - EventTarget.prototype.initialize.call(this, options); - merge(this, options); - createObserver(this); - } -}); - -exports.BookmarkManager = BookmarkManager; -</pre> - -<p>O código para interagir com a API Local é o mesmo que aqui. Porém:</p> - -<ul> - <li>nós estamos agora importando de quatro módulos: - <ul> - <li><a href="/en-US/Add-ons/SDK/Low-Level_APIs/event_core"><code>event/core</code></a> nos dá <code>emit()</code>: note que nós não precisamos <code>on</code>, <code>once</code>, ou <code>off</code>, desde que nós usaremos <code>EventTarget</code> para adicionar e remover escutas</li> - <li><a href="/en-US/Add-ons/SDK/Low-Level_APIs/event_target"><code>event/target</code></a> nos dá <code>EventTarget</code>, que implementa a interface para adicionar e remover escutas</li> - <li><a href="/en-US/Add-ons/SDK/Low-Level_APIs/core_heritage"><code>core/heritage</code></a> nos dá <code>Class()</code>, que nós podemos usar para herdar do <code>EventTarget</code></li> - <li><a href="/en-US/Add-ons/SDK/Low-Level_APIs/util_object"><code>util/object</code></a> nos dá <code>merge()</code>, que apenas simplifica a configuração das propriedades do <code>BookmarkManager</code></li> - </ul> - </li> - <li>nós usamos classe para herdar do<code> EventTarget</code>. Em sua função <code>initialize()</code>, nós: - <ul> - <li><span class="short_text" id="result_box" lang="pt"><span class="hps">chamar o</span> <span class="hps">inicializador de</span> <span class="hps">classe base</span></span></li> - <li>use <code>merge()</code> para copiar qualquer opção fornecida dentro do novíssimo objeto criado</li> - <li>chama <code>createObserver()</code>, passando o novíssimo objeto criado como o alvo do evento</li> - </ul> - </li> - <li><code>createObserver()</code> é o mesmo do exemplo anterior, exceto que no <code>emit()</code> nós passamos o <code>BookmarkManager</code> criado como o alvo do evento</li> -</ul> - -<p>Para usar este alvo de evento nós podemos criar ele e chamar a funções <code>on()</code>, <code>once()</code>, e <code>removeListener()</code> que ele herdou:</p> - -<pre class="brush: js">var bookmarks = require("./bookmarks"); -var bookmarkManager = bookmarks.BookmarkManager({}); - -function logAdded(uri) { - console.log("added: " + uri); -} - -function logVisited(uri) { - console.log("visited: " + uri); -} - -exports.main = function() { - bookmarkManager.on("added", logAdded); - bookmarkManager.on("visited", logVisited); -}; - -exports.onUnload = function() { - bookmarkManager.removeListener("added", logAdded); - bookmarkManager.removeListener("visited", logVisited); -} -</pre> - -<h3 id="Implementando_uma_opção_onEvent">Implementando uma opção "onEvent"</h3> - -<p>Finalmente, a maioria dos alvos de eventos aceitam opções na forma "onEvent", onde "Event" é o nome do evento com a primeira letra em maiúsculo. Por exemplo, você pode escutar o <a href="/en-US/Add-ons/SDK/High-Level_APIs/panel#show"><code>evento show do objeto Panel</code></a> ou chamando:</p> - -<pre class="brush: js">myPanel.on("show", listenerFunction); -</pre> - -<p>ou passando a opção <code>onShow</code> para o construtor do Painel:</p> - -<pre class="brush: js">var myPanel = require("sdk/panel").Panel({ - onShow: listenerFunction, - contentURL: "https://en.wikipedia.org/w/index.php" -}); -</pre> - -<p>Se sua classe herda do <code>EventTarget</code>, opções como <code>this</code> são automaticamente manipuladas para você. Por exemplo, dada a implementação do <code>BookmarkManager</code> acima, seu "index.js" seria reescrito como isto:</p> - -<pre class="brush: js">var bookmarks = require("./bookmarks"); - -function logAdded(uri) { - console.log("added: " + uri); -} - -function logVisited(uri) { - console.log("visited: " + uri); -} - -var bookmarkManager = bookmarks.BookmarkManager({ - onAdded: logAdded, - onVisited: logVisited -}); - -exports.onUnload = function() { - bookmarkManager.removeListener("added", logAdded); - bookmarkManager.removeListener("visited", logVisited); -} -</pre> diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/creating_reusable_modules/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/creating_reusable_modules/index.html deleted file mode 100644 index 837583f9c8..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/tutorials/creating_reusable_modules/index.html +++ /dev/null @@ -1,253 +0,0 @@ ---- -title: Criando Módulos Reutilizáveis -slug: Mozilla/Add-ons/SDK/Tutorials/Creating_reusable_modules -tags: - - Add-on SDK -translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Creating_reusable_modules ---- -<div class="note">Para seguir este tutorial você precisa do <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Installation">SDK instalado</a> e conhecimento <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_Started_With_cfx">básico de cfx</a>.</div> - -<p>Com o SDK você não precisa manter tudo em um único arquivo "main.js". Você pode separar seu código em módulos separados com interfaces claramente definidas entre eles. Você então importa e usa estes módulos de outras partes de seu add-on usando a declaração <code>require()</code>, da mesma forma que você importa os módulos core do SDK como <a href="/en-US/Add-ons/SDK/High-Level_APIs/page_mod"><code>page-mod</code></a> or <a href="/en-US/Add-ons/SDK/High-Level_APIs/panel"><code>panel</code></a>.</p> - -<p>Muitas vezes faz sentido estruturar um add-on muito grande ou complexo como uma coleção de módulos. Isso torna o desenho do add-on mais fácil de entender e fornece algum encapsulamento em que cada módulo exportará somente o que ele escolheu, então você pode mudar o módulo internamente sem quebrar seu usuário.</p> - -<p>Uma vez que você fez isso, você pode empacotar os módulos e distribui-los independentemente de seu add-on, tornando-os disponíveis para outros desenvolvedores de add-on e efetivamente extendendo o SDK.</p> - -<p>Neste tutorial faremos exatamente isso com o módulo que calcula hashes de arquivo.</p> - -<h2 id="Um_add-on_de_hashing">Um add-on de hashing</h2> - -<p>Uma função <em>hash</em> leva uma <em>string</em> de qualquer tamanho de bytes, e produz uma string curta e de tamanho fixo de bytes como saída. É um modo útil para criar um "fingerprint" que pode ser usado para identificar um arquivo. MD5 é uma função hash comumente usada: embora não seja considerada segura, ela trabalha bem desconsiderando o contexto da segurança.</p> - -<p>Aqui nós escreveremos um add-on que deixa o usuário escolher uma arquivo no disco e calcula seu hash. Para ambas operações nós usaremos as interfaces <a href="/en-US/docs/Mozilla/Tech/XPCOM">XPCOM</a>.</p> - -<h3 id="File_picker">File picker</h3> - -<p>Para deixar o usuário selecionar um arquivo nós usaremos o nsIFilePicker. A <a href="/en-US/docs/Mozilla/Tech/XPCOM/Reference/Interface/nsIFilePicker">documentação para esta interface</a> inclui um exemplo que nós podemos adaptar como este:</p> - -<pre class="brush: js">var {Cc, Ci} = require("chrome"); - -function promptForFile() { - const nsIFilePicker = Ci.nsIFilePicker; - - var fp = Cc["@mozilla.org/filepicker;1"] - .createInstance(nsIFilePicker); - - var window = require("sdk/window/utils").getMostRecentBrowserWindow(); - fp.init(window, "Select a file", nsIFilePicker.modeOpen); - fp.appendFilters(nsIFilePicker.filterAll | nsIFilePicker.filterText); - - var rv = fp.show(); - if (rv == nsIFilePicker.returnOK || rv == nsIFilePicker.returnReplace) { - var file = fp.file; - // Pega o caminho como string. Note que você normalmente não - // precisará trabalhar com strings de caminho. - var path = fp.file.path; - // Trabalhe com o retorno de nsILocalFile... - } - return path; -}</pre> - -<h3 id="Função_Hash">Função Hash</h3> - -<p>Firefox tem suporte embutido para funções hash, exposto via interface XPCOM nsICryptoHash. A <a href="/en-US/docs/XPCOM_Interface_Reference/nsICryptoHash">página da documentação para esta interface</a> inclui um exemplo de calculadora de hash MD5 do conteúdo do arquivo, dado seu caminho. Nós adaptamos como esta:</p> - -<pre class="brush: js">var {Cc, Ci} = require("chrome"); - -// retorna o código hexadecimal de dois dígitos para um byte -function toHexString(charCode) { - return ("0" + charCode.toString(16)).slice(-2); -} - -function md5File(path) { - var f = Cc["@mozilla.org/file/local;1"] - .createInstance(Ci.nsILocalFile); - f.initWithPath(path); - var istream = Cc["@mozilla.org/network/file-input-stream;1"] - .createInstance(Ci.nsIFileInputStream); - // abrindo para leitura - istream.init(f, 0x01, 0444, 0); - var ch = Cc["@mozilla.org/security/hash;1"] - .createInstance(Ci.nsICryptoHash); - // nós queremos usar o algoritmo MD5 - ch.init(ch.MD5); - // isto diz para updateFromStream ler o arquivo todo - const PR_UINT32_MAX = 0xffffffff; - ch.updateFromStream(istream, PR_UINT32_MAX); - // passe false aqui para conseguir os dados binários de volta - var hash = ch.finish(false); - - // converte o hash binário para hex string. - var s = Array.from(hash, (c, i) => toHexString(hash.charCodeAt(i))).join(""); - return s; -}</pre> - -<h3 id="Colocando_tudo_junto">Colocando tudo junto</h3> - -<p>O add-on completo adiciona um botão ao Firfox: quando o usuário clica no botão, nós pedimos lhe para selecionar um arquivo, e registramos o hash no console:</p> - -<pre class="brush: js">var {Cc, Ci} = require("chrome"); - -// retorna o código hexadecimal de dois dígitos para um byte -function toHexString(charCode) { - return ("0" + charCode.toString(16)).slice(-2); -} - -function md5File(path) { - var f = Cc["@mozilla.org/file/local;1"] - .createInstance(Ci.nsILocalFile); - f.initWithPath(path); - var istream = Cc["@mozilla.org/network/file-input-stream;1"] - .createInstance(Ci.nsIFileInputStream); - // abrindo para leitura - istream.init(f, 0x01, 0444, 0); - var ch = Cc["@mozilla.org/security/hash;1"] - .createInstance(Ci.nsICryptoHash); - // nós queremos usar o algoritmo MD5 - ch.init(ch.MD5); - // isto diz para updateFromStream ler o arquivo todo - const PR_UINT32_MAX = 0xffffffff; - ch.updateFromStream(istream, PR_UINT32_MAX); - // passe false aqui para conseguir os dados binários de volta - var hash = ch.finish(false); - - // converte o hash binário para hex string. - var s = Array.from(hash, (c, i) => toHexString(hash.charCodeAt(i))).join(""); - return s; -} - -function promptForFile() { - var window = require("sdk/window/utils").getMostRecentBrowserWindow(); - const nsIFilePicker = Ci.nsIFilePicker; - - var fp = Cc["@mozilla.org/filepicker;1"] - .createInstance(nsIFilePicker); - fp.init(window, "Select a file", nsIFilePicker.modeOpen); - fp.appendFilters(nsIFilePicker.filterAll | nsIFilePicker.filterText); - - var rv = fp.show(); - if (rv == nsIFilePicker.returnOK || rv == nsIFilePicker.returnReplace) { - var file = fp.file; - // Pega o caminho como string. Note que você normalmente não - // precisará trabalhar com strings de caminho. - var path = fp.file.path; - // Trabalhe com o retorno de nsILocalFile... - } - return path; -} - -require("sdk/ui/button/action").ActionButton({ - id: "show-panel", - label: "Show Panel", - icon: { - "16": "./icon-16.png" - }, - onClick: function() { - console.log(md5File(promptForFile())); - } -}); -</pre> - -<p>Isso funciona, mas main.js está agora ficando mais longo e sua lógica mais difícil de entender. This works , but main.js is now getting longer and its logic is harder to understand. Vamos levar os códigos do "file picker" e do "hashing code" para módulos separados.</p> - -<h2 id="Criando_módulos_separados">Criando módulos separados</h2> - -<h3 id="filepicker.js">filepicker.js</h3> - -<p>Primeiro criamos um novo arquivo no diretório "lib" chamado "filepicker.js". Copiamos o código do seletor de arquivos, e adicionamos a seguinte linha de código no fim dele:</p> - -<pre class="brush: js">exports.promptForFile = promptForFile; -</pre> - -<p>Isso define a interface pública do novo módulo.</p> - -<p>Então "filepicker.js" deve parecer com isto:</p> - -<pre class="brush: js">var {Cc, Ci} = require("chrome"); - -function promptForFile() { - var window = require("sdk/window/utils").getMostRecentBrowserWindow(); - const nsIFilePicker = Ci.nsIFilePicker; - - var fp = Cc["@mozilla.org/filepicker;1"] - .createInstance(nsIFilePicker); - fp.init(window, "Select a file", nsIFilePicker.modeOpen); - fp.appendFilters(nsIFilePicker.filterAll | nsIFilePicker.filterText); - - var rv = fp.show(); - if (rv == nsIFilePicker.returnOK || rv == nsIFilePicker.returnReplace) { - var file = fp.file; - // Get the path as string. Note that you usually won't - // need to work with the string paths. - var path = fp.file.path; - // work with returned nsILocalFile... - } - return path; -} - -exports.promptForFile = promptForFile; -</pre> - -<h3 id="md5.js">md5.js</h3> - -<p>Próximo, crie um outro arquivo no "lib", chamado "md5.js". Copie o código do hashing, e adicione esta linha ao seu fim:</p> - -<pre class="brush: js">exports.hashFile = md5File;</pre> - -<p>O arquivo completo parece com isto:</p> - -<pre class="brush: js">var {Cc, Ci} = require("chrome"); - -//retorna o código hexadecimal de dois dígitos para um byte -function toHexString(charCode) { - return ("0" + charCode.toString(16)).slice(-2); -} - -function md5File(path) { - var f = Cc["@mozilla.org/file/local;1"] - .createInstance(Ci.nsILocalFile); - f.initWithPath(path); - var istream = Cc["@mozilla.org/network/file-input-stream;1"] - .createInstance(Ci.nsIFileInputStream); - // abrindo para leitura - istream.init(f, 0x01, 0444, 0); - var ch = Cc["@mozilla.org/security/hash;1"] - .createInstance(Ci.nsICryptoHash); - // nós queremos usar o algoritmo MD5 - ch.init(ch.MD5); - // isto diz para updateFromStream ler o arquivo todo - const PR_UINT32_MAX = 0xffffffff; - ch.updateFromStream(istream, PR_UINT32_MAX); - // passe false aqui para conseguir os dados binários de volta - var hash = ch.finish(false); - - // converte o hash binário para hex string. - var s = Array.from(hash, (c, i) => toHexString(hash.charCodeAt(i))).join(""); - return s; -} - -exports.hashFile = md5File;</pre> - -<h3 id="main.js">main.js</h3> - -<p>Finalmente, atualizamos o main.js para importar estes dois módulos e usá-los:</p> - -<pre class="brush: js">var filepicker = require("./filepicker.js"); -var md5 = require("./md5.js"); - -require("sdk/ui/button/action").ActionButton({ - id: "show-panel", - label: "Show Panel", - icon: { - "16": "./icon-16.png" - }, - onClick: function() { - console.log(md5.hashFile(filepicker.promptForFile())); - } -});</pre> - -<p>Você pode distribuir estes módulos para outros desenvolvedores, também. Eles podem copia-los em algum lugar do add-on, e inclui-los usando <code>require()</code> do mesmo modo.</p> - -<h3 id="Aprendendo_Mais">Aprendendo Mais</h3> - -<p>Para ver alguns módulos que as pessoas já desenvolveram, veja a página <a href="https://github.com/mozilla/addon-sdk/wiki/Community-developed-modules">community-developed</a>. Para aprender como usar módulos de terceiros em seu próprio código, veja o tutorial<a href="/en-US/Add-ons/SDK/Tutorials/Add_a_Menu_Item_to_Firefox"> adicionando itens de menu</a>.</p> diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/getting_started_(jpm)/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/getting_started_(jpm)/index.html deleted file mode 100644 index 9190e825ab..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/tutorials/getting_started_(jpm)/index.html +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: Começando (jpm) -slug: Mozilla/Add-ons/SDK/Tutorials/Getting_Started_(jpm) -tags: - - Add-on SDK - - JPM -translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Getting_Started_(jpm) ---- -<div class="note"> -<p>O Add-on SDK inclui uma ferramenta de linha de comando que você usa para inicializar, executar, testar, e empacotar add-ons. A ferramenta de linha de comando atual é chamada de jpm, e é baseada no <a href="http://nodejs.org/">Node.js</a>. Ela substitui a ferramenta antiga cfx.</p> - -<p>Você pode usar o jpm do Firefox 38 em diante.</p> - -<p>Este artigo descreve como desenvolver usando jpm.</p> -</div> - -<p>Este tutorial ensina a criação de uma add-on simples usando o SDK.</p> - -<h2 id="Pré-requisitos"><span class="short_text" id="result_box" lang="pt"><span class="hps">Pré-requisitos</span></span></h2> - -<p>Para criar add-ons para Firefox usando o SDK, você precisará:</p> - -<ul> - <li>Firefox versão 38 ou anteriores. Se você precisar trabalhar com versões anteriores do Firefox, você precisará usar a ferramenta cfx. Veja as instruções em <a href="/en-US/Add-ons/SDK/Tutorials/Getting_started">getting started with cfx</a>.</li> - <li>a ferramenta de linha de comando jpm. Veja instruções para <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tools/jpm#Installation">instalação do jpm</a>. Uma vez que você fez isso, <span class="short_text" id="result_box" lang="pt"><span class="hps">você vai</span> <span class="hps">estar a olhar para</span> <span class="hps">um prompt de comando</span><span>.</span></span></li> -</ul> - -<h2 id="Inicializando_um_add-on_vazio">Inicializando um add-on vazio</h2> - -<p>No promp de comando, crie um novo diretório. Navegue até ele, digite <code>jpm init</code>, e tecle enter:</p> - -<pre>mkdir my-addon -cd my-addon -jpm init -</pre> - -<p>Você será instado à fornecer algumas informações para seu add-on: isso será usado para criar o arquivo <a href="/en-US/Add-ons/SDK/Tools/package_json">package.json</a> do seu add-on. Por enquanto, apenas pressione enter para aceitar o padrão para cada propriedade. Para mais informação sobre <code>jpm init</code>, veja o <a href="/en-US/Add-ons/SDK/Tools/jpm#Command_reference">jpm command reference</a>.</p> - -<p>Uma vez que você forneceu um valor ou aceitou o padrão para estas propriedades, será apresentado a você o conteúdo completo do "package.json" e instado a aceitá-lo.</p> - -<h2 id="Implementando_o_add-on">Implementando o add-on</h2> - -<p>Agora você pode escrever o código do add-on. A menos que você mudou o valor de entrada ("main" no package.json), ele vai no arquivo "index.js" na raiz de seu add-on. Este arquivo foi criado para você no passo anterior. Abra-o e adicione o seguinte código:</p> - -<pre class="brush: js">var buttons = require('sdk/ui/button/action'); -var tabs = require("sdk/tabs"); - -var button = buttons.ActionButton({ - id: "mozilla-link", - label: "Visit Mozilla", - icon: { - "16": "./icon-16.png", - "32": "./icon-32.png", - "64": "./icon-64.png" - }, - onClick: handleClick -}); - -function handleClick(state) { - tabs.open("http://www.mozilla.org/"); -} -</pre> - -<div class="note"> -<p>Note que os "pontos de entrada" padrões para "index.js" no jpm, signifca que seu arquivo principal é "index.js", e é encontrado diretamente na raiz do seu add-on.</p> - -<p>No cfx, o ponto de entrada padrão para "main.js", e é localizado no diretório "lib" na raiz no add-on.</p> -</div> - -<p>Salve o arquivo.</p> - -<p>Próximo, crie um diretório chamado "data" na raiz do add-on, e salve estes três ícones no diretório "data":</p> - -<table class="standard-table"> - <tbody> - <tr> - <td><img alt="" src="https://mdn.mozillademos.org/files/7635/icon-16.png" style="height: 16px; width: 16px;"></td> - <td>icon-16.png</td> - </tr> - <tr> - <td><img alt="" src="https://mdn.mozillademos.org/files/7637/icon-32.png" style="height: 32px; width: 32px;"></td> - <td>icon-32.png</td> - </tr> - <tr> - <td><img alt="" src="https://mdn.mozillademos.org/files/7639/icon-64.png" style="height: 64px; width: 64px;"></td> - <td>icon-64.png</td> - </tr> - </tbody> -</table> - -<p>Volte ao promp de comando, digite:</p> - -<pre>jpm run</pre> - -<p>Este é o comando jpm para executar uma nova instância do Firefox com seu add-on instalado.</p> - -<p>Quando o Firefox lança, no canto superior direito do navegador você verá um ícone com o logotipo do Firefox. Clique no ícone, e uma nova tab abrirá com o site <a href="http://www.mozilla.org/" rel="noreferrer">http://www.mozilla.org/</a> carregado.</p> - -<p>Isso é tudo que este add-on faz. Ele usa dois módulos SDK: o módulo <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_action">action button</a>, que lhe permite adicionar botões ao navegador, e o módulo tab, que lhe permite executar operações básicas com o módulo <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs" rel="noreferrer">tabs</a>. Neste caso, nós criamos um botão cujo ícone é o ícone do Firefox, e adicionamos um manipulado de click que carrega a página do Mozilla na nova tab.</p> - -<p><img alt="" src="https://mdn.mozillademos.org/files/7643/mozilla-button.png" style="display: block; height: 221px; margin-left: auto; margin-right: auto; width: 382px;">Tente editar este arquivo. Por exemplo, nós poderíamos mudar a página que está sendo carregada:</p> - -<pre class="brush: js">var buttons = require('sdk/ui/button/action'); -var tabs = require("sdk/tabs"); - -var button = buttons.ActionButton({ - id: "mozilla-link", - label: "Visit Mozilla", - icon: { - "16": "./icon-16.png", - "32": "./icon-32.png", - "64": "./icon-64.png" - }, - onClick: handleClick -}); - -function handleClick(state) { - tabs.open("https://developer.mozilla.org/"); -}</pre> - -<p>No promp de comando, execute <code>jpm run</code> novamente. Desta vez clicando lhe levará para <a href="https://developer.mozilla.org/">https://developer.mozilla.org/</a>.</p> - -<h2 id="Empacotando_o_add-on">Empacotando o add-on</h2> - -<p>Quando você terminou o add-on e estiver preparado para distribui-lo, você precisará empacotá-lo como um arquivo XPI. Esta é a forma instalável dos add-ons do Firefox. Você pode distribuir os arquivos XPI por si mesmo ou publicá-los em <a href="https://addons.mozilla.org" rel="noreferrer">https://addons.mozilla.org</a> então outros usuários podem baixar eles.</p> - -<p>Para construir um XPI, apenas execute o comando <code>jpm xpi</code> do diretório do add-on:</p> - -<pre>jpm xpi -</pre> - -<p>Você deveria ver uma mensagem como:</p> - -<pre>JPM info Successfully created xpi at /path/to/getting-started/@getting-started.xpi -</pre> - -<p>Para testar que isso funciona, tente instalar o arquivo XPI em sua própria instalação do Firefox. Você pode fazer isso pressionando a combinação de teclas Ctrl+O (Cmd+O no Mac) de dentro do Firefox, ou selecionando o menu "Open" do menu "Arquivo" do Firefox. Isso trará uma caixa de diálogo de seleção de arquivo: navegue para o arquivo "@getting-started.xpi", abra-o e siga o prompt para instalar o add-on.</p> - -<h2 id="Resumo">Resumo</h2> - -<p>Neste tutorial nós construímos e empacotamos um add-on usando três comandos:</p> - -<ul> - <li><code>jpm init</code> para inicializar um modelo de add-on vazio</li> - <li><code>jpm run</code> para executar uma nova instância do Firefox com o add-on instalado, então nós testamos ele</li> - <li><code>jpm xpi</code> para empacotar o add-on em um arquivo XPI para distribuição</li> -</ul> - -<p>Há três comandos principais que você usará quando desenvolvendo add-ons com SDK. Há documentação abrangente no <a href="/en-US/Add-ons/SDK/Tools/jpm" rel="noreferrer">reference documentation</a> cobrindo todos os comandos que você pode usar e todas as opções que eles levam.</p> - -<p>O código do add-on por si usa dois módulos SDK, <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_action">action button</a> e <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs" rel="noreferrer">tabs</a>. Há documentação de referência para todas as APIS do SDK tanto as de <a href="/en-US/Add-ons/SDK/High-Level_APIs" rel="noreferrer">alto nível</a> quanto as de <a href="/en-US/Add-ons/SDK/Low-Level_APIs" rel="noreferrer">baixo nível</a>.</p> - -<h2 id="O_que_vem_agora">O que vem agora?</h2> - -<p>Para ter uma ideia das coisas que você pode fazer com as APIs do SDK, tente trabalhar com alguns dos <a href="/en-US/Add-ons/SDK/Tutorials" rel="noreferrer">tutoriais</a>.</p> diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/index.html deleted file mode 100644 index 6d5484bc46..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/tutorials/index.html +++ /dev/null @@ -1,144 +0,0 @@ ---- -title: Tutoriais -slug: Mozilla/Add-ons/SDK/Tutorials -tags: - - Add-on SDK -translation_of: Archive/Add-ons/Add-on_SDK/Tutorials ---- -<p>Esta página lista artigos úteis e práticos sobre como executar tarefas específicas usando o SDK.</p> - -<hr> -<h3 id="Começando">Começando</h3> - -<div class="column-container"> -<div class="column-half"> -<dl> - <dt><a href="/en-US/Add-ons/SDK/Tutorials/Installation">Instalação</a></dt> - <dd>Download, instalar, e inicializar o SDK no Windows, OS X e Linux.</dd> -</dl> - -<dl> - <dt><a href="/en-US/Add-ons/SDK/Tutorials/Troubleshooting">Solução de problemas </a></dt> - <dd>Algumas dicas para resolver problemas comuns e conseguir mais ajuda.</dd> -</dl> -</div> - -<div class="column-half"> -<dl> - <dt><a href="https://developer.mozilla.org/pt-BR/docs/Mozilla/Add-ons/SDK/Tutorials/Come%C3%A7ando">Começando </a></dt> - <dd>Criação passo-a-passo de um add-on simples com o SDK.</dd> -</dl> -</div> -</div> - -<hr> -<h3 id="Criando_interfaces_de_usuário"><a name="create-user-interfaces">Criando interfaces de usuário</a></h3> - -<div class="column-container"> -<div class="column-half"> -<dl> - <dt><a href="https://developer.mozilla.org/pt-BR/docs/Mozilla/Add-ons/SDK/Tutorials/Adding_a_Button_to_the_Toolbar">Adicionando um botão de barra de ferramenta</a></dt> - <dd>Anexe um botão à barra de ferramentas de add-on do Firefox.</dd> - <dt><a href="https://developer.mozilla.org/pt-BR/docs/Mozilla/Add-ons/SDK/Tutorials/Adicionar_uma_item_de_menu_ao_Firefox">Adicione um item de menu ao Firefox</a></dt> - <dd>Adicione itens ao menu principal do Firefox.</dd> -</dl> -</div> - -<div class="column-half"> -<dl> - <dt><a href="https://developer.mozilla.org/pt-BR/docs/Mozilla/Add-ons/SDK/Tutorials/Mostrar_um_Popup">Mostre um popup</a></dt> - <dd>Mostre um diálogo popup implementado com HTML e JavaScript.</dd> - <dt><a href="https://developer.mozilla.org/pt-BR/docs/Mozilla/Add-ons/SDK/Tutorials/Adicione_um_Item_ao_Menu_de_Contexto">Adicione um item ao menu de contexto</a></dt> - <dd>Adicione itens ao menu de contexto do Firefox.</dd> -</dl> -</div> -</div> - -<hr> -<h3 id="Interagindo_com_o_navegador"><a name="interact-with-the-browser">Interagindo com o navegador</a></h3> - -<div class="column-container"> -<div class="column-half"> -<dl> - <dt><a href="https://developer.mozilla.org/pt-BR/docs/Mozilla/Add-ons/SDK/Tutorials/Abra_uma_P%C3%A1gina_Web">Abra uma página</a></dt> - <dd>Abra uma página web em um novo navegador ou janela usando o módulo tabs, e acesse seu conteúdo.</dd> - <dt><a href="https://developer.mozilla.org/pt-BR/docs/Mozilla/Add-ons/SDK/Tutorials/captura_de_carregamento_da_pagina">Observando páginas carregadas</a></dt> - <dd>Use o módulo tabs para conseguir notificação quando novas páginas são carregadas, e acesse seu conteúdo.</dd> -</dl> -</div> - -<div class="column-half"> -<dl> - <dt><a href="https://developer.mozilla.org/pt-BR/docs/Mozilla/Add-ons/SDK/Tutorials/Lista_de_Tabs_Abertas">Capturando a lista de tabs abertas</a></dt> - <dd>Use o módulo tab para interagir pelas tabs atualmente abertas, e acesse seu conteúdo.</dd> -</dl> -</div> -</div> - -<hr> -<h3 id="Modificando_páginas_web"><a name="modify-web-pages">Modificando páginas web</a></h3> - -<div class="column-container"> -<div class="column-half"> -<dl> - <dt><a href="/en-US/Add-ons/SDK/Tutorials/Modifying_Web_Pages_Based_on_URL">Modificar páginas web baseado na URL</a></dt> - <dd>Crie um filtro para páginas web baseado em sua URL: sempre que uma página web cuja URL combinar com o filtro carregado, executa um script espeficado nela.</dd> -</dl> -</div> - -<div class="column-half"> -<dl> - <dt><a href="/en-US/Add-ons/SDK/Tutorials/Modifying_the_Page_Hosted_by_a_Tab">Modificar a página web ativa</a></dt> - <dd>Carrega dinamicamente um script dentro da página web ativa atualmente.</dd> -</dl> -</div> -</div> - -<hr> -<h3 id="Técnicas_de_desenvolvimento"><a name="development-techniques">Técnicas de desenvolvimento</a></h3> - -<div class="column-container"> -<div class="column-half"> -<dl> - <dt><a href="/en-US/Add-ons/SDK/Tutorials/Logging">Restro de log</a></dt> - <dd>Registra mensagens para o console para propósito de diagnóstico.</dd> - <dt><a href="/en-US/Add-ons/SDK/Tutorials/Creating_reusable_modules">Criando módulos reutilizáveis</a></dt> - <dd>Estruture seu add-on em módulos separados deixando mais fácil o desenvolvimento, depuração e manutenção. Crie pacotes reutilizáveis contendo seus módulos, assim outros desenvolvedores de add-on podem usá-los também.</dd> - <dt><a href="/en-US/Add-ons/SDK/Tutorials/Unit_testing">Teste de unidade </a></dt> - <dd>Escrevendo e executando teste de unidade usando framework de teste do SDK.</dd> - <dt><a href="/en-US/Add-ons/SDK/Tutorials/Chrome_authority">Chrome authority </a></dt> - <dd>Conseguindo acesso ao objeto Components, permitindo a seu add-on carregar e usar qualquer objeto XPCOM.</dd> - <dt><a href="/en-US/Add-ons/SDK/Tutorials/Creating_event_targets">Criando event targets </a></dt> - <dd>Permite aos objeto que você define emitir seus próprios eventos.</dd> -</dl> -</div> - -<div class="column-half"> -<dl> - <dt><a href="/en-US/Add-ons/SDK/Tutorials/Listening_for_load_and_unload">Observando load e unload </a></dt> - <dd>Receba notificações quando seu add-on é caregado ou descarregado pelo Firefox, e passa argumentos do seu add-on a partir da linha de comando.</dd> - <dt><a href="/en-US/Add-ons/SDK/Tutorials/Add_a_Menu_Item_to_Firefox">Usando módulos de terceiros</a></dt> - <dd>Instale e use módulos adicionais que não são fornecidos com o SDK.</dd> - <dt><a href="/en-US/Add-ons/SDK/Tutorials/l10n">Localização </a></dt> - <dd>Escrever código localizável.</dd> - <dt><a href="/en-US/Add-ons/SDK/Tutorials/Mobile_development">Desenvolvimento mobile</a></dt> - <dd>Develop add-ons for Firefox Mobile on Android.</dd> - <dt><a href="/en-US/Add-ons/Add-on_Debugger">Depuração do Add-on</a></dt> - <dd>Depure o JavaScript do seu add-on.</dd> -</dl> -</div> -</div> - -<hr> -<h3 id="Colocando_tudo_junto"><a name="putting-it-together">Colocando tudo junto</a></h3> - -<div class="column-container"> -<div class="column-half"> -<dl> - <dt><a href="/en-US/Add-ons/SDK/Tutorials/Annotator">Add-on Annotator</a></dt> - <dd>Um guia para um add-on relativamente complexo.</dd> -</dl> -</div> -</div> - -<p> </p> diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/l10n/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/l10n/index.html deleted file mode 100644 index 4a762bda9b..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/tutorials/l10n/index.html +++ /dev/null @@ -1,380 +0,0 @@ ---- -title: Localização -slug: Mozilla/Add-ons/SDK/Tutorials/l10n -tags: - - Add-on SDK - - Localização -translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/l10n ---- -<p>O SDK suporta localização de strings que aparecem no:</p> - -<ul> - <li><a href="/en-US/Add-ons/SDK/Tutorials/l10n#Using_Localized_Strings_in_JavaScript">o código JavaScript principal do seu add-on</a></li> - <li><a href="/en-US/Add-ons/SDK/Tutorials/l10n#Using_Localized_Strings_in_HTML">arquivos HTML empacotados com seu add-on</a></li> - <li><a href="/en-US/Add-ons/SDK/Tutorials/l10n#Using_Localized_Strings_in_Preferences">os campos <code>title</code> e <code>description</code> das preferências do seu add-on's</a>.</li> -</ul> - -<p>Ele, ainda, não suporta localização de conteúdo CSS ou Scripts.</p> - -<h2 id="Strings_de_Localização">Strings de Localização</h2> - -<p>Strings traduzidas são mantidas em um diretório chamado "locale" no diretório principal do seu add-on, um arquivo para cada locale. Os arquivos:</p> - -<ul> - <li>use o formato <a href="http://en.wikipedia.org/wiki/.properties"><code>.properties</code></a></li> - <li>são chamados "xx-YY.properties", onde "xx-YY" é o nome da<a href="https://wiki.mozilla.org/L10n:Locale_Codes"> localidade</a> em questão</li> - <li>contém uma entrada para cada string que você quer localizar, consistindo de um identificador para a string e sua tradução para aquela localidade, no formado <code>identificador=tradução</code>.</li> - <li>precisa usar UTF-8 sem codificação BOM</li> -</ul> - -<p>Suponha que seu add-on contém uma única string localizável, representada em Inglês como "Hello!", e você quer suprir com localizações US English e Francês.</p> - -<p>Você adiciona dois arquivos ao diretório "locale":</p> - -<pre>my-addon/ - data - lib - locale/ - en-US.properties - fr-FR.properties -</pre> - -<p>"en-US.properties" contém isto:</p> - -<pre>hello_id= Hello! -</pre> - -<p>"fr-FR.properties" contém isto:</p> - -<pre>hello_id= Bonjour ! -</pre> - -<p>Agora que sempre que em seu código JavaScript ou HTML pedir ao sistema de localização pela tradução do identificador <code>hello_id</code>, ele pegará a tradução correta para a localidade atual.</p> - -<h2 id="Usando_Strings_de_Localização_no_HTML">Usando Strings de Localização no HTML</h2> - -<div class="note"> -<p>Este exemplo usa a API <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_action">action button</a>, que está disponível somente do Firefox 29 em diante.</p> -</div> - -<p>Para referenciar uma string localizada do HTML, adicione um atributo <code>data-l10n-id</code> à tag HTML onde você quiser que a string localizada apareça, e atribua o identificador a ele:</p> - -<pre class="brush: html"><html> - <body> - <h1 data-l10n-id="hello_id"></h1> - </body> -</html> -</pre> - -<p>Então você pode usar o arquivo HTML para construir sua interface, por exemplo dentro de um painel:</p> - -<pre class="brush: js">var button = require("sdk/ui/button/action").ActionButton({ - id: "localized-hello", - label: "Localized hello", - icon: "./icon-16.png", - onClick: function() { - hello.show(); - } -}); - -var hello = require("sdk/panel").Panel({ - height: 75, - width: 150, - contentURL: require("sdk/self").data.url("my-panel.html") -});</pre> - -<p>Dados os arquivos locale para "en-US" e "fr-FR" que fornece uma tradução para o <code>hello_id</code>, o painel agora mostrará o "Hello!" ou "Bonjour !", de acordo com a localidade atual:</p> - -<p><img alt="" src="https://mdn.mozillademos.org/files/7663/bonjour.png" style="height: 160px; width: 255px;"><img alt="" src="https://mdn.mozillademos.org/files/7665/hello.png" style="height: 160px; width: 255px;"></p> - -<p>A tradução é inserida dentro do nó que tem o atributo<code> data-l10n-id</code>. Qualquer conteúdo anteriormente existente é substituído.</p> - -<p>A string é inserida como texto, então você não pode inserir HTML usando declarações como:</p> - -<pre>hello_id= <blink>Hello!</blink> -</pre> - -<h3 id="Localizando_Atributos_de_Elementos">Localizando Atributos de Elementos</h3> - -<div class="geckoVersionNote">Esta característica é nova no Firefox 39</div> - -<p><br> - Você pode localizar certos atributos de elementos com um l10n-id configurando seu valor com o l10-id.attributeName no arquivo da propriedade como isto:</p> - -<pre>hello_id.accesskey= H</pre> - -<p>Os seguintes atributos são suportados:</p> - -<ul> - <li><strong>accesskey</strong></li> - <li><strong>alt</strong></li> - <li><strong>label</strong></li> - <li><strong>title</strong></li> - <li><strong>placeholder</strong></li> -</ul> - -<p><span id="result_box" lang="pt"><span class="hps">Além disso, a</span> <span class="hps">localização do</span>s atributos <span class="hps">ARIA</span> <span class="hps">aria</span><span>-label,</span> <span class="hps">aria</span><span class="atn">-</span><span>valuetext</span> <span class="hps">e</span> <span class="hps">aria</span><span class="atn">-</span><span>moz</span><span class="atn">-</span><span>dica</span> <span class="hps">são suportados</span> <span class="hps">com os mesmos</span> apelidos que <span class="hps">no</span> <span class="hps">Firefox</span> <span class="hps">OS</span><span>:</span></span></p> - -<ul> - <li><strong>ariaLabel</strong></li> - <li><strong>ariaValueText</strong></li> - <li><strong>ariaMozHint</strong></li> -</ul> - -<h2 id="Usando_Strings_de_Localização_no_JavaScript">Usando Strings de Localização no JavaScript</h2> - -<p>Para referenciar Strings de Localização do código principal do seu add-on, você faz isso:</p> - -<pre class="brush: js">var _ = require("sdk/l10n").get; -console.log(_("hello_id!"));</pre> - -<p><span>A atribuição de "_" em particular não é requerida, mas é uma convenção da ferramente <a href="https://www.gnu.org/software/gettext/gettext.html">gettext </a>e torna possível trabalhar com ferramentas existentes que esperam "_" para indicar Strings de Localização.</span></p> - -<ol> - <li>Importe o módulo <code>l10n</code>, atribua sua função <code>get</code> o "<code>_</code>" (underscore).</li> - <li>Envolva todas as referências a Strings de Localização com uma função <code>_()</code>.</li> -</ol> - -<p>Se você executar ela você verá a saída esperada para a localidade atual:</p> - -<pre>info: Hello! -</pre> - -<pre>info: Bonjour ! -</pre> - -<p>Observe que você não pode <code>require()</code> módulos nos scripts de conteúdo, você ainda não pode referenciar strings de localização nos scripts de conteúdo.</p> - -<h3 id="Plurais">Plurais</h3> - -<p>O módulo <code>l10n</code> suporta formas plurais. Diferentes línguas tem diferentes regras para formação de plurais. Por exemplo, Inglês tem duas formas: uma forma singular para "one", e uma forma plural para "everything else, including zero":</p> - -<pre>one tomato -no tomatoes -two tomatoes -</pre> - -<p>Mas a Russa tem diferentes formas para números terminados em 1 (exceto 11), números terminados em 2-4 (exceto 12-14) e outros números:</p> - -<pre>один помидор // one tomato -два помидора // two tomatoes -пять помидоров // five tomatoes -</pre> - -<p>O SDK usa dados do <a href="http://cldr.unicode.org/index">Unicode CLDR</a> para descrever as diferentes formas de plural usadas pelas diferentes línguas.</p> - -<h4 id="Formas_Plurais_do_Unicode_CLDR">Formas Plurais do Unicode CLDR</h4> - -<p>O projeto Unicode CLDR define um esquema que descreve a regras de plural de uma língua em particular. Neste esquema uma língua mapeia cada abrangência distinta de números para um ou mais formas, identificado pelas categorias: <em>zero, one, two, few, many, </em>e <em>other</em>.</p> - -<p>Inglês tem duas formas, que podem ser descritas pelo mapeamento "1" para "one" e "everything else" para "other":</p> - -<pre>one → n is 1; -other → everything else -</pre> - -<p>A Russa usa quatro formas, que podem ser descritas como se segue:</p> - -<pre>one → n mod 10 is 1 and n mod 100 is not 11; -few → n mod 10 in 2..4 and n mod 100 not in 12..14; -many → n mod 10 is 0 or n mod 10 in 5..9 or n mod 100 in 11..14; -other → everything else -</pre> - -<p>As regras de plural para todas as línguas podem ser encontrada na página de <a href="http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html">Regras para Plural das Línguas</a> do CLDR (embora esta tabela esteja desatualizada se comparada com a <a href="http://unicode.org/repos/cldr/trunk/common/supplemental/plurals.xml">CLDR XML source</a>).</p> - -<h4 id="Formas_Plurais_no_SDK">Formas Plurais no SDK</h4> - -<p>No código, você fornece uma parâmetro extra ao lado do identificador, descrevendo quantos itens há:</p> - -<pre class="brush: js">var _ = require("sdk/l10n").get; -console.log(_("tomato_id")); -console.log(_("tomato_id", 1)); -console.log(_("tomato_id", 2)); -console.log(_("tomato_id", 5)); -console.log(_("tomato_id", .5));</pre> - -<p>No arquivo <code>.properties</code> para cada língua você pode definir uma localização diferente para cada forma de plural possível naquela língua, usando palavras reservadas do CLDR. Então no Inglês nós teríamos duas localizações de plural (observe que a categoria "other" <strong>não</strong> leva palavra reservada do CLDR:</p> - -<pre># en-US translations -tomato_id[one]= %d tomato -tomato_id= %d tomatoes -</pre> - -<p>Na Russa nós teríamos quatro localizações de plural:</p> - -<pre># ru-RU translations -tomato_id[one]= %d помидор -tomato_id[few]= %d помидора -tomato_id[many]= %d помидоров -tomato_id= %d помидоры -</pre> - -<p>O módulo de localização por si só entende as definições CLDR para cada língua, permitindo a ele mapear, por exemplo, "2" no código e "few" no arquivo <code>ru-RU.properties</code>. Então ele pega e retorna a localização apropriada para a contagem fornecida.</p> - -<h3 id="Placeholders">Placeholders</h3> - -<p>O módulo <code>l10n</code> suporta placeholders, permitindo a você inserir uma string que não deveria ser localizada em uma que é. Os seguintes arquivos "en-US" e "fr-FR" ".properties" estão incluídos placeholders:</p> - -<pre># en-US translations -hello_id= Hello <strong>%s</strong>! -</pre> - -<pre># fr-FR translations -hello_id= Bonjour <strong>%s</strong> ! -</pre> - -<p>Para usar placeholders, forneça uma string placeholder depois do identificador:</p> - -<pre class="brush: js">var _ = require("sdk/l10n").get; -console.log(_("hello_id", "Bob")); -console.log(_("hello_id", "Alice"));</pre> - -<p>Na localidade Inglês "en-US", isto nos é dado:</p> - -<pre>info: Hello Bob! -info: Hello Alice! -</pre> - -<p>No "fr-FR" nós conseguimos:</p> - -<pre>info: Bonjour Bob ! -info: Bonjour Alice ! -</pre> - -<h3 id="Ordenando_Placeholders">Ordenando Placeholders</h3> - -<p>Quando strings localizáveis podem levar dois ou mais placeholders, tradutores podem definir a ordem em que placeholders são inseridos, sem afetar o código.</p> - -<p>Primeiramente, isto é importante porque diferentes línguas tem regras diferentes para ordernar palavras. Mesmo dentro de uma mesma língua, embora traduzida, tradutores deve ter liberdade para definir a ordem.</p> - -<p>Por exemplo, suponha que nós queremos incluir uma string de localização designando a cidade de uma pessoa. Há dois placeholders: o nome da pessoa e o nome da cidade em que ela reside:</p> - -<pre class="brush: js">var _ = require("sdk/l10n").get; -console.log(_("home_town_id", "Bob", "London"));</pre> - -<p>An English translator might want to choose between the following:</p> - -<pre>"<town_name> is <person_name>'s home town." -</pre> - -<pre>"<person_name>'s home town is <town_name>" -</pre> - -<p>Para escolher a primeira opção, o arquivo<code> .properties</code> pode ordenar o placeholders como:</p> - -<pre>home_town_id= %2s is %1s's home town. -</pre> - -<p>Isso nos dá a seguinte saída:</p> - -<pre>info: London is Bob's home town. -</pre> - -<h2 id="Usando_Strings_de_localização_em_Preferências">Usando Strings de localização em Preferências</h2> - -<p>Pela inclusão de uma estrutura <a href="/en-US/Add-ons/SDK/High-Level_APIs/simple-prefs"><code>"preferences"</code> no arquivo "package.json" do seu add-on</a>, você pode definir preferências para seu add-on que o usuário pode ver e editar usando o <a href="https://support.mozilla.org/en-US/kb/Using%20extensions%20with%20Firefox#w_how-to-change-extension-settings">gerenciador de add-ons </a>do Firefox.</p> - -<p>Preferências tem um campo <code>title</code> obrigatório e um campo <code>description</code> opcional. Há strings que aparecem ao lado da preferência no gerenciador de Add-on, para ajudar a explicar ao usuário o que a preferência significa.</p> - -<ul> - <li> - <p>Para fornecer formas localizadas do title da preferência, inclua uma entrada no arquivo "properties" cujo identificador seja o nome da preferência seguido por <code>_title</code>, e cujo valor é o título da localidade.</p> - </li> - <li> - <p>Para fornecer forma localizada da descrição da preferência, inclui uma entrada em seu arquivo "properties" cujo identificador é o nome da preferência seguido por <code>_description</code>, e cujo valor é a descrição da localidade.</p> - </li> -</ul> - -<p>Por exemplo, suponha que seu "package.json" defina uma única preferência:</p> - -<pre>{ - "preferences": [ - { - "type": "string", - "name": "monster_name", - "value": "Gerald", - "title": "Name" - } - ], - "name": "monster-builder", - "license": "MPL 2.0", - "author": "me", - "version": "0.1", - "fullName": "Monster Builder", - "id": "monster-builder@me.org", - "description": "Build your own monster" -} -</pre> - -<p>Em seu arquivo "en-US.properties", inclua estes dois itens:</p> - -<pre>monster_name_title= Name -monster_name_description= What is the monster's name? -</pre> - -<p>Em seu arquivo "fr-FR.properties", inclui a tradução francesa:</p> - -<pre>monster_name_title= Nom -monster_name_description= Quel est le nom du monstre ? -</pre> - -<p>Agora quando o local do navegador estiver configurado para "en-US", os usuários verão este Gerenciador de Add-on:</p> - -<p><img alt="" src="https://mdn.mozillademos.org/files/6525/preference-us.png" style="height: 77px; width: 571px;"></p> - -<p>Quando o local do navegador estiver configurado para "fr-FR", eles verão isto:</p> - -<p><img alt="" src="https://mdn.mozillademos.org/files/6523/preference-french.png"></p> - -<p>Os tipos de preferência de <code>menulist</code> e <code>radio</code> tem opções. O atributo <code>label</code> de cada opção é mostrado para o usuário. Se o arquivo de local tem uma entrada com o valor do atributo <code>label</code> prefixado com "{name}_options." como sua chave, onde {name} é o nome da preferência, seu valor é usado como rótulo por localização.</p> - -<h2 id="Usando_identificadores">Usando identificadores</h2> - -<p>Se o sistema de localização não pode encontrar uma entrada para um identificador em particular usando a localidade atual, então ele apenas retorna o identificador por si mesmo.</p> - -<p>Isto tem a bonita propriedade que você pode escrever add-on localizável, inteiramente funcional sem ter que escrever qualquer arquivo local. Você pode usar somente a linguagem padrão como seu identificador, e subsequentemente fornecer arquivos <code>.properties</code> para todos os locais adicionais que você quiser suportar.</p> - -<p>Por exemplo, no caso acima você poderia usar "Hello!" como o identificador, e apenas ter um arquivo <code>.properties</code> para a localidade "fr-FR":</p> - -<pre>Hello!= Bonjour ! -</pre> - -<p>Então quando a localidade é "en-US", o sistema falharia ao encontrar o arquivo <code>.properties</code> file, e retornaria "Hello!".</p> - -<p>Porém, essa técnica torna difícil manter um add-on que tem muitas localizações, porque você estará usando a língua padrão tanto para strings de interface quanto chaves de tradução. Isto significa que se você quiser mudar o nome de uma string na língua padrão, ou consertar a digitação, então você quebrará todos os seus arquivos de tradução.</p> - -<h2 id="Locale_Updater">Locale Updater</h2> - -<p>O addon <a href="https://github.com/downloads/ochameau/locale-updater/locale-updater.xpi">locale updater</a> torna fácil atualizar arquivos de localidade. Uma vez que você o instalou, abra o Gerenciador de Add-on, e você verá um novo botão rotulado "Update l10n" próximo a cada add-on que você instalou:</p> - -<p><img alt="" src="https://mdn.mozillademos.org/files/6515/locale-updater.png"></p> - -<p>Clique no botão e você será instado a enviar um arquivo <code>.properties</code> para aquele add-on. Se você fornecer um novo arquivo, o locale do add-on será atualizado com o novo arquivo.</p> - -<h2 id="Limitações">Limitações</h2> - -<p>A localização atual suportada é o primeiro passo ao inteiro suporte, e contem uma série de limitações.</p> - -<ul> - <li> - <p>Não há suporte para scripts de conteúdo ou arquivos CSS: no momento, você pode localizar strings que aparecem nos arquivos JavaScript que podem <code>require()</code> módulos SDK e em HTML.</p> - </li> - <li> - <p>A configuração dos arquivos de localidade é global por um add-on. Isto significa que um módulo não pode sobreescrever uma tradução mais geral: então um módulo <code>informal.js</code> não pode especificar que "hello_id" ocorrendo em seu código deveria ser traduzida para "Hi!".</p> - </li> - <li> - <p>A ferramenta SDK compila os arquivos de localidade em um formato JSON quando produzindo um XPI. Isso significa que traduções não podem localizar um add-on dando o XPI sozinho, mas deve ser dado acesso ao fonte do add-on.</p> - </li> - <li> - <p>O desenvolvedor deve manualmente montar o conjunto de strings localizáveis compõe os arquivos de localidade.</p> - </li> -</ul> - -<h2 id="Veja_também_-_para_desenvolvedores_que_localização_em_add-on_que_não_são_do_SDK">Veja também - para desenvolvedores que localização em add-on que não são do SDK</h2> - -<ul> - <li>Como colocar localização em páginas html, arquivos xul, e arquivos js/jsm do add-on bootstrapped: <a href="/en-US/Add-ons/Bootstrapped_extensions#Localization_%28L10n%29">Bootstrapped Extensions :: Localization (L10n)</a></li> - <li>XUL School Localization Tutorial: <a href="/en-US/docs/Mozilla/Tech/XUL/Tutorial/Localization">DTD/Entities method</a> and <a href="/en-US/docs/Mozilla/Tech/XUL/Tutorial/Property_Files">Properties method</a></li> - <li><a href="/en-US/docs/Mozilla/Localization/Localizing_an_extension">Localizing an extension</a></li> -</ul> diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/lista_de_tabs_abertas/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/lista_de_tabs_abertas/index.html deleted file mode 100644 index d3d537037d..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/tutorials/lista_de_tabs_abertas/index.html +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: Lista de Tabs Abertas -slug: Mozilla/Add-ons/SDK/Tutorials/Lista_de_Tabs_Abertas -tags: - - Add-on SDK - - Listando tabs abertas -translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/List_Open_Tabs ---- -<div class="note"> -<p>Para seguir este tutorial você precisará ter <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Installation">instalado o SDK </a>e ter conhecimento <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_Started_With_cfx">básico sobre cfx</a>.</p> - -<p>Este tutorial usa a API <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_action">action button</a>, que está disponível somente do Firefox 29 em diante.</p> -</div> - -<p>Para listar as tabs abertas, você pode iterar sobre o objeto <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs"><code>tabs</code></a>.</p> - -<p>O add-on a seguir adiciona um <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_action">action button</a> que registra as URLs abertas nas tabs quando clicado:</p> - -<pre class="brush: js">require("sdk/ui/button/action").ActionButton({ - id: "list-tabs", - label: "List Tabs", - icon: "./icon-16.png", - onClick: listTabs -}); - -function listTabs() { - var tabs = require("sdk/tabs"); - for (let tab of tabs) - console.log(tab.url); -} -</pre> - -<p>Note que para fazer isso funcionar você precisa salvar um ícone para o botão no diretório "data" do seu add-on como "icon-15.png": você pode baixar o ícone daqui: <img alt="" src="https://mdn.mozillademos.org/files/7649/icon-16.png" style="height: 16px; width: 16px;">.</p> - -<p>Se você executar o add-on, carregar um grupo de tabs, e clicar no botão, você verá a saída no linha de comando do <a href="/en-US/Add-ons/SDK/Tutorials/Logging">console</a> que parece com isto:</p> - -<pre>info: http://www.mozilla.org/en-US/about/ -info: http://www.bbc.co.uk/ -</pre> - -<p>Você não consegue acesso direto a qualquer conteúdo hospedado na tab. Para acessar o conteúdo da tab você precisa anexar um script à tab usando <code>tab.attach()</code>. Este add-on anexa um script a todas as tabs abertas. O script adiciona uma borda vermelha ao documento da tab:</p> - -<pre class="brush: js">require("sdk/ui/button/action").ActionButton({ - id: "list-tabs", - label: "List Tabs", - icon: "./icon-16.png", - onClick: listTabs -}); - -function listTabs() { - var tabs = require("sdk/tabs"); - for (let tab of tabs) - runScript(tab); -} - -function runScript(tab) { - tab.attach({ - contentScript: "document.body.style.border = '5px solid red';" - }); -} -</pre> - -<h2 id="Aprendendo_Mais">Aprendendo Mais</h2> - -<p>Para aprender mais sobre como trabalhar com tabs no SDK, veja a referência da API <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs"><code>tabs</code></a>.</p> - -<p>Para aprender mais sobre execução de scripts em tabs, veja o tutorial sobre uso do <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs#attach(options)"><code>tab.attach()</code></a>.</p> diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/listening_for_load_and_unload/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/listening_for_load_and_unload/index.html deleted file mode 100644 index 5e3818036f..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/tutorials/listening_for_load_and_unload/index.html +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: Capturando Load e Unload -slug: Mozilla/Add-ons/SDK/Tutorials/Listening_for_load_and_unload -translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Listening_for_load_and_unload ---- -<div class="note"> -<p><span>Para seguir este tutorial você precisará ter conhecimento <a href="/en-US/docs/Mozilla/Add-ons/SDK/Tutorials/Getting_Started_%28jpm%29">básico de <code>jpm</code></a>. </span></p> -</div> - -<p>Se seu add-on exporta uma função chamada <code>main()</code>, então aquela função será chamada sempre que o add-on for carregado, e será passada uma string descrevendo a razão de ele ter sido carregado bem como qualquer argumento passado para ele. Se seu add-on exporta uma função chamada <code>onUnload()</code>, então esta função será chamada quando o add-on for descarregado, e será passada uma string descrevendo a razão da descarga.</p> - -<p>Você não tem que usar <code>exports.main()</code> ou <code>exports.onUnload()</code>. Você pode colocar o código do seu add-on no nível superior ao invés de envolver ele em uma atribuição de função para <code>exports.main()</code>. Ele será carregado nas mesmas circunstâncias, mas você não conseguirá acesso às razões da carga ou descarga dele bem como de seus argumentos.</p> - -<h2 id="exports.main()">exports.main()</h2> - -<p>O código <code>main.js</code> do seu add-on é executado assim que ele é carregado. Ele é carregado quando ele é instalado, habilitado ou quando inicia o Firefox.</p> - -<p>Se seu add-on exporta uma função chamada <code>main()</code>, aquela função será chamada imediatamente depois que o <code>main.js </code>esteja completamente avaliado, e depois de todas as declarações <code>require()</code> de nível superior serem executadas (então geralmente depois de todas módulos dependentes serem carregados).</p> - -<div> -<div> -<pre><span class="brush: js">exports.main = function (options, callbacks) {};</span></pre> -</div> -</div> - -<p><code>options</code> é um objeto descrevendo os parâmetros com os quais seu add-on foi carregado</p> - -<h3 id="options.loadReason">options.loadReason</h3> - -<p><code>options.loadReason</code> é uma das seguintes strings descrevendo a razão de seu add-on ter sido carregado:</p> - -<pre>install -enable -startup -upgrade -downgrade -</pre> - -<h2 id="exports.onUnload()">exports.onUnload()</h2> - -<p>Se seu add-on exporta uma função chamada <code>onUnload()</code>, aquela função será chamando quando o add-on for descarregado.</p> - -<div> -<div> -<pre><span class="brush: js">exports.onUnload = function (reason) {};</span></pre> -</div> -</div> - -<h3 id="reason">reason</h3> - -<p><code>reason</code> é uma das seguintes strings descrevendo a razão do add-on ter sido descarregado:</p> - -<pre>uninstall -disable -shutdown -upgrade -downgrade -</pre> - -<p>Devido ao <a href="https://bugzilla.mozilla.org/show_bug.cgi?id=627432">bug 627432</a>, sua captura de descarga (<code style="font-size: 14px;">onUnload</code>) nunca será chamada com <code style="font-size: 14px;">uninstall</code>: ela somente é chamada com <code style="font-size: 14px;">disable</code>. Veja no comentário particular sobre este <a href="https://bugzilla.mozilla.org/show_bug.cgi?id=627432#c12">bug</a>.</p> diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/logging/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/logging/index.html deleted file mode 100644 index 088d694408..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/tutorials/logging/index.html +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: Logging -slug: Mozilla/Add-ons/SDK/Tutorials/Logging -tags: - - Add-on SDK - - console -translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Logging ---- -<div class="note">Para seguir este tutorial você precisa do <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Installation">SDK instalado</a> e <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_Started_With_cfx">conhecimento básico de cfx</a>.</div> - -<p>O objeto DOM <a href="https://developer.mozilla.org/en/DOM/console"><code>console</code></a> é útil para depuração do JavaScript. Porque os objetos DOM não estão disponíveis para o código principal do add-on, o SDK fornece seu próprio objeto global <code>console</code> com a maiorira dos mesmos métodos do do <code>console </code>DOM, incluindo métodos para registrar erros, avisos, ou mensagens informativas. Você não tem que usar <code>require()</code> qualquer coisa para conseguir acesso ao console. Ele está disponível para você.</p> - -<p>O método <code>console.log()</code> imprime mensagens informativas:</p> - -<pre class="brush: js">console.log("Hello World"); -</pre> - -<p>Tente:</p> - -<ul> - <li>crie um novo diretório, e navegue até ele</li> - <li>execute <code>cfx init</code></li> - <li>abra "lib/main.js" e adicione a linha acima</li> - <li>execute <code>cfx run</code>, então <code>cfx run</code> novamente</li> -</ul> - -<p>O Firefox iniciará, e a linha a seguir aparecerá na janela de comando que você usou para executar <code>cfx run</code>:</p> - -<pre>info: Hello World! -</pre> - -<h2 id="console_em_Scripts_de_Conteúdo"><code>console</code> em Scripts de Conteúdo</h2> - -<p>Você pode usar console em <a href="/en-US/Add-ons/SDK/Guides/Content_Scripts">scripts de conteúdo</a> assim como no código principal do seu add-on. O add-on a seguir registra o conteúdo do HTML de toda a tab que o usuário carregar, chamando <code>console.log()</code> dentro do script de conteúdo:</p> - -<pre class="brush: js">require("sdk/tabs").on("ready", function(tab) { - tab.attach({ - contentScript: "console.log(document.body.innerHTML);" - }); -}); -</pre> - -<h2 id="Saída_do_console">Saída do <code>console</code></h2> - -<p>Se você estiver executando seu add-on da linha de comando (por exemplo, executando<code> cfx run</code> ou <code>cfx test</code>) então as mensagens do console aparece no shell de comando usado.</p> - -<p>Se você instalou o add-on no Firefox então as mensagens aparecerão no <a href="/en-US/docs/Tools/Browser_Console">Console do Navegador</a> do Firefox.</p> - -<p>Mas note que <strong>por padrão, chamadas à <code>console.log()</code> não resultarão em qualquer saída no Console de Erro por qualquer add-on instalado</strong>: isso inclui add-ons instalados usando o Add-on Builder ou usando ferramentas como <a href="https://addons.mozilla.org/en-US/firefox/addon/autoinstaller/">Extension Auto-installer</a>.</p> - -<p>Veja <a href="/en-US/Add-ons/SDK/Tools/console#Logging_Levels">"Logging Levels"</a> na documentação de referência para mais informações.</p> - -<h2 id="Aprendendo_Mais">Aprendendo Mais</h2> - -<p>Para a API completa do <code>console</code>, veja sua <a href="/en-US/Add-ons/SDK/Tools/console">referência da API</a>.</p> diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/modifying_the_page_hosted_by_a_tab/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/modifying_the_page_hosted_by_a_tab/index.html deleted file mode 100644 index 6b8f02c265..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/tutorials/modifying_the_page_hosted_by_a_tab/index.html +++ /dev/null @@ -1,137 +0,0 @@ ---- -title: Modificando a Página Aberta em uma Tab -slug: Mozilla/Add-ons/SDK/Tutorials/Modifying_the_Page_Hosted_by_a_Tab -tags: - - Add-on SDK -translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Modifying_the_Page_Hosted_by_a_Tab ---- -<div class="note"> -<p>Para seguir este tutorial, você precisará ter <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Installation">instalado add-on SDK</a> e ter conhecimento <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_Started_(jpm)">básico jpm</a> (Firefox 38 em diante) ou <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_Started_With_cfx">básico do cfx</a> .</p> - -<p>Este tutorial usa a API <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_action">action button</a>, que está disponível a partir do Firefox 29 em diante.</p> -</div> - -<p>Para modificar uma página armazenada em uma tab em particular, carregue um ou mais <em>scripts de conteúdo</em> dentro dela usando o método attach() do objeto <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs">tab</a>. A tarefa desses scripts é interagir com o conteúdo web.</p> - -<p>Aqui está um exemplo simples:</p> - -<pre class="brush: js">var button = require("sdk/ui/button/action").ActionButton({ - id: "style-tab", - label: "Style Tab", - icon: "./icon-16.png", - onClick: function() { - require("sdk/tabs").activeTab.attach({ - contentScript: 'document.body.style.border = "5px solid red";' - }); - } -});</pre> - -<p>Execute esse exemplo, salve o ícone chamado "icon-16.png" no diretório "data" do add-on. Você To run this example, save an icon file named "icon-16.png" in add-on's "data" directory. Você pode baixar este ícone: <img alt="" src="https://mdn.mozillademos.org/files/7661/icon-16.png" style="height: 16px; width: 16px;">.</p> - -<p>This add-on creates a button with Mozilla favicon as an icon. It has a click handler which fetches the active tab and loads a script into the page hosted by the active tab. The script is specified using the <code>contentScript</code> option, and just draws a red border around the page.</p> - -<p>Then open any web page in the browser window, and click the button . You should see a red border appear around the page, like this:</p> - -<p><img alt="" src="https://mdn.mozillademos.org/files/6531/tabattach-bbc.png" style="display: block; margin-left: auto; margin-right: auto;"></p> - -<h2 id="Mantendo_o_script_de_conteúdo_em_arquivo_separado">Mantendo o script de conteúdo em arquivo separado</h2> - -<p>No exemplo acima, nós passamos o script de conteúdo como uma string.</p> - -<p>A menos que o script seja extremamente simples, o melhor é manter o script em um arquivo separado no diretório <code>data</code> do add-on. Isso deixa o código mais fácil para manter, depurar, e revisar. Faça isto, forneça a opção <code>contentScriptFile</code> não <code>contentScript</code>, cujo valor é uma URL apontando para um ou mais arquivos de script de conteúdo.</p> - -<p>Por exemplo, se nós salvarmos o script acima no diretório data do add-on em um arquivo chamado my-script.js:</p> - -<pre class="brush: js">var self = require("sdk/self"); - -var button = require("sdk/ui/button/action").ActionButton({ - id: "style-tab", - label: "Style Tab", - icon: "./icon-16.png", - onClick: function() { - require("sdk/tabs").activeTab.attach({ - contentScriptFile: self.data.url("my-script.js") - }); - } -}); -</pre> - -<p>Você pode carregar mais de um script, e os scripts podem interagir diretamente um com o outro. Então você pode carregar o <a href="http://jquery.com/">jQuery</a>, e então seu script de conteúdo pode usá-lo.</p> - -<h2 id="Carregue_vários_arquivos_de_script_de_conteúdo">Carregue vários arquivos de script de conteúdo</h2> - -<p>O dado atribuído ao <code>contentScriptFile</code> pode ser um array. Os scripts serão carregados na mesma ordem em que estiverem no array.</p> - -<p>No exemplo a seguir, nós carregaremos dois scripts, <code>first.js</code> & <code>second.js</code>. Ambos serão executados no mesmo contexto, então tudo publicamente definido no <code>first.js</code> será acessível do <code>second.js</code>.</p> - -<pre class="brush: js">// lib/main.js - -var self = require("sdk/self"); -var tabs = require("sdk/tabs"); - -require("sdk/ui/button/action").ActionButton({ - id: "load-several", - label: "load several scripts", - icon: "./icon-16.png", - onClick: function () { - tabs.activeTab.attach({ - contentScriptFile: [self.data.url('first.js'), - self.data.url('second.js')] - }); - } -}); -</pre> - -<h2 id="Comunicando_com_o_script_de_conteúdo">Comunicando com o script de conteúdo</h2> - -<p>O script do seu add-on e os scripts de conteúdo não podem acessar diretamente as variáveis ou funções um do outro, mas eles podem trocar mensagens.</p> - -<p>Para enviar mensagens de um lado para o outro, são usados o emitente de chamadas <code>port.emit()</code> e o recebendor <code>port.on()</code>.</p> - -<ul> - <li>No script de conteúdo, <code>port</code> é uma propriedade global do objeto <code>self</code>.</li> - <li>No script do add-on, <code>tab.attach()</code> retorna um objeto <a href="/en-US/Add-ons/SDK/Low-Level_APIs/content_worker">worker</a> contendo a propriedade <code>port</code> que você usa para enviar mensagens ao script de conteúdo.</li> -</ul> - -<p>Vamos reescrever o exemplo acima para passar mensagens de um add-on para o script de conteúdo.</p> - -<p>O script de conteúdo agora precisa parecer com isto:</p> - -<pre class="brush: js">// "self" é um objeto global no script de conteúdo -// Espera por um "drawBorder" -self.port.on("drawBorder", function(color) { - document.body.style.border = "5px solid " + color; -}); -</pre> - -<p>No script do add-on, nós enviaremos ao script de conteúdo uma mensagem "drawBorder" usando o objeto retornado de <code>attach()</code>:</p> - -<pre class="brush: js">var self = require("sdk/self"); -var tabs = require("sdk/tabs"); - -var button = require("sdk/ui/button/action").ActionButton({ - id: "style-tab", - label: "Style Tab", - icon: "./icon-16.png", - onClick: function() { - var worker = tabs.activeTab.attach({ - contentScriptFile: self.data.url("my-script.js") - }); - worker.port.emit("drawBorder", "red"); - } -}); -</pre> - -<p>A mensagem <code>drawBorder</code> não é uma mensagem embutida, é uma que este add-on definiu na chamada de <code>port.emit()</code>.</p> - -<h2 id="Injetando_CSS">Injetando CSS</h2> - -<p>Diferente da API <a href="/en-US/Add-ons/SDK/High-Level_APIs/page-mod"><code>page-mod</code></a>, <code>tab.attach()</code> não permite a você injetar CSS diretamente na página.</p> - -<p>Para modificar o estilo de uma página, você tem que usar JavaScript, como no exemplo acima.</p> - -<h2 id="Aprendendo_Mais">Aprendendo Mais</h2> - -<p>Para aprender mais sobre como trabalhar com tabs no SDK, veja o tutorial <a href="/en-US/Add-ons/SDK/Tutorials/Open_a_Web_Page">Abrindo uma Página da Web</a>, O tutorial <a href="/en-US/Add-ons/SDK/Tutorials/List_Open_Tabs">Lista de Tabs Abertas</a>, e a referência da API <a href="/en-US/Add-ons/SDK/High-Level_APIs/tabs"><code>tabs</code></a>.</p> - -<p>Para aprender mais sobre scripts de conteúdo, veja o guia de <a href="/en-US/Add-ons/SDK/Guides/Content_Scripts">scripts de conteúdo</a>.</p> diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/modifying_web_pages_based_on_url/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/modifying_web_pages_based_on_url/index.html deleted file mode 100644 index 4e846d75c7..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/tutorials/modifying_web_pages_based_on_url/index.html +++ /dev/null @@ -1,228 +0,0 @@ ---- -title: Modificando Página Web Baseado na URL -slug: Mozilla/Add-ons/SDK/Tutorials/Modifying_Web_Pages_Based_on_URL -tags: - - Add-on SDK - - content scripts -translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Modifying_Web_Pages_Based_on_URL ---- -<div class="note">Para seguir este tutorial, você precisará <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Installation">instalar o SDK</a> e ter conhecimento <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_Started_(jpm)">básico de jpm</a> (Firefox 38 em diante) ou <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_Started_With_cfx">básico de cfx</a>.</div> - -<p>Para modificar qualquer página que combine com um padrão particular (por exemplo, "http://example.org/") a medida que elas são carregadas, use o módulo <a href="/en-US/Add-ons/SDK/High-Level_APIs/page-mod"><code>page-mod</code></a>.</p> - -<p>Para criar um page-mod, você precisa de duas coisas:</p> - -<ul> - <li>Um ou mais <em>content scripts</em>(script de conteúdo) para executar cuja tarefa é interagir com o conteúdo web.</li> - <li>Um ou mais <em>patterns(padrões)</em> para combinar com URLs que você quer modificar.</li> -</ul> - -<p>Um trecho simples de códingo onde o script de conteúdo é fornecido com a opção <code>contentScript</code> e o padrão de busca da URL é dado pela opção <code>include</code> como a seguir:</p> - -<pre class="brush: js">// Importe a API page-mod -var pageMod = require("sdk/page-mod"); - -// Crie um page-mod -// Ele executará um script toda vez que uma URL ".org" é carregada -// O script substitui o conteúdo da página por uma mensagem -pageMod.PageMod({ - include: "*.org", - contentScript: 'document.body.innerHTML = ' + - ' "<h1>Page matches ruleset</h1>";' -}); -</pre> - -<p>Faça o seguinte:</p> - -<ul> - <li>Crie um novo diretório navegue para ele.</li> - <li>Execute <code>jpm init </code>ou <code>cfx init</code></li> - <li><code>Abra o arquivo index.js</code> e adicione o código acima (<code>lib/main.js se estiver usando</code> <code>cfx</code>)</li> - <li>Execute <code>jpm run </code>ou<code> cfx run</code>.</li> - <li>Abra no navegador o site <a href="http://www.ietf.org">ietf.org</a>.</li> -</ul> - -<p>Abaixo é o que você deve ver.</p> - -<p><img alt="" src="https://mdn.mozillademos.org/files/6537/pagemod-ietf.png" style="display: block; margin-left: auto; margin-right: auto;"></p> - -<h2 id="Especificando_o_Padão_a_Combinar">Especificando o Padão a Combinar</h2> - -<p>O padrão de combinação usa a síntaxe <a href="/en-US/Add-ons/SDK/Low-Level_APIs/util_match-pattern"><code>match-pattern</code></a>. Você pode passar uma única string como padrão a combinar ou um array.</p> - -<h2 id="Mantendo_o_Conteúdo_do_Script_em_um_Arquivo_Separado">Mantendo o Conteúdo do Script em um Arquivo Separado</h2> - -<p>No exemplo acima, nós fornecemos o script de conteúdo como uma string.</p> - -<p>A menos que o script seja extremamente simples, é melhor manter o script em um arquivo separado. Isso torna o código mais fácil para manter, depurar, e revisar. Para fazer isso, você precisa:</p> - -<ul> - <li>Salvar o script no diretório "<code>data</code>" do add-on.</li> - <li>Use a opção <code>contentScriptFile</code> ao invés de <code>contentScript</code> e passe para ela a URL do script que pode ser obtida usando <code>self.data.url("my-script.js")</code>. A partir do Firefox 34, você pode usar <code>"./my-script.js"</code>.</li> -</ul> - -<p>Por exemplo, se você salvar o script acima no diretório data do add-on em um arquivo chamado <code>my-script.js</code>:</p> - -<pre class="brush: js">// Importe a API page-mod -var pageMod = require("sdk/page-mod"); -// Importe a API self -var self = require("sdk/self"); - -// Crie um page-mod -// Ele executará um script toda vez que uma URL ".org" é carregada -// O script substitui o conteúdo da página por uma mensagem -pageMod.PageMod({ - include: "*.org", - contentScriptFile: self.data.url("my-script.js") -});</pre> - -<p>Ou a partir do Firefox 34:</p> - -<pre class="brush: js">// Importe a API page-mod -var pageMod = require("sdk/page-mod"); - -// Crie um page-mod -// Ele executará um script toda vez que uma URL ".org" é carregada -// O script substitui o conteúdo da página por uma mensagem -pageMod.PageMod({ - include: "*.org", - contentScriptFile: "./my-script.js" -});</pre> - -<h2 id="Carregando_Múltiplos_Scripts_de_Conteúdo">Carregando Múltiplos Scripts de Conteúdo</h2> - -<p>Você pode carregar mais do que um script, e eles podem interagir um com o outro.</p> - -<p>Por exmeplo, você poderia reescrever o <code>my-script.js</code> para usar o jQuery.</p> - -<pre class="brush: js">$("body").html("<h1>Page matches ruleset</h1>"); -</pre> - -<p>Então baixe o jQuery para o diretório <code>data</code> do add-on, e carregue o script e o jQuery juntos (tenha certeza de carregar o jQuery primeiro).</p> - -<pre class="brush: js">// Importe a API page-mod -var pageMod = require("sdk/page-mod"); -// Importe a API self -var self = require("sdk/self"); - -// Crie um page-mod -// Ele executará um script toda vez que uma URL ".org" é carregada -// O script substitui o conteúdo da página por uma mensagem -pageMod.PageMod({ - include: "*.org", - contentScriptFile: [self.data.url("jquery-1.7.min.js"), self.data.url("my-script.js")] -}); -</pre> - -<p>Você pode usar ambos <code>contentScript</code> e <code>contentScriptFile</code> no mesmo page-mod. Se você fizer isto, o script carregado usando <code>contentScriptFile</code> são carregados primeiro.</p> - -<pre class="brush: js">// Importe a API page-mod -var pageMod = require("sdk/page-mod"); -// Importe a API self -var self = require("sdk/self"); - -// Crie um page-mod -// Ele executará um script toda vez que uma URL ".org" é carregada -// O script substitui o conteúdo da página por uma mensagem -pageMod.PageMod({ - include: "*.org", - contentScriptFile: self.data.url("jquery-1.7.min.js"), - contentScript: '$("body").html("<h1>Page matches ruleset</h1>");' -}); -</pre> - -<p>Note, porém, que você não pode carregar um script de um site web. O script deve ser carregado do <code>data</code>.</p> - -<h2 id="Comunicando_com_o_Script_de_Conteúdo">Comunicando com o Script de Conteúdo</h2> - -<p>Seu script do add-on e o script de conteúdo não podem acessar diretamente a variável de um ou outro ou chamar função dos outros, mas eles podem enviar mensagens um para o outro.</p> - -<p>Para enviar mensagens de um lado para o outro, use o emitente de chamadas <code>port.emit()</code> e receba respostas usando <code>port.on()</code>.</p> - -<ul> - <li>No script de conteúdo, <code>port</code> é uma propriedade do objeto global <code>self</code>.</li> - <li>No script do add-on, você precisa capturar evento no <code>onAttach</code> event passando um objeto <a href="/en-US/Add-ons/SDK/Low-Level_APIs/content_worker">worker</a> que contém a <code>port</code>.</li> -</ul> - -<p>Vamos reescrever o exemplo acima para passar uma mensagem do add-on para o script de conteúdo. A mensagem conterá o novo conteúdo para inserir dentro do documento</p> - -<p>O script de conteúdo agora precisa parecer com isto:</p> - -<pre class="brush: js">// "self" é um objeto global no script de conteúdo -// Espera pelas mensagens, e substitui o conteúdo do -// documento com a mensagem recebida -self.port.on("replacePage", function(message) { - document.body.innerHTML = "<h1>" + message + "</h1>"; -}); -</pre> - -<p>No script do add-on, nós enviaremos ao script de conteúdo uma mensagem dentro do <code>onAttach</code>.</p> - -<pre class="brush: js">// Importe a API page-mod -var pageMod = require("sdk/page-mod"); -// Importe a API self -var self = require("sdk/self"); - -// Crie um page-mod -// Ele executará um script toda vez que uma URL ".org" é carregada -// O script substitui o conteúdo da página por uma mensagem -pageMod.PageMod({ - include: "*.org", - contentScriptFile: self.data.url("my-script.js"), - // Envia ao script de conteúdo uma mensagem dentro de onAttach - onAttach: function(worker) { - worker.port.emit("replacePage", "Page matches ruleset"); - } -}); -</pre> - -<p>A mensagem <code>replacePage</code> não é uma mensagem embutida: é uma mensagem definida pelo add-on na chamada do <code>port.emit()</code>.</p> - -<div> -<h2 id="Injetando_CSS">Injetando CSS</h2> - -<p><strong>Note que a característica descrita nesta seção é experimental no momento. Nós devemos provavelmente continuar suportando essa característica, mas os detalhes da API devem mudar.</strong></p> - -<p>Em vez de injetar JavaScript na página, você pode injetar CSS definindo a opção do <code>contentStyle</code> do mod-page.</p> - -<pre class="brush: js">var pageMod = require("sdk/page-mod").PageMod({ - include: "*", - contentStyle: "body {" + - " border: 5px solid green;" + - "}" -}); -</pre> - -<p>Como com o <code>contentScript</code>, há uma opção correspondente para <code>contentStyleFile</code> que leva uma URL de um arquivo CSS situado no diretório "data"; é uma boa prática usar essa opção ao invés de <code>contentStyle</code> se o CSS é muito complexo.</p> - -<pre class="brush: js">var pageMod = require("sdk/page-mod").PageMod({ - include: "*", - contentStyleFile: require("sdk/self").data.url("my-style.css") -}); -</pre> - -<p>Ou, a partir do Firefox 34, você pode usar a versão mais simples:</p> - -<pre class="brush: js">var pageMod = require("sdk/page-mod").PageMod({ - include: "*", - contentStyleFile: "./my-style.css" -});</pre> -</div> - -<h2 id="Aprendendo_mais">Aprendendo mais</h2> - -<p>Para aprender mais sobre o <code>page-mod</code>, veja a referência da API<a href="/en-US/Add-ons/SDK/High-Level_APIs/page-mod"> page</a>. Em particular, o construtor <code>PageMod</code> leva várias opções adicionais para controlar seu comportamento:</p> - -<ul> - <li> - <p>Por padrão, script de conteúdo não são anexados a qualuqer tab que já esteja aberta quando o page-mod é criado, e são anexados à iframes bem como documentos superiores. Para controlar esse comportamento use a opção <code>attachTo</code>.</p> - </li> - <li> - <p>Defina valores somente leitura acessíveis ao script de conteúdo usando a opção<code> contentScriptOptions</code>.</p> - </li> - <li> - <p>Por padrão, o script de conteúdo são anexados depois de todo o (DOM, JS, CSS, imagens) para a página ter sido carregado, no momento o evento <a href="/en-US/docs/Web/API/GlobalEventHandlers.onload">window.onload</a> dispara. Para controlar esse comportamento, use a opção <code>contentScriptWhen</code>.</p> - </li> -</ul> - -<p>Para aprender mais sobre o script de conteúdo,, veja o guia <a href="/en-US/Add-ons/SDK/Guides/Content_Scripts">content scripts</a>.</p> diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/mostrar_um_popup/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/mostrar_um_popup/index.html deleted file mode 100644 index b66c9fb06a..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/tutorials/mostrar_um_popup/index.html +++ /dev/null @@ -1,165 +0,0 @@ ---- -title: Mostrar um Popup -slug: Mozilla/Add-ons/SDK/Tutorials/Mostrar_um_Popup -tags: - - Add-on SDK - - Painel -translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Display_a_Popup ---- -<div class="note"> -<p>Para seguir este tutorial você precisará ter <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Installation">instalado o SDK</a> e ter conhecimento <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Getting_Started_With_cfx">básico sobre cfx</a>.</p> - -<p>Este tutorial usa a API <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_action">action button</a>, que está disponível somente do Firefox 29 em diante.</p> -</div> - -<p>Para mostrar um popup de diálogo, use o módulo <a href="/en-US/Add-ons/SDK/High-Level_APIs/panel"><code>panel</code></a>. Um painel de conteúdo é definido usando HTML. Você pode executar scripts no painel: embora o script em execução no painel não pode acessar diretamente o código de seu add-on, você pode trocar mensagens entre o script do painel e o código do add-on.</p> - -<p>Neste tutorial nós criaremos um add-on que adiciona um <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_action">action button </a>à barra de ferramentas que mostra um painel quando clicado. O painel contém apenas um elemento <code><textarea>:</code>quando o usuário aperta a tecla <code>return</code>, o conteúdo da <code><textarea> </code>é enviado ao código principal do add-on. O código principal do add-on <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Logging">repassa a mensagem ao console</a>. </p> - -<p><img alt="" src="https://mdn.mozillademos.org/files/7647/panel.png" style="display: block; margin-left: auto; margin-right: auto;">O add-on consiste em seis arquivos:</p> - -<ul> - <li><code>main.js</code>: o código principal do addon, que cria o botão e o painel</li> - <li><code>get-text.js</code>: o conteúdo do script que interage com o conteúdo do painel</li> - <li><code>text-entry.html</code>: o conteúdo do painel em si, especificado como HTML</li> - <li><code>icon-16.png</code>, <code>icon-32.png</code>, and <code>icon-64.png</code>: ícone para o botão em três tamanhos diferentes</li> -</ul> - -<p>O "main.js" se parece com isso:</p> - -<pre class="brush: js">var data = require("sdk/self").data; -// Constrói um painel, carrega seu conteúdo do arquivo -// "text-entry.html" no diretório "data", e carrega o script "get-text.js" -// para ele. -var text_entry = require("sdk/panel").Panel({ - contentURL: data.url("text-entry.html"), - contentScriptFile: data.url("get-text.js") -}); - -// Cria um botão -require("sdk/ui/button/action").ActionButton({ - id: "show-panel", - label: "Show Panel", - icon: { - "16": "./icon-16.png", - "32": "./icon-32.png", - "64": "./icon-64.png" - }, - onClick: handleClick -}); - -//Mostra o painel quando o usuário clica no botão -function handleClick(state) { - text_entry.show(); -} - -//Quando o painel é mostrado ele gera um evento chamado -//"show": nós esperaremos por este evento e quando ele ocorrer -//enviamos nosso próprio evento "show" para o script do painel, -//então o script pode preparar o painel para mostrar. -text_entry.on("show", function() { - text_entry.port.emit("show"); -}); - -//Espera pela mensagem chamada "text-entered" vinda do -//script do conteúdo. A carga útil da mensagem é o texto -//digitado pelo usuário. -//Nesta implementação nós passaremos o texto para o console. -text_entry.port.on("text-entered", function (text) { - console.log(text); - text_entry.hide(); -});</pre> - -<p>O conteúdo do script "get-text.js" parece com isto:</p> - -<div> -<pre class="brush: js">//Quando o usuário digita return, envia a mensagem "text-entered" -// para o main.js. -//A carga útil da mensagem é o conteúdo da caixa de edição. -var textArea = document.getElementById("edit-box"); -textArea.addEventListener('keyup', function onkeyup(event) { - if (event.keyCode == 13) { - // Remove a nova linha. - text = textArea.value.replace(/(\r\n|\n|\r)/gm,""); - self.port.emit("text-entered", text); - textArea.value = ''; - } -}, false); -//Espera pelo evento "show" vim do -//código principal do add-on. O que significa que o -//painel sobre será mostrado. -// -//Configura o foco para a área de texto então o usuário pode -//começar a digitar. -self.port.on("show", function onShow() { - textArea.focus(); -});</pre> - -<div> </div> -</div> - -<p>Finalmente, o arquivo "text-entry.html" define o elemento <code><textarea></code>:</p> - -<div> -<div> -<pre class="brush: html"><html> -<head> - <style type="text/css" media="all"> - textarea { - margin: 10px; - } - body { - background-color: gray; - } - </style> - </head> -<body> - <textarea rows="13" cols="33" id="edit-box"></textarea> - </body> -</html></pre> - -<div> </div> -</div> -</div> - -<p>Finalmente, salve estes três ícones no diretório "data":</p> - -<table class="standard-table"> - <tbody> - <tr> - <td><img alt="" src="https://mdn.mozillademos.org/files/7635/icon-16.png" style="height: 16px; width: 16px;"></td> - <td>icon-16.png</td> - </tr> - <tr> - <td><img alt="" src="https://mdn.mozillademos.org/files/7637/icon-32.png" style="height: 32px; width: 32px;"></td> - <td>icon-32.png</td> - </tr> - <tr> - <td><img alt="" src="https://mdn.mozillademos.org/files/7639/icon-64.png" style="height: 64px; width: 64px;"></td> - <td>icon-64.png</td> - </tr> - </tbody> -</table> - -<p>Teste: o "main.js" está salveo no diretório <code>lib</code> do add-on, e os outros cinco arquivos vão no diretório data do add-on:</p> - -<pre>my-addon/ - data/ - get-text.js - icon-16.png - icon-32.png - icon-64.png - text-entry.html - lib/ - main.js -</pre> - -<p>Execute o add-on, clique no botão, e você deverá ver o painel. Digite algum texto e pressione "return" e você deverá ver a saída no console.</p> - -<p>Do Firefox 30 em diante, se você usar o <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_toggle">toggle button</a>, você pode <a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_toggle#Attaching_panels_to_buttons">anexar o painel ao botão</a>.</p> - -<h2 id="Aprendendo_Mais">Aprendendo Mais</h2> - -<p>Para aprender mais sobre o módulo <code>panel</code>, veja a referência da API <a href="/en-US/Add-ons/SDK/High-Level_APIs/panel"><code>panel</code></a>.</p> - -<p>Para aprender mais sobre buttons, veja referência da API <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_action">action button</a> e <a href="/en-US/Add-ons/SDK/Low-Level_APIs/ui_button_toggle">toggle button</a>.</p> diff --git a/files/pt-br/mozilla/add-ons/sdk/tutorials/unit_testing/index.html b/files/pt-br/mozilla/add-ons/sdk/tutorials/unit_testing/index.html deleted file mode 100644 index 2e65659ed5..0000000000 --- a/files/pt-br/mozilla/add-ons/sdk/tutorials/unit_testing/index.html +++ /dev/null @@ -1,127 +0,0 @@ ---- -title: Teste de unidade -slug: Mozilla/Add-ons/SDK/Tutorials/Unit_testing -tags: - - Add-on SDK - - JPM -translation_of: Archive/Add-ons/Add-on_SDK/Tutorials/Unit_testing ---- -<div class="note"> -<p><span>Para seguir este tutorial você precisará ter conhecimento básico de<a href="/en-US/docs/Mozilla/Add-ons/SDK/Tutorials/Getting_Started_%28jpm%29"> <code>jpm</code></a> e ter seguido o tutorial de <a href="/en-US/Add-ons/SDK/Tutorials/Using_third-party_modules_(jpm)">criação de módulos reutilizáveis</a>.</span></p> -</div> - -<div class="note"> -<p>Se você está migrando código de teste do cfx para o <a href="/en-US/Add-ons/SDK/Tools/jpm">jpm</a>, veja o guia de migração do cfx, em particular a seção <a href="/en-US/Add-ons/SDK/Tools/cfx_to_jpm#Requiring_modules_from_test_code">loading modules from test code</a>.</p> -</div> - -<p>O SDK fornece um framework para ajudar a criar e executar testes de unidade para seu código. Para demonstrar como ele funciona nós escreveremos um teste de unidade para um módulo simples de codificação <a href="http://en.wikipedia.org/wiki/Base64">Base64</a>.</p> - -<h2 id="Um_módulo_simples_Base64">Um módulo simples Base64</h2> - -<p>Em uma página web, você pode executar uma codificação Base64 e decodificação usando as funções <code>btoa()</code> e <code>atob()</code>. Infelizmente essas funções pertencem ao objeto <code>window</code>: uma vez que o objeto não está disponível no código principal do add-on, <code>atob()</code> e <code>btoa()</code> não estão disponíveis de qualquer forma. Então nós criaremos um módulo <code>base64</code> para exibir estas funções da plataforma.</p> - -<p>Para começar, crie um novo diretório, navegue para ele, e execute o <code>jpm init</code>. Agora crie um novo arquivo chamado "base64.js", e de lhe o seguinte conteúdo:</p> - -<pre class="brush: js">const { atob, btoa } = require("chrome").Cu.import("resource://gre/modules/Services.jsm", {}); - -exports.atob = a => atob(a); -exports.btoa = b => btoa(b); -</pre> - -<p>Este código exporta duas funções, que chamamos <code>btoa()</code> and <code>atob()</code>. Para mostrar o módulo em uso, edit o arquivo "index.js" como segue:</p> - -<pre class="brush: js">var base64 = require("./base64"); - -var button = require("sdk/ui/button/action").ActionButton({ - id: "base64", - label: "base64", - icon: "./icon-16.png", - onClick: function() { - encoded = base64.btoa("hello"); - console.log(encoded); - decoded = base64.atob(encoded); - console.log(decoded); - } -});</pre> - -<p>Para executar esse exemplo você também terá que ter um ícone chamado "icon-16.png" salvo no diretório data do add-on. Você pode baixar este ícone: <img alt="" src="https://mdn.mozillademos.org/files/7661/icon-16.png" style="height: 16px; width: 16px;">.</p> - -<p>Agora o "index.js" importa o módulo base64 e chama suas duas funções exportadas. Se nós executarmos o add-on e clicarmos no botão, nós devemos ver a seguinte saída:</p> - -<pre>info: aGVsbG8= -info: hello -</pre> - -<h2 id="Testando_o_módulo_Base64">Testando o módulo Base64</h2> - -<p>Navegue para o diretório <code>test</code> e delete o arquivo <code>test-index.js</code>. Em seu lugar crie um arquivo chamado <code>test-base64.js</code> com o seguinte conteúdo:</p> - -<pre class="brush: js">var base64 = require("../base64"); - -exports["test atob"] = function(assert) { - assert.ok(base64.atob("aGVsbG8=") == "hello", "atob works"); -} - -exports["test btoa"] = function(assert) { - assert.ok(base64.btoa("hello") == "aGVsbG8=", "btoa works"); -} - -exports["test empty string"] = function(assert) { - assert.throws(function() { - base64.atob(); - }, - "empty string check works"); -} - -require("sdk/test").run(exports); -</pre> - -<div class="note"> -<p>Note que com o jpm nós devemos dar o caminho exato do módulo base64.js.</p> -</div> - -<p>Esse arquivo: exporta três funções, cada qual espera receber um único argumento que é o objeto <code>assert</code>. <code>assert</code> é fornecida pelo módulo <a href="/en-US/Add-ons/SDK/Low-Level_APIs/test_assert"><code>test/assert</code></a> e implementa o <a href="http://wiki.commonjs.org/wiki/Unit_Testing/1.1">CommonJS Unit Testing specification</a>.</p> - -<ul> - <li> - <p>As duas primeiras funções chamam <code>atob()</code> e <code>btoa()</code> e usa o <a href="/en-US/Add-ons/SDK/Low-Level_APIs/test_assert#ok(guard.2C_message)"><code>assert.ok()</code></a> para checar que a saída é a esperada</p> - </li> - <li> - <p>A segunda função testo código de manipulação de erro do módulo passando uma string vazia para o <code>atob()</code> e usando <a href="/en-US/Add-ons/SDK/Low-Level_APIs/test_assert#throws(block.2C_error.2C_message)"><code>assert.throws()</code></a> para checar que a exceção esperada foi lançada.</p> - </li> -</ul> - -<p>Neste ponto seu add-on deve parecer com isto:</p> - -<pre> /base64 - /data - icon-16.png - package.json - README.md - index.js - base64.js - /test - test-base64.js -</pre> - -<p>Agora execute o <code>jpm --verbose test</code> da pasta principal do add-on. Você deve ver algo como isto:</p> - -<pre>console.info: jpm-utest: executing './test/test-base64.test atob' -console.info: jpm-utest: pass: atob works -console.info: jpm-utest: executing './test/test-base64.test btoa' -console.info: jpm-utest: pass: btoa works -console.info: jpm-utest: executing './test/test-base64.test empty string' -console.info: jpm-utest: pass: empty string check works - -3 of 3 tests passed. -All tests passed!</pre> - -<p>O que aconteceu aqui é que o <code>jpm test</code>:</p> - -<ul> - <li>procura no diretório <code>test</code> o seu pacote</li> - <li>carrega qualquer módulo cujo nome começa com a palavra <code>test- </code>(Note o hífen depois de<span> "test" no nome do módulo. <code>jpm test</code> incluirá um módulo chamado "test-myCode.js", mas excluirá módulos chamados "test_myCode.js" ou "testMyCode.js".)</span></li> - <li>chama cada função exportada cujo nome começa com "test", passando um objeto <a href="/en-US/Add-ons/SDK/Low-Level_APIs/test_assert#Assert"><code>assert</code></a> como seu único argumento.</li> -</ul> - -<p>Obviamente, você não tem que passar a opção<code> --verbose</code> para o jpm se você não quiser; fazendo assim torna a saída mais fácil de ler.</p> |