1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/graphics/graphicscomposition/openwfcompositionengine/adaptation/include/owfnotifications.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,85 @@
     1.4 +/* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 + * 
     1.6 + * Permission is hereby granted, free of charge, to any person obtaining a
     1.7 + * copy of this software and/or associated documentation files (the
     1.8 + * "Materials"), to deal in the Materials without restriction, including
     1.9 + * without limitation the rights to use, copy, modify, merge, publish,
    1.10 + * distribute, sublicense, and/or sell copies of the Materials, and to
    1.11 + * permit persons to whom the Materials are furnished to do so, subject to
    1.12 + * the following conditions:
    1.13 + * 
    1.14 + * The above copyright notice and this permission notice shall be included
    1.15 + * in all copies or substantial portions of the Materials.
    1.16 + * 
    1.17 + * THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    1.18 + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    1.19 + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
    1.20 + * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
    1.21 + * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
    1.22 + * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
    1.23 + * MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
    1.24 + * 
    1.25 + * Description:
    1.26 + * Symbian notifications
    1.27 + */
    1.28 +
    1.29 +
    1.30 +#ifdef __cplusplus
    1.31 +extern "C" {
    1.32 +#endif
    1.33 +
    1.34 +/*!
    1.35 + *  \brief Initialises the Symbian specific device data, including
    1.36 + *  the SUS observers
    1.37 + *
    1.38 + *  \param source the source to be initialised
    1.39 + *  \return OWF_TRUE id successfull
    1.40 + */
    1.41 +OWF_API_CALL OWFboolean
    1.42 +owfSymDeviceInitialise(WFC_IMAGE_PROVIDER* source);
    1.43 +
    1.44 +/*!
    1.45 + *  \brief Destroys the Symbian specific device data, including
    1.46 + *  the SUS observers
    1.47 + *
    1.48 + *  \param device the device to be destroyed
    1.49 + *  \param source the source to be initialised
    1.50 + *  \param position in the device list
    1.51 + */
    1.52 +OWF_API_CALL void
    1.53 +owfSymDeviceDestroy(WFC_DEVICE* device, WFC_IMAGE_PROVIDER* source, WFCint position);
    1.54 +
    1.55 +/*!
    1.56 + *  \brief Notifies the stream associated with element that the read buffer has been aquired
    1.57 + *
    1.58 + *  Used to solve the initial availabilty request
    1.59 + *
    1.60 + *  \param context The context corresponding to the ongoing composition
    1.61 + *  \param element The element that composition has just started for
    1.62 + *
    1.63 + *  \return OWF_TRUE id successfull
    1.64 + */
    1.65 +OWF_API_CALL OWFboolean
    1.66 +owfSymElementNotifications(WFC_CONTEXT* context, WFC_ELEMENT* element);
    1.67 +
    1.68 +/*!
    1.69 + *  \brief Resets the visibility state associated with each source
    1.70 + *
    1.71 + *  Used after each commit
    1.72 + *
    1.73 + *  \param context The context
    1.74 + */
    1.75 +OWF_API_CALL void
    1.76 +owfSymDeviceResetVisibilityState(WFC_CONTEXT* context);
    1.77 +
    1.78 +/*!
    1.79 + *  \brief Processes all notifications for a context immediately after the context has been composed 
    1.80 + *
    1.81 + *  \param context The context coresponding to the caller composer
    1.82 + */
    1.83 +OWF_API_CALL WFCint
    1.84 +owfSymProcessAllNotifications(WFC_CONTEXT* context);
    1.85 +
    1.86 +#ifdef __cplusplus
    1.87 +}
    1.88 +#endif