15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This file contains the <code>PPB_Flash_MessageLoop</code> interface. 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)label Chrome { 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) M18 = 0.1 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The <code>PPB_Flash_MessageLoop</code> interface supports Pepper Flash to run 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * nested message loops. 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)interface PPB_Flash_MessageLoop { 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Allocates a Flash message loop resource. 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @param[in] instance A <code>PP_Instance</code> identifying one instance 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * of a module. 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @return A <code>PP_Resource</code> that can be used to run a nested message 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * loop if successful; 0 if failed. 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_Resource Create([in] PP_Instance instance); 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Determines if a given resource is a Flash message loop. 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @param[in] resource A <code>PP_Resource</code> corresponding to a generic 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * resource. 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @return A <code>PP_Bool</code> that is <code>PP_TRUE</code> if the given 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * resource is a Flash message loop, otherwise <code>PP_FALSE</code>. 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_Bool IsFlashMessageLoop([in] PP_Resource resource); 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Runs a nested message loop. The plugin will be reentered from this call. 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This function is used in places where Flash would normally enter a nested 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * message loop (e.g., when displaying context menus), but Pepper provides 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * only an asynchronous call. After performing that asynchronous call, call 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * <code>Run()</code>. In the callback, call <code>Quit()</code>. 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * For a given message loop resource, only the first call to 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * <code>Run()</code> will start a nested message loop. The subsequent calls 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * will return <code>PP_ERROR_FAILED</code> immediately. 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @param[in] flash_message_loop The Flash message loop. 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @return <code>PP_ERROR_ABORTED</code> if the message loop quits because the 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * resource is destroyed; <code>PP_OK</code> if the message loop quits because 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * of other reasons (e.g., <code>Quit()</code> is called); 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * <code>PP_ERROR_FAILED</code> if this is not the first call to 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * <code>Run()</code>. 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32_t Run([in] PP_Resource flash_message_loop); 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Signals to quit the outermost nested message loop. Use this to exit and 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * return back to the caller after you call <code>Run()</code>. 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * If <code>Quit()</code> is not called to balance the call to 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * <code>Run()</code>, the outermost nested message loop will be quitted 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * implicitly when the resource is destroyed. 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @param[in] flash_message_loop The Flash message loop. 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Quit([in] PP_Resource flash_message_loop); 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)};