Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
|
#include <GUIThrottleButton.h>
Public Member Functions | |
CGUIThrottleButton (const CGUIButtonControl &buttonTemplate, IConfigurationWizard *wizard, const CPhysicalFeature &feature, unsigned int index) | |
~CGUIThrottleButton () override=default | |
bool | PromptForInput (CEvent &waitEvent) override |
Prompt the user for a single input element. | |
bool | IsFinished () const override |
Check if the button supports further calls to PromptForInput() | |
JOYSTICK::THROTTLE_DIRECTION | GetThrottleDirection () const override |
Get the direction of the next throttle prompt. | |
void | Reset () override |
Reset button after prompting for input has finished. | |
Public Member Functions inherited from KODI::GAME::CGUIFeatureButton | |
CGUIFeatureButton (const CGUIButtonControl &buttonTemplate, IConfigurationWizard *wizard, const CPhysicalFeature &feature, unsigned int index) | |
~CGUIFeatureButton () override=default | |
void | OnUnFocus () override |
const CPhysicalFeature & | Feature () const override |
Get the feature represented by this button. | |
INPUT::CARDINAL_DIRECTION | GetCardinalDirection () const override |
Get the direction of the next analog stick or relative pointer prompt. | |
JOYSTICK::WHEEL_DIRECTION | GetWheelDirection () const override |
Get the direction of the next wheel prompt. | |
Public Member Functions inherited from CGUIButtonControl | |
CGUIButtonControl (int parentID, int controlID, float posX, float posY, float width, float height, const CTextureInfo &textureFocus, const CTextureInfo &textureNoFocus, const CLabelInfo &label, bool wrapMultiline=false) | |
CGUIButtonControl (const CGUIButtonControl &control) | |
~CGUIButtonControl () override=default | |
CGUIButtonControl * | Clone () const override |
void | Process (unsigned int currentTime, CDirtyRegionList &dirtyregions) override |
void | Render () override |
bool | OnAction (const CAction &action) override |
bool | OnMessage (CGUIMessage &message) override |
void | AllocResources () override |
void | FreeResources (bool immediately=false) override |
void | DynamicResourceAlloc (bool bOnOff) override |
void | SetInvalid () override |
void | SetPosition (float posX, float posY) override |
virtual void | SetLabel (const std::string &aLabel) |
virtual void | SetLabel2 (const std::string &aLabel2) |
void | SetClickActions (const CGUIAction &clickActions) |
const CGUIAction & | GetClickActions () const |
void | SetFocusActions (const CGUIAction &focusActions) |
void | SetUnFocusActions (const CGUIAction &unfocusActions) |
const CLabelInfo & | GetLabelInfo () const |
virtual std::string | GetLabel () const |
virtual std::string | GetLabel2 () const |
void | SetSelected (bool bSelected) |
std::string | GetDescription () const override |
float | GetWidth () const override |
virtual void | SetMinWidth (float minWidth) |
void | SetAlpha (unsigned char alpha) |
void | PythonSetLabel (const std::string &strFont, const std::string &strText, KODI::UTILS::COLOR::Color textColor, KODI::UTILS::COLOR::Color shadowColor, KODI::UTILS::COLOR::Color focusedColor) |
void | PythonSetDisabledColor (KODI::UTILS::COLOR::Color disabledColor) |
virtual void | OnClick () |
bool | HasClickActions () const |
bool | UpdateColors (const CGUIListItem *item) override |
CRect | CalcRenderRegion () const override |
calculate the render region in parentcontrol coordinates of this control Called during process to update m_renderRegion | |
Public Member Functions inherited from CGUIControl | |
CGUIControl () | |
CGUIControl (int parentID, int controlID, float posX, float posY, float width, float height) | |
CGUIControl (const CGUIControl &) | |
virtual | ~CGUIControl (void) |
virtual void | DoProcess (unsigned int currentTime, CDirtyRegionList &dirtyregions) |
virtual void | DoRender () |
virtual void | RenderEx () |
bool | HasProcessed () const |
Returns whether or not we have processed. | |
virtual void | OnUp () |
virtual void | OnDown () |
virtual void | OnLeft () |
virtual void | OnRight () |
virtual bool | OnBack () |
virtual bool | OnInfo () |
virtual void | OnNextControl () |
virtual void | OnPrevControl () |
virtual EVENT_RESULT | SendMouseEvent (const CPoint &point, const KODI::MOUSE::CMouseEvent &event) |
React to a mouse event. | |
virtual void | UnfocusFromPoint (const CPoint &point) |
Unfocus the control if the given point on screen is not within it's boundary. | |
virtual bool | HitTest (const CPoint &point) const |
Used to test whether the point is inside a control. | |
virtual int | GetID (void) const |
virtual void | SetID (int id) |
int | GetParentID () const |
virtual bool | HasFocus () const |
virtual bool | IsDynamicallyAllocated () |
virtual bool | CanFocus () const |
virtual bool | IsVisible () const |
bool | IsVisibleFromSkin () const |
virtual bool | IsDisabled () const |
virtual void | SetHitRect (const CRect &rect, const KODI::UTILS::COLOR::Color &color) |
virtual void | SetCamera (const CPoint &camera) |
virtual void | SetStereoFactor (const float &factor) |
bool | SetColorDiffuse (const KODI::GUILIB::GUIINFO::CGUIInfoColor &color) |
CPoint | GetRenderPosition () const |
virtual float | GetXPosition () const |
virtual float | GetYPosition () const |
virtual float | GetHeight () const |
virtual void | AssignDepth () |
void | MarkDirtyRegion (const unsigned int dirtyState=DIRTY_STATE_CONTROL) |
bool | IsControlDirty () const |
const CRect & | GetRenderRegion () const |
return the render region in screen coordinates of this control | |
void | SetActions (const ActionMap &actions) |
void | SetAction (int actionID, const CGUIAction &action, bool replace=true) |
Set actions to perform on navigation Navigations are set if replace is true or if there is no previously set action. | |
CGUIAction | GetAction (int actionID) const |
Get an action the control can be perform. | |
bool | Navigate (int direction) const |
Start navigating in given direction. | |
virtual void | SetFocus (bool focus) |
virtual void | SetWidth (float width) |
virtual void | SetHeight (float height) |
virtual void | SetVisible (bool bVisible, bool setVisState=false) |
void | SetVisibleCondition (const std::string &expression, const std::string &allowHiddenFocus="") |
bool | HasVisibleCondition () const |
void | SetEnableCondition (const std::string &expression) |
virtual void | UpdateVisibility (const CGUIListItem *item) |
virtual void | SetInitialVisibility () |
virtual void | SetEnabled (bool bEnable) |
virtual void | SetPulseOnSelect (bool pulse) |
virtual std::string | GetDescriptionByIndex (int index) const |
void | SetAnimations (const std::vector< CAnimation > &animations) |
const std::vector< CAnimation > & | GetAnimations () const |
virtual void | QueueAnimation (ANIMATION_TYPE anim) |
virtual bool | IsAnimating (ANIMATION_TYPE anim) |
virtual bool | HasAnimation (ANIMATION_TYPE anim) |
CAnimation * | GetAnimation (ANIMATION_TYPE type, bool checkConditions=true) |
virtual void | ResetAnimation (ANIMATION_TYPE type) |
virtual void | ResetAnimations () |
virtual void | UpdateInfo (const CGUIListItem *item=NULL) |
virtual void | SetPushUpdates (bool pushUpdates) |
virtual bool | IsGroup () const |
virtual bool | IsContainer () const |
virtual bool | GetCondition (int condition, int data) const |
void | SetParentControl (CGUIControl *control) |
CGUIControl * | GetParentControl (void) const |
virtual void | SaveStates (std::vector< CControlState > &states) |
virtual CGUIControl * | GetControl (int id, std::vector< CGUIControl * > *idCollector=nullptr) |
void | SetControlStats (GUICONTROLSTATS *controlStats) |
virtual void | UpdateControlStats () |
GUICONTROLTYPES | GetControlType () const |
bool | IsControlRenderable () |
Test whether the control is "drawable" (not a group or similar) | |
Public Member Functions inherited from KODI::GAME::IFeatureButton | |
virtual | ~IFeatureButton ()=default |
virtual bool | AllowWizard () const |
Allow the wizard to include this feature in a list of buttons to map. | |
virtual bool | NeedsKey () const |
True if the button is waiting for a key press. | |
virtual void | SetKey (const CPhysicalFeature &key) |
Set the pressed key that the user will be prompted to map. | |
CGUIThrottleButton::CGUIThrottleButton | ( | const CGUIButtonControl & | buttonTemplate, |
IConfigurationWizard * | wizard, | ||
const CPhysicalFeature & | feature, | ||
unsigned int | index ) |
|
overridedefault |
|
overridevirtual |
Get the direction of the next throttle prompt.
Reimplemented from KODI::GAME::CGUIFeatureButton.
|
overridevirtual |
Check if the button supports further calls to PromptForInput()
Implements KODI::GAME::IFeatureButton.
Prompt the user for a single input element.
waitEvent | The event to block on while prompting for input |
After the button has finished prompting the user for all the input elements it requires, this will return false until Reset() is called.
Implements KODI::GAME::IFeatureButton.
|
overridevirtual |
Reset button after prompting for input has finished.
Implements KODI::GAME::IFeatureButton.