OpenXcom  1.0
Open-source clone of the original X-Com
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Protected Member Functions | List of all members
OpenXcom::ArrowButton Class Reference

Button with an arrow on it. More...

#include <ArrowButton.h>

Inheritance diagram for OpenXcom::ArrowButton:
OpenXcom::ImageButton OpenXcom::InteractiveSurface OpenXcom::Surface

Public Member Functions

 ArrowButton (ArrowShape shape, int width, int height, int x=0, int y=0)
 Creates a new arrow button with the specified size and position. More...
 
 ~ArrowButton ()
 Cleans up the arrow button. More...
 
void setColor (Uint8 color)
 Sets the arrow button's color. More...
 
void setShape (ArrowShape shape)
 Sets the arrow button's shape. More...
 
void setTextList (TextList *list)
 Sets the arrow button's list. More...
 
void think ()
 Handles the timers. More...
 
void scroll ()
 Scrolls the list.
 
void draw ()
 Draws the arrow button. More...
 
void mousePress (Action *action, State *state)
 Special handling for mouse presses. More...
 
void mouseRelease (Action *action, State *state)
 Special handling for mouse releases.
 
void mouseClick (Action *action, State *state)
 Special handling for mouse clicks.
 
- Public Member Functions inherited from OpenXcom::ImageButton
 ImageButton (int width, int height, int x=0, int y=0)
 Creates a new image button with the specified size and position. More...
 
virtual ~ImageButton ()
 Cleans up the image button.
 
void setColor (Uint8 color)
 Sets the image button's color. More...
 
Uint8 getColor () const
 Gets the image button's color. More...
 
void setGroup (ImageButton **group)
 Sets the image button's group. More...
 
void mousePress (Action *action, State *state)
 Special handling for mouse presses. More...
 
void mouseRelease (Action *action, State *state)
 Special handling for mouse releases.
 
void toggle (bool invert)
 Invert a button explicitly either ON or OFF. More...
 
- Public Member Functions inherited from OpenXcom::InteractiveSurface
 InteractiveSurface (int width, int height, int x=0, int y=0)
 Creates a new interactive surface with the specified size and position. More...
 
virtual ~InteractiveSurface ()
 Cleans up the interactive surface.
 
void setVisible (bool visible)
 Sets the surface's visibility. More...
 
virtual void handle (Action *action, State *state)
 Processes any pending events. More...
 
virtual void setFocus (bool focus)
 Sets the focus of this surface. More...
 
bool isFocused () const
 Gets the focus of this surface. More...
 
virtual void unpress (State *state)
 Unpresses the surface. More...
 
void onMouseClick (ActionHandler handler, Uint8 button=SDL_BUTTON_LEFT)
 Hooks an action handler to a mouse click on the surface. More...
 
void onMousePress (ActionHandler handler, Uint8 button=0)
 Hooks an action handler to a mouse press over the surface. More...
 
void onMouseRelease (ActionHandler handler, Uint8 button=0)
 Hooks an action handler to a mouse release over the surface. More...
 
void onMouseIn (ActionHandler handler)
 Hooks an action handler to moving the mouse into the surface. More...
 
void onMouseOver (ActionHandler handler)
 Hooks an action handler to moving the mouse over the surface. More...
 
void onMouseOut (ActionHandler handler)
 Hooks an action handler to moving the mouse out of the surface. More...
 
void onKeyboardPress (ActionHandler handler, SDLKey key=SDLK_ANY)
 Hooks an action handler to pressing a key when the surface is focused. More...
 
void onKeyboardRelease (ActionHandler handler, SDLKey key=SDLK_ANY)
 Hooks an action handler to releasing a key when the surface is focused. More...
 
virtual void mouseIn (Action *action, State *state)
 Processes a mouse hover in event. More...
 
virtual void mouseOver (Action *action, State *state)
 Processes a mouse hover event. More...
 
virtual void mouseOut (Action *action, State *state)
 Processes a mouse hover out event. More...
 
virtual void keyboardPress (Action *action, State *state)
 Processes a keyboard key press event. More...
 
virtual void keyboardRelease (Action *action, State *state)
 Processes a keyboard key release event. More...
 
void setListButton ()
 Check this surface to see if it's a textlist button. More...
 
- Public Member Functions inherited from OpenXcom::Surface
 Surface (int width, int height, int x=0, int y=0, int bpp=8)
 Creates a new surface with the specified size and position. More...
 
 Surface (const Surface &other)
 Creates a new surface from an existing one. More...
 
virtual ~Surface ()
 Cleans up the surface. More...
 
void loadScr (const std::string &filename)
 Loads an X-Com SCR graphic. More...
 
void loadSpk (const std::string &filename)
 Loads an X-Com SPK graphic. More...
 
void loadBdy (const std::string &filename)
 Loads a TFTD BDY graphic. More...
 
void loadImage (const std::string &filename)
 Loads a general image file. More...
 
void clear ()
 Clears the surface's contents. More...
 
void offset (int off, int min=-1, int max=-1, int mul=1)
 Offsets the surface's colors by a set amount. More...
 
void invert (Uint8 mid)
 Inverts the surface's colors. More...
 
virtual void blit (Surface *surface)
 Blits this surface onto another one. More...
 
virtual void initText (Font *, Font *, Language *)
 Initializes the surface's various text resources.
 
void copy (Surface *surface)
 Copies a portion of another surface into this one. More...
 
void drawRect (SDL_Rect *rect, Uint8 color)
 Draws a filled rectangle on the surface. More...
 
void drawRect (Sint16 x, Sint16 y, Sint16 w, Sint16 h, Uint8 color)
 Draws a filled rectangle on the surface. More...
 
void drawLine (Sint16 x1, Sint16 y1, Sint16 x2, Sint16 y2, Uint8 color)
 Draws a line on the surface. More...
 
void drawCircle (Sint16 x, Sint16 y, Sint16 r, Uint8 color)
 Draws a filled circle on the surface. More...
 
void drawPolygon (Sint16 *x, Sint16 *y, int n, Uint8 color)
 Draws a filled polygon on the surface. More...
 
void drawTexturedPolygon (Sint16 *x, Sint16 *y, int n, Surface *texture, int dx, int dy)
 Draws a textured polygon on the surface. More...
 
void drawString (Sint16 x, Sint16 y, const char *s, Uint8 color)
 Draws a string on the surface. More...
 
virtual void setPalette (SDL_Color *colors, int firstcolor=0, int ncolors=256)
 Sets the surface's palette. More...
 
SDL_Color * getPalette () const
 Returns the surface's 8bpp palette. More...
 
virtual void setX (int x)
 Sets the X position of the surface. More...
 
int getX () const
 Returns the position of the surface in the X axis. More...
 
virtual void setY (int y)
 Sets the Y position of the surface. More...
 
int getY () const
 Returns the position of the surface in the Y axis. More...
 
void setVisible (bool visible)
 Sets the surface's visibility. More...
 
bool getVisible () const
 Gets the surface's visibility. More...
 
void resetCrop ()
 Resets the cropping rectangle for the surface. More...
 
SDL_Rect * getCrop ()
 Gets the cropping rectangle for the surface. More...
 
void setPixel (int x, int y, Uint8 pixel)
 Changes the color of a pixel in the surface, relative to the top-left corner of the surface. More...
 
void setPixelIterative (int *x, int *y, Uint8 pixel)
 Changes the color of a pixel in the surface and returns the next pixel position. More...
 
Uint8 getPixel (int x, int y) const
 Returns the color of a specified pixel in the surface. More...
 
SDL_Surface * getSurface () const
 Returns the internal SDL_Surface for SDL calls. More...
 
int getWidth () const
 Returns the width of the surface. More...
 
virtual void setWidth (int width)
 Sets the width of the surface. More...
 
int getHeight () const
 Returns the height of the surface. More...
 
virtual void setHeight (int height)
 Sets the height of the surface. More...
 
void setHidden (bool hidden)
 Sets the surface's special hidden flag. More...
 
void lock ()
 Locks the surface. More...
 
void unlock ()
 Unlocks the surface. More...
 
void blitNShade (Surface *surface, int x, int y, int off, bool half=false, int newBaseColor=0)
 Specific blit function to blit battlescape terrain data in different shades in a fast way. More...
 
void invalidate ()
 Invalidate the surface: force it to be redrawn. More...
 
std::string getTooltip () const
 Gets the tooltip of the surface. More...
 
void setTooltip (const std::string &tooltip)
 Sets the tooltip of the surface. More...
 

Protected Member Functions

bool isButtonHandled (Uint8 button=0)
 Is this mouse button event handled?
 
- Protected Member Functions inherited from OpenXcom::InteractiveSurface
bool isButtonPressed (Uint8 button=0)
 Is this mouse button pressed?
 
void setButtonPressed (Uint8 button, bool pressed)
 Set a mouse button's internal state.
 
- Protected Member Functions inherited from OpenXcom::Surface
void resize (int width, int height)
 Recreates the surface with a new size. More...
 

Detailed Description

Button with an arrow on it.

Can be used for scrolling lists, spinners, etc. Contains various arrow shapes.

Constructor & Destructor Documentation

OpenXcom::ArrowButton::ArrowButton ( ArrowShape  shape,
int  width,
int  height,
int  x = 0,
int  y = 0 
)

Creates a new arrow button with the specified size and position.

Sets up an arrow button with the specified size and position.

Parameters
shapeShape of the arrow.
widthWidth in pixels.
heightHeight in pixels.
xX position in pixels.
yY position in pixels.
OpenXcom::ArrowButton::~ArrowButton ( )

Cleans up the arrow button.

Deletes timers.

Member Function Documentation

void OpenXcom::ArrowButton::draw ( )
virtual

Draws the arrow button.

Draws the button with the specified arrow shape.

Reimplemented from OpenXcom::Surface.

void OpenXcom::ArrowButton::mousePress ( Action action,
State state 
)
virtual

Special handling for mouse presses.

Starts scrolling the associated list.

Parameters
actionPointer to an action.
stateState that the action handlers belong to.

Reimplemented from OpenXcom::InteractiveSurface.

void OpenXcom::ArrowButton::setColor ( Uint8  color)

Sets the arrow button's color.

Changes the color for the image button.

Parameters
colorColor value.
void OpenXcom::ArrowButton::setShape ( ArrowShape  shape)

Sets the arrow button's shape.

Changes the shape for the arrow button.

Parameters
shapeShape of the arrow.
void OpenXcom::ArrowButton::setTextList ( TextList list)

Sets the arrow button's list.

Changes the list associated with the arrow button.

This makes the button scroll that list.

Parameters
listPointer to text list.
void OpenXcom::ArrowButton::think ( )
virtual

Handles the timers.

Keeps the scrolling timers running.

Reimplemented from OpenXcom::Surface.


The documentation for this class was generated from the following files: