YiGamePadExtendedButtons.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_GAME_PAD_EXTENDED_BUTTONS_H_
#define _YI_GAME_PAD_EXTENDED_BUTTONS_H_

#include "YiGamePadButton.h"

/*
    \brief Contains extended gamepad buttons.

    \details This class extends the buttons found on CYIGamePad. The buttons contained in this class are not found on a standard gamepad. These extended buttons would
    be found on device such as a remote control for a game console. These extended buttons are accessed through CYIGamePad::GetExtendedButtons.

    \sa CYIGamePad
*/
class CYIGamePadExtendedButtons
{
friend class CYIGamePad;
friend class CYIGamePadPriv;

public:
    /*
        \details Returns a button representing the state of the number 1 button.
    */
    const CYIGamePadButton  &GetNum1Button() const;

    /*
        \details Returns a button representing the state of the number 2 button.
    */
    const CYIGamePadButton  &GetNum2Button() const;

    /*
        \details Returns a button representing the state of the number 3 button.
    */
    const CYIGamePadButton  &GetNum3Button() const;

    /*
        \details Returns a button representing the state of the number 4 button.
    */
    const CYIGamePadButton  &GetNum4Button() const;

    /*
        \details Returns a button representing the state of the number 5 button.
    */
    const CYIGamePadButton  &GetNum5Button() const;

    /*
        \details Returns a button representing the state of the number 6 button.
    */
    const CYIGamePadButton  &GetNum6Button() const;

    /*
        \details Returns a button representing the state of the number 7 button.
    */
    const CYIGamePadButton  &GetNum7Button() const;

    /*
        \details Returns a button representing the state of the number 8 button.
    */
    const CYIGamePadButton  &GetNum8Button() const;

    /*
        \details Returns a button representing the state of the number 9 button.
    */
    const CYIGamePadButton  &GetNum9Button() const;

    /*
        \details Returns a button representing the state of the number 0 button.
    */
    const CYIGamePadButton  &GetNum0Button() const;

    /*
        \details Returns a button representing the state of the enter button.
    */
    const CYIGamePadButton  &GetEnterButton() const;

    /*
        \details Returns a button representing the state of the return button.
    */
    const CYIGamePadButton  &GetReturnButton() const;

    /*
        \details Returns a button representing the state of the clear button.
    */
    const CYIGamePadButton  &GetClearButton() const;

    /*
        \details Returns a button representing the state of the top menu button. This button would typically take a user to a menu away from the current screen.
    */
    const CYIGamePadButton  &GetTopMenuButton() const;

    /*
        \details Returns a button representing the state of the previous track media button.
    */
    const CYIGamePadButton  &GetPrevButton() const;

    /*
        \details Returns a button representing the state of the next track media button.
    */
    const CYIGamePadButton  &GetNextButton() const;

    /*
        \details Returns a button representing the state of the play media button.
    */
    const CYIGamePadButton  &GetPlayButton() const;

    /*
        \details Returns a button representing the state of the reverse scan media button.
    */
    const CYIGamePadButton  &GetScanReverseButton() const;

    /*
        \details Returns a button representing the state of the forward scan media button.
    */
    const CYIGamePadButton  &GetScanForwardButton() const;

    /*
        \details Returns a button representing the state of the stop media button.
    */
    const CYIGamePadButton  &GetStopButton() const;

    /*
        \details Returns a button representing the state of the pause media button.
    */
    const CYIGamePadButton  &GetPauseButton() const;

    /*
        \details Returns a button representing the state of the pop-up menu button. This button would typically bring up a menu on the current screen.
    */
    const CYIGamePadButton  &GetPopupMenuButton() const;

    /*
        \details Returns a button representing the state of the reverse step or slow reverse media button.
    */
    const CYIGamePadButton  &GetStepReverseButton() const;

    /*
        \details Returns a button representing the state of the forward step or slow forward media button.
    */
    const CYIGamePadButton  &GetStepForwardButton() const;

    /*
        \details Returns a button representing the state of the subtitle toggle button.
    */
    const CYIGamePadButton  &GetSubtitleButton() const;

    /*
        \details Returns a button representing the state of the display toggle button. 
    */
    const CYIGamePadButton  &GetDisplayButton() const;

    /*
        \details Returns a button representing the state of the fast forward media button.
    */
    const CYIGamePadButton  &GetFastForwardButton() const;

    /*
        \details Returns a button representing the state of the rewind media button.
    */
    const CYIGamePadButton  &GetFastReverseButton() const;

    /*
        \details Returns a button representing the state of the blue button.
    */
    const CYIGamePadButton  &GetBlueButton() const;

    /*
        \details Returns a button representing the state of the red button.
    */
    const CYIGamePadButton  &GetRedButton() const;

    /*
        \details Returns a button representing the state of the green button.
    */
    const CYIGamePadButton  &GetGreenButton() const;

    /*
        \details Returns a button representing the state of the yellow button.
    */
    const CYIGamePadButton  &GetYellowButton() const;

    /*
        \details Returns a button representing the state of the channel up button.
    */
    const CYIGamePadButton  &GetChannelUpButton() const;

    /*
        \details Returns a button representing the state of the channel down button.
    */
    const CYIGamePadButton  &GetChannelDownButton() const;

    /*
        \details Returns a button representing the state of the program guide button.
    */
    const CYIGamePadButton &GetProgramGuideButton() const;

private:
    CYIGamePadExtendedButtons();
    ~CYIGamePadExtendedButtons();

    CYIGamePadButton m_num1Button;
    CYIGamePadButton m_num2Button;
    CYIGamePadButton m_num3Button;
    CYIGamePadButton m_num4Button;
    CYIGamePadButton m_num5Button;
    CYIGamePadButton m_num6Button;
    CYIGamePadButton m_num7Button;
    CYIGamePadButton m_num8Button;
    CYIGamePadButton m_num9Button;
    CYIGamePadButton m_num0Button;
    CYIGamePadButton m_enterButton;
    CYIGamePadButton m_returnButton;
    CYIGamePadButton m_clearButton;
    CYIGamePadButton m_topMenuButton;
    CYIGamePadButton m_prevButton;
    CYIGamePadButton m_nextButton;
    CYIGamePadButton m_playButton;
    CYIGamePadButton m_scanReverseButton;
    CYIGamePadButton m_scanForwardButton;
    CYIGamePadButton m_stopButton;
    CYIGamePadButton m_pauseButton;
    CYIGamePadButton m_popupMenuButton;
    CYIGamePadButton m_upButton;
    CYIGamePadButton m_downButton;
    CYIGamePadButton m_leftButton;
    CYIGamePadButton m_rightButton;
    CYIGamePadButton m_stepReverseButton;
    CYIGamePadButton m_stepForwardButton;
    CYIGamePadButton m_subtitleButton;
    CYIGamePadButton m_displayButton;
    CYIGamePadButton m_fastForwardButton;
    CYIGamePadButton m_fastReverseButton;
    CYIGamePadButton m_blueButton;
    CYIGamePadButton m_redButton;
    CYIGamePadButton m_greenButton;
    CYIGamePadButton m_yellowButton;
    CYIGamePadButton m_channelUpButton;
    CYIGamePadButton m_channelDownButton;
    CYIGamePadButton m_programGuideButton;
};

#endif // _YI_GAME_PAD_EXTENDED_BUTTONS_H_