#include <QGraphicsScene>

    \brief The HbPopup class defines a set of properties that control the behavior of 

    the many dialog and popup classes that derive from it. 

    Objects of classes derived from %HbPopup are called \b popups. Typically they

    are displayed above other objects within the view, at the highest z-order. The %HbPopup

    class simply defines a frame with a number of properties. If you want to create an

    application dialog with a heading, content and a toolbar, use the HbDialog class (which

    is derived from %HbPopup) or one of its convenience subclasses.

    %HbPopup provides properties that you can use to customize the following aspects of a popup:

    - \b Modality. You can define whether the popup is modal or non-modal. A modal popup stops

      the user interacting with anything outside of the popup until it closes. A non-modal 

      popup does not block the user's interaction with things outside of the popup. You 

      set and get the modality by calling setModal() and isModal(), respectively.  

    - <b>Dismiss policy</b>. You can define which user actions, if any, cause the popup to 

      close. Possible values are defined by HbPopup::DismissPolicy. You set and get the dismiss 

      policy by calling setDismissPolicy() and dismissPolicy(), respectively.

    - <b>Background fade policy</b>. You can set a policy to fade everything behind the 

      popup. This is useful for modal dialogs, because the user cannot interact with 

      anything behind the popup. You control this policy by calling setBackgroundFaded() and 

      get the current policy by calling isBackgroundFaded().

    - \b Timeout. You can define a timeout that causes the popup to be dismissed automatically

      after a set a period. You set and get this property by calling setTimeout() and 

      timeout(), respectively. Call the setTimeout(HbPopup::DefaultTimeout) overload to use the 

      default value for the popup type, which provides a common look and feel.

    - <b>Frame background type</b>. You can define the popup's background style. However, 

      the actual appearance of the popup depends on the theme. You set and get this property by

      calling setFrameType() and frameType(), respectively.

    By default, popups are displayed in the center of the screen. Typically you should not override

    the default position of modal dialogs. However, some popups, such as context menus, need to be 

    in a specific position. For these, you can use the setPreferredPos() method to set the 

    preferred position.

    Popups that contain an editor may be repositioned by the virtual keyboard when it opens. 

    When the virtual keyboard closes, it attempts to reposition the popup back to its 

    previous position. However, this is not always possible, particularly when there has also

    been an orientation switch.

    \section _usecases_hbpopup Using the HbPopup class

    Although it is possible to create an instance of the HbPopup class, it is designed as a

    base class to provide common features to the many popup and dialog classes that are 

    derived from it (such as HbMenu, HbDialog, HbToolBarExtension, HbZoomSliderPopup). 

    How you open a popup depends on whether it is modal. It is important to use the 

    appropriate method, because this ensures the correct touch event handling.

    <table border="1" style="border-collapse: collapse; border: solid;">

    <tr><th>To open</TH><TH>Call</th></tr>

    <tr><td>Modal popups</td><td>open()</td></tr>

    <tr><td>Non-modal popups</td><td>\link QGraphicsItem::show() show()\endlink</td></tr>

    </table>

    \sa HbDialog, HbMenu

    Identifies default timeout values for various popup types. The timeout defines a time

    period after which the popup is automatically closed. Using these default values 

    provides a consistent look and feel.

    \sa setTimeout(HbPopup::DefaultTimeout)

    Defines a permanent popup, for which no timeout is defined.

    The default timeout value for confirmation notes.

    The default timeout value for standard non-permanent popups, such as notes.

    The default timeout value for context menus.

    Defines the available dismiss policy values. The dismiss policy defines which

    user actions cause the popup to close.

    \sa setDismissPolicy(), dismissPolicy()

    The popup cannot be closed by the user.

    Closes the popup when the user taps within the popup's bounding rectangle.

    Closes the popup when the user taps outside of the popup's bounding rectangle.

    Closes the popup when the user taps either inside or outside the popup's bounding 

    rectangle.

    Identifies the background graphical styles of the popup's frame.

    \sa setFrameType(), frameType()

    Use the "strong" frame background style.

    Use the "weak" frame background style.

    This signal is emitted when the popup is about to be shown; that is, when 

    \link QGraphicsItem::show() show()\endlink is called.

    This signal is emitted when the popup is about to be hidden; that is, when 

    \link QGraphicsItem::hide() hide()\endlink is called.

    This signal is emitted when the popup is about to close; that is, when 

    \link QGraphicsWidget::close() close()\endlink is called or the popup is dismissed 

    by the user or timeout.

    Identifies the corners and edges of the popup for use when setting its position

    using setPreferredPos(). 

/*!

    \var HbPopup::TopLeftCorner

    The popup's top left corner.

 */

/*!

    \var HbPopup::TopRightCorner

    The popup's top right corner.

 */

/*!

    \var HbPopup::BottomLeftCorner

    The popup's bottom left corner.

 */

/*!

    \var HbPopup::BottomRightCorner

    The popup's bottom right corner.

 */

/*!

    \var HbPopup::TopEdgeCenter

    The center of the popup's top edge.

 */

/*!

    \var HbPopup::RightEdgeCenter

    The center of the popup's rightmost edge.

 */

/*!

    \var HbPopup::BottomEdgeCenter

    The center of the popup's bottom edge.

 */

/*!

    \var HbPopup::LeftEdgeCenter

    The center of the popup's leftmost edge.

 */

 /*!

    \var HbPopup::Center

    The center of the popup.

 */

namespace {

    //initial values if not found from hbpopup.css

    static const int NO_TIMEOUT = 0;

    static const int CONFIRMATION_NOTE_TIMEOUT = 1500;

    static const int STANDARD_TIMEOUT = 3000;

    static const int CONTEXT_MENU_TIMEOUT = 6000;

    static const QLatin1String NO_TIMEOUT_STRING("no-timeout");

    static const QLatin1String CONFIRMATION_NOTE_TIMEOUT_STRING("confirmation-note-timeout");

    static const QLatin1String STANDARD_TIMEOUT_STRING("standard-timeout");

    static const QLatin1String CONTEXT_MENU_TIMEOUT_STRING("context-menu-timeout");

}

/*

   Currently, virtual keyboard must be able to position a popup

   containing an editor to an arbitrary place. VKB does its best to

   reposition the popup back to original position when needed. At least in

   orientation switch the old position naturally is wrong, hence popup

   must be relayouted.

   It would be unreasonable to make special checks for popup in vkb

   side. It also would be unreasonable to do special checks for vkb in

   popup side. Hence this semi-hidden dynamic property for

   communicating this special case.

   WARNING: Do not count on this special behaviour, we might remove it

   without prior notice. If you do require such a behavior, please

   raise a feature request and we might make this a proper API.

 */

const char* KPositionManagedByVKB("PositionManagedByVKB");

/*

    \primitive{background} HbFrameItem representing the popup background. The background can be 

    weak or strong (different graphical styles) depending on popup type.

    showingInProgress(false),

    timeout(-1),

    timeoutPending(true),

    pendingTimeout(HbPopup::StandardTimeout),

    placement(HbPopup::TopLeftCorner),

    mStartEffect(true),

    mActivePopup(true),

    mMaskedItem(0),

    mPopupMask(0),

    mGestureOverride(false),

    mFullScreen(false),

    delete mPopupMask;

    q->setFocusPolicy(Qt::StrongFocus);

    q->setBackgroundItem(new HbFrameItem(QLatin1String("qtg_fr_popup"), HbFrameDrawer::NinePieces), -1);

    itemFlags |= QGraphicsItem::ItemIsPanel;

    q->setFlags(itemFlags);

    q->setActive(false);

    q->setAcceptTouchEvents(true);

    defaultTimeouts[HbPopup::NoTimeout] = NO_TIMEOUT;

    defaultTimeouts[HbPopup::ConfirmationNoteTimeout] = CONFIRMATION_NOTE_TIMEOUT;

    defaultTimeouts[HbPopup::StandardTimeout] = STANDARD_TIMEOUT;

    defaultTimeouts[HbPopup::ContextMenuTimeout] = CONTEXT_MENU_TIMEOUT;

    Q_UNUSED(status);

    Q_Q(HbPopup);

    showingInProgress = false;

    q->emit popupReady();

}

void HbPopupPrivate::_q_maskEffectDestroyed()

{

    mVgMaskEffect = 0;

    return HbInstancePrivate::d_ptr()->systemTone();