Pyro higlevel API
Classes | Public Types | Public Member Functions | Public Attributes | List of all members
os::ImageButton Class Reference

Imagebutton gui element... More...

Inheritance diagram for os::ImageButton:
os::Button os::Control os::View os::Invoker os::Handler

Classes

class  Private
 

Public Types

enum  ImageButton_Position {
  IB_TEXT_RIGHT = 0x0001,
  IB_TEXT_LEFT = 0x0002,
  IB_TEXT_TOP = 0x0003,
  IB_TEXT_BOTTOM = 0x0004
}
 Positions. More...
 
- Public Types inherited from os::Button
enum  InputMode {
  InputModeNormal,
  InputModeToggle,
  InputModeRadio
}
 

Public Member Functions

 ImageButton (Rect cFrame, const String &cName, const String &cLabel, Message *pcMessage, Image *pcBitmap, uint32 nTextPosition=ImageButton::IB_TEXT_BOTTOM, bool bShowFrames=false, bool bShowText=false, bool bMouse=false, uint32 nResizeMask=CF_FOLLOW_LEFT|CF_FOLLOW_TOP, uint32 nFlags=WID_WILL_DRAW|WID_FULL_UPDATE_ON_RESIZE)
 Initialize the imagebutton. More...
 
virtual ~ImageButton ()
 
uint32 GetTextPosition (void) const
 Gets the text postion... More...
 
void SetTextPosition (uint32 nTextPosition)
 Resests the text postion... More...
 
void SetImage (StreamableIO *pcStream)
 Load an image from a stream. More...
 
void SetImage (Image *pcImage)
 Sets the Image from another image... More...
 
ImageGetImage (void) const
 Gets the Image... More...
 
void ClearImage ()
 Clears the image... More...
 
virtual void Activated (bool)
 Hook called when the view gain or loose focus. More...
 
virtual void MouseDown (const Point &cPosition, uint32 nButton)
 Hook called by the system when a mouse button is pressed. More...
 
virtual void MouseMove (const Point &cNewPos, int nCode, uint32 nButtons, Message *pcData)
 Hook called by the system when the mouse is moved. More...
 
virtual void MouseUp (const Point &cPosition, uint32 nButton, Message *pcData)
 Hook called by the system when a mouse button is release. More...
 
virtual void Paint (const Rect &cUpdateRect)
 Called by the system update "damaged" areas of the view. More...
 
virtual Point GetPreferredSize (bool bLargest) const
 
ImageButtonoperator= (const ImageButton &)
 Copy an ImageButton. More...
 
virtual void _reserved1 ()
 
virtual void _reserved2 ()
 
virtual void _reserved3 ()
 
virtual void _reserved4 ()
 
virtual void _reserved5 ()
 
virtual void _reserved6 ()
 
virtual void _reserved7 ()
 
virtual void _reserved8 ()
 
virtual void _reserved9 ()
 
virtual void _reserved10 ()
 
- Public Member Functions inherited from os::Button
 Button (Rect cFrame, const String &cName, const String &cLabel, Message *pcMessage, uint32 nResizeMask=CF_FOLLOW_LEFT|CF_FOLLOW_TOP, uint32 nFlags=WID_WILL_DRAW|WID_CLEAR_BACKGROUND|WID_FULL_UPDATE_ON_RESIZE)
 
 ~Button ()
 
virtual void KeyDown (const char *pzString, const char *pzRawString, uint32 nQualifiers)
 Hook called by the system when a key is pressed while the view has focus. More...
 
virtual void KeyUp (const char *pzString, const char *pzRawString, uint32 nQualifiers)
 Hook called by the system when a key is released while the view has focus. More...
 
virtual void PostValueChange (const Variant &cNewValue)
 
virtual void LabelChanged (const String &cNewLabel)
 
virtual void EnableStatusChanged (bool bIsEnabled)
 
virtual bool Invoked (Message *pcMessage)
 Intercept outgoing messages. More...
 
void SetInputMode (InputMode eInputMode)
 
InputMode GetInputMode () const
 
- Public Member Functions inherited from os::Control
 Control (const Rect &cFrame, const String &cName, const String &cLabel, Message *pcMessage, uint32 nResizeMask, uint32 nFlags=WID_WILL_DRAW|WID_CLEAR_BACKGROUND)
 
 ~Control ()
 
virtual void AttachedToWindow (void)
 
virtual void DetachedFromWindow (void)
 
virtual bool PreValueChange (Variant *pcNewValue)
 
virtual void SetEnable (bool bEnabled)
 
virtual bool IsEnabled (void) const
 
virtual void SetLabel (const String &cLabel)
 
virtual String GetLabel (void) const
 
virtual void SetValue (Variant cValue, bool bInvoke=true)
 
virtual Variant GetValue () const
 
virtual void __CTRL_reserved1__ ()
 
virtual void __CTRL_reserved2__ ()
 
virtual void __CTRL_reserved3__ ()
 
virtual void __CTRL_reserved4__ ()
 
virtual void __CTRL_reserved5__ ()
 
- Public Member Functions inherited from os::View
 View (const Rect &cFrame, const String &cTitle, uint32 nResizeMask=CF_FOLLOW_LEFT|CF_FOLLOW_TOP, uint32 nFlags=WID_WILL_DRAW|WID_CLEAR_BACKGROUND)
 View constructor. More...
 
virtual ~View ()
 View destructor. More...
 
virtual void AllAttached ()
 
virtual void AllDetached ()
 
virtual void WindowActivated (bool bIsActive)
 Hook called when the window hosting this view gain or loose focus. More...
 
virtual void FrameMoved (const Point &cDelta)
 Virtual hook called by the system when the view is moved within it's parent. More...
 
virtual void FrameSized (const Point &cDelta)
 Virtual hook called by the system when the view is resized. More...
 
virtual void ViewScrolled (const Point &cDelta)
 Virtual hook called by the system when the view content is scrolled. More...
 
virtual void FontChanged (Font *pcNewFont)
 Called to notify the view that the font has changed. More...
 
virtual Point GetContentSize () const
 
virtual void WheelMoved (const Point &cDelta)
 Hook called by the system when the scroll-wheel is rotated. More...
 
virtual void AddChild (View *pcView, bool bAssignTabOrder=false)
 
void RemoveChild (View *pcChild)
 
void RemoveThis ()
 
ViewGetChildAt (const Point &cPos) const
 
ViewGetChildAt (int nIndex) const
 
ViewGetParent () const
 
ScrollBarGetVScrollBar () const
 
ScrollBarGetHScrollBar () const
 
WindowGetWindow () const
 
String GetTitle () const
 
virtual int GetTabOrder () const
 Get the keybord manouvering order. More...
 
virtual void SetTabOrder (int nOrder=NEXT_TAB_ORDER)
 Set the keyboard manouvering sorting order. More...
 
virtual const ShortcutKeyGetShortcut () const
 
virtual void SetShortcut (const ShortcutKey &cShortcut)
 Set keyboard shortcut. More...
 
virtual void SetShortcutFromLabel (const String &cLabel)
 Set keyboard shortcut from Label. More...
 
void SetContextMenu (Menu *pcMenu)
 Set popup menu for a View. More...
 
MenuGetContextMenu () const
 Get popup menu. More...
 
uint32 GetQualifiers () const
 
void GetMouse (Point *pcPosition, uint32 *pnButtons) const
 
void SetMousePos (const Point &cPosition)
 
void BeginDrag (Message *pcData, const Point &cOffset, const Bitmap *pcBitmap, Handler *pcReplyTarget=NULL)
 Start a drag and drop operation. More...
 
void BeginDrag (Message *pcData, const Point &cOffset, const Rect &cBounds, Handler *pcReplyTarget=NULL)
 Start a drag and drop operation. More...
 
void SetFlags (uint32 nFlags)
 
uint32 GetFlags (uint32 nMask=~0L) const
 
void SetResizeMask (uint32 nFlags)
 
uint32 GetResizeMask () const
 
void Show (bool bVisible=true)
 Show/hide a view and all it's children. More...
 
void Hide ()
 
bool IsVisible () const
 
virtual void MakeFocus (bool bFocus=true)
 
virtual bool HasFocus () const
 
Rect GetFrame () const
 
Rect GetBounds () const
 
Rect GetNormalizedBounds () const
 
float Width () const
 
float Height () const
 
Point GetLeftTop () const
 
virtual void SetFrame (const Rect &cRect, bool bNotifyServer=true)
 Set the size and position relative to the parent view. More...
 
virtual void MoveBy (const Point &cDelta)
 Move the view within the parent coordinate system. More...
 
virtual void MoveBy (float vDeltaX, float vDeltaY)
 
virtual void MoveTo (const Point &cPos)
 Set the views position within the parent coordinate system. More...
 
virtual void MoveTo (float x, float y)
 
virtual void ResizeBy (const Point &cDelta)
 
virtual void ResizeBy (float vDeltaW, float vDeltaH)
 
virtual void ResizeTo (const Point &cSize)
 Set a new absolute size for the view. More...
 
virtual void ResizeTo (float W, float H)
 Set a new absolute size for the view. More...
 
void SetDrawingRegion (const Region &cReg)
 Restrict rendering using a clipping region. More...
 
void ClearDrawingRegion ()
 Remove any previously assigned drawing region. More...
 
void SetShapeRegion (const Region &cReg)
 Define a non-square shape for the view. More...
 
void ClearShapeRegion ()
 Remove any previously assigned shape region. More...
 
virtual int ToggleDepth ()
 
Point ConvertFromParent (const Point &cPoint) const
 
void ConvertFromParent (Point *cPoint) const
 
Rect ConvertFromParent (const Rect &cRect) const
 
void ConvertFromParent (Rect *cRect) const
 
Point ConvertToWindow (const Point &cPoint) const
 
void ConvertToWindow (Point *cPoint) const
 
Rect ConvertToWindow (const Rect &cRect) const
 
void ConvertToWindow (Rect *cRect) const
 
Point ConvertFromWindow (const Point &cPoint) const
 
void ConvertFromWindow (Point *cPoint) const
 
Rect ConvertFromWindow (const Rect &cRect) const
 
void ConvertFromWindow (Rect *cRect) const
 
Point ConvertToScreen (const Point &cPoint) const
 
void ConvertToScreen (Point *cPoint) const
 
Rect ConvertToScreen (const Rect &cRect) const
 
void ConvertToScreen (Rect *cRect) const
 
Point ConvertFromScreen (const Point &cPoint) const
 
void ConvertFromScreen (Point *cPoint) const
 
Rect ConvertFromScreen (const Rect &cRect) const
 
void ConvertFromScreen (Rect *cRect) const
 
void Invalidate (const Rect &cRect, bool bRecurse=false)
 Add a rectangle to the damage list. More...
 
void Invalidate (bool bRecurse=false)
 Invalidate the whole view. More...
 
void Flush ()
 Flush the render queue. More...
 
void Sync ()
 Flush the render queue. More...
 
void SetDrawingMode (drawing_mode nMode)
 
drawing_mode GetDrawingMode () const
 
void SetFont (Font *pcFont)
 Change the views text font. More...
 
FontGetFont () const
 
void SetFgColor (int nRed, int nGreen, int nBlue, int nAlpha=255)
 
void SetFgColor (Color32_s sColor)
 
Color32_s GetFgColor () const
 
void SetBgColor (int nRed, int nGreen, int nBlue, int nAlpha=255)
 
void SetBgColor (Color32_s sColor)
 
Color32_s GetBgColor () const
 
void SetEraseColor (int nRed, int nGreen, int nBlue, int nAlpha=255)
 
void SetEraseColor (Color32_s sColor)
 
Color32_s GetEraseColor () const
 
void MovePenTo (const Point &cPos)
 
void MovePenTo (float x, float y)
 
void MovePenBy (const Point &cPos)
 
void MovePenBy (float x, float y)
 
Point GetPenPosition () const
 Get the current pen position. More...
 
void DrawLine (const Point &cToPoint)
 
void DrawLine (const Point &cFromPnt, const Point &cToPnt)
 
virtual void ScrollBy (const Point &cDelta)
 
virtual void ScrollBy (float vDeltaX, float vDeltaY)
 
virtual void ScrollTo (Point cTopLeft)
 
virtual void ScrollTo (float x, float y)
 
Point GetScrollOffset () const
 
void ScrollRect (const Rect &cSrcRect, const Rect &cDstRect)
 Copy a rectangle from one location to another within the view. More...
 
void FillRect (const Rect &cRect)
 
void FillRect (const Rect &cRect, Color32_s sColor)
 
void DrawBitmap (const Bitmap *pcBitmap, const Rect &cSrcRect, const Rect &cDstRect)
 Render a bitmap into the view. More...
 
void EraseRect (const Rect &cRect)
 
void DrawFrame (const Rect &cRect, uint32 nFlags)
 
void DrawRoundedFrame (const os::Rect &cReizeFrame=os::Rect(1, 4,-1,-4), const os::Color32_s &cColor=get_default_color(COL_SHADOW))
 
void DrawRoundedFrame (const os::Rect &cFrame, const os::Rect &cReizeFrame=os::Rect(1, 4,-1,-4), const os::Color32_s &cColor=get_default_color(COL_SHADOW))
 
void DrawString (const Point &cPos, const String &cString)
 
void DrawString (const String &cString)
 Render a text-string at the current pen position. More...
 
void DrawString (const char *pzStr, int Len=-1)
 
void DrawText (const Rect &cPos, const String &cString, uint32 nFlags=0)
 Render a text-string in a specified rectangle. More...
 
void DrawSelectedText (const Rect &cPos, const String &cString, const IPoint &cSel1, const IPoint &cSel2, uint32 nMode=SEL_CHAR, uint32 nFlags=0)
 
void GetSelection (const String &cClipboard="__system_clipboard__")
 
void GetTruncatedStrings (const char **pazStringArray, int nStringCount, uint32 nMode, float nWidth, char **pazResultArray) const
 
float GetStringWidth (const String &cString) const
 
float GetStringWidth (const char *pzString, int nLen=-1) const
 
void GetStringWidths (const char **apzStringArray, const int *anLengthArray, int nStringCount, float *avWidthArray) const
 
Point GetTextExtent (const String &cString, uint32 nFlags=0, int nTargetWidth=-1) const
 
int GetStringLength (const String &cString, float vWidth, bool bIncludeLast=false) const
 
int GetStringLength (const char *pzString, int nLen, float vWidth, bool bIncludeLast=false) const
 
void GetStringLengths (const char **apzStringArray, const int *anLengthArray, int nStringCount, float vWidth, int *anMaxLengthArray, bool bIncludeLast=false) const
 
void GetFontHeight (font_height *psHeight) const
 
void Ping (int nSize=0) const
 
void SetToolTip (const os::String &t)
 
os::String GetToolTip () const
 
Point ConvertToParent (const Point &cPoint) const
 Translate a os::Point into our parents coordinate system. More...
 
void ConvertToParent (Point *cPoint) const
 Translate a os::Point into our parents coordinate system. More...
 
Rect ConvertToParent (const Rect &cRect) const
 
void ConvertToParent (Rect *cRect) const
 
- Public Member Functions inherited from os::Handler
 Handler (const String &cName)
 Construct a handler. More...
 
virtual ~Handler ()
 Destructor. More...
 
virtual void TimerTick (int nID)
 Timer dispatch member. More...
 
virtual void HandleMessage (Message *pcMessage)
 Handle a message targeted at this handler. More...
 
String GetName () const
 Get the handlers name. More...
 
void SetName (const String &cName)
 Rename the handler. More...
 
LooperGetLooper () const
 Get a pointer to the looper this handler belongs to. More...
 
void SetNextHandler (Handler *pcNextHandler)
 Set a handler that should handle messages this handler is not interrested in. More...
 
HandlerGetNextHandler () const
 Get the next handler in a handler chain. More...
 
void AddFilter (MessageFilter *pcFilter)
 
void RemoveFilter (MessageFilter *pcFilter)
 
const MsgFilterListGetFilterList () const
 
const uint32 GetToken ()
 Get the handlers token. More...
 
- Public Member Functions inherited from os::Invoker
 Invoker ()
 Default constructor. More...
 
 Invoker (Message *pcMessage)
 Constructor. More...
 
 Invoker (Message *pcMessage, const Handler *pcHandler, const Looper *pcLooper=NULL)
 Constructor. More...
 
 Invoker (Message *pcMessage, const Messenger &cTarget)
 Constructor. More...
 
virtual ~Invoker ()
 Destructor. More...
 
virtual status_t SetMessage (Message *pcMessage)
 Assign a new message to the invoker. More...
 
MessageGetMessage () const
 Get the message currently assigned to the invoker. More...
 
uint32 GetCode () const
 Get the code field from the currently assigned message. More...
 
virtual void TargetChanged (const Messenger &cOldTarget)
 Virtual hook called by the system after the target has been changed. More...
 
virtual void MessageChanged (const Message &cOldMsg)
 Virtual hook called by the system after the message has been changed. More...
 
virtual status_t SetTarget (const Handler *pcHandler, const Looper *pcLooper=NULL)
 Set a new message target. More...
 
virtual status_t SetTarget (const Messenger &cMessenger)
 Set a new message target. More...
 
bool IsTargetLocal () const
 Check if the target lives in our process. More...
 
HandlerGetTarget (Looper **ppcLooper=NULL) const
 Get the current target. More...
 
Messenger GetMessenger () const
 Get the messenger used to target messages sendt by the invoker. More...
 
virtual status_t SetHandlerForReply (Handler *pcHandler)
 Set a reply target for messages sendt by this messenger. More...
 
HandlerGetHandlerForReply () const
 Get the current reply target for replies on messages sendt by the invoker. More...
 
virtual status_t Invoke (Message *pcMessage=NULL)
 Send the current message to the current target. More...
 

Public Attributes

enum
os::ImageButton::ImageButton_Position 
Positon
 

Detailed Description

Description:
Simple image pushbutton class...
Author
Rick Caudill ( cau07.nosp@m.30@c.nosp@m.up.ed.nosp@m.u)

Member Enumeration Documentation

Description:
These values are used to specify the positon of the image and label on the imagebutton.
Enumerator
IB_TEXT_RIGHT 

Sets the text to the right of the imagebutton.

IB_TEXT_LEFT 

Sets the text to the left of the imagebutton.

IB_TEXT_TOP 

Sets the text to the top of the imagebutton.

IB_TEXT_BOTTOM 

Sets the text to the bottom of the imagebutton.

Constructor & Destructor Documentation

ImageButton::ImageButton ( Rect  cFrame,
const String cName,
const String cLabel,
Message pcMessage,
Image pcBitmap,
uint32  nTextPosition = ImageButton::IB_TEXT_BOTTOM,
bool  bShowFrames = false,
bool  bShowText = false,
bool  bMouse = false,
uint32  nResizeMask = CF_FOLLOW_LEFT|CF_FOLLOW_TOP,
uint32  nFlags = WID_WILL_DRAW | WID_FULL_UPDATE_ON_RESIZE 
)
Description:
The imagebutton contructor initialize the local object.
Parameters
cFrame- The size and position of the imagebutton.
pzName- The name of the imagebutton.
pzLabel- The label of the imagebutton.
pcMessage- The message passed to the imagebutton.
pcImage- The bitmapimage for the imagebutton.
nTextPosition- The Position of the label and the image for the imagebutton.
bShowFrames- Determines whether the imagebutton will have frames or not.
bShowText- Determines whether the imagebutton will show the label or not.
bMouse- Determines whether the imagebutton will have mouseover abilities(this is not working yet).
nResizeMask- Determines what way the imagebutton will follow the rest of the window. Default is CF_FOLLOW_LEFT|CF_FOLLOW_TOP.
nFlags- Deteremines what flags will be sent to the imagebutton.
Author
Rick Caudill (cau07.nosp@m.30@c.nosp@m.up.ed.nosp@m.u) based on Andrew Keenan's ImageButton class

References os::ImageButton::Private::bMouseOver, os::ImageButton::Private::bShowFrame, os::ImageButton::Private::m_nTextPosition, os::ImageButton::Private::SetImage(), and os::Control::SetLabel().

ImageButton::~ImageButton ( )
virtual

Member Function Documentation

void ImageButton::_reserved1 ( )
virtual
void ImageButton::_reserved10 ( )
virtual
void ImageButton::_reserved2 ( )
virtual
void ImageButton::_reserved3 ( )
virtual
void ImageButton::_reserved4 ( )
virtual
void ImageButton::_reserved5 ( )
virtual
void ImageButton::_reserved6 ( )
virtual
void ImageButton::_reserved7 ( )
virtual
void ImageButton::_reserved8 ( )
virtual
void ImageButton::_reserved9 ( )
virtual
void ImageButton::Activated ( bool  bIsActive)
virtual
Description:
This is a callback member that can be overloaded by derived classes to learn when the view is activated and when it is deactivated. The bIsActive parameter tell whether the focus was lost or gained.
The view has focus when it is the active view in the active window.
Note:
This is a hook function that is called by the system to notify about an event. You should never call this member yourself.

The window is locked when this member is called.

Parameters
bIsActive- true if the view gain and false if it loose focus.
See Also
MakeFocus(), WindowActivated()
Author
Kurt Skauen (kurt@.nosp@m.athe.nosp@m.os.cx)

Reimplemented from os::Button.

References os::View::GetBounds(), os::View::GetWindow(), and Paint().

void ImageButton::ClearImage ( void  )
Description:
Clears the BitmapImage that is passed to the ImageButton.
Author
Rick Caudill (cau07.nosp@m.30@c.nosp@m.up.ed.nosp@m.u)

References os::View::Flush(), os::View::Invalidate(), and os::ImageButton::Private::SetImage().

Image * ImageButton::GetImage ( void  ) const
Description:
Gets the Image that is passed to the ImageButton.
Author
Rick Caudill (cau07.nosp@m.30@c.nosp@m.up.ed.nosp@m.u)

References os::ImageButton::Private::m_pcBitmap.

Referenced by operator=().

Point ImageButton::GetPreferredSize ( bool  bLargest) const
virtual
uint32 ImageButton::GetTextPosition ( void  ) const
Description:
Gets the text positon of the ImageButton.
Author
Rick Caudill (cau07.nosp@m.30@c.nosp@m.up.ed.nosp@m.u)

References os::ImageButton::Private::m_nTextPosition.

void ImageButton::MouseDown ( const Point cPosition,
uint32  nButtons 
)
virtual
Description:
This member is called from the window thread whenever a mouse button is clicked above the view. You can overload this member if your view need to know about mouse-down events.
A view will not automatically take focus when clicked so if you want that behaviour you must call MakeFocus() from an overloaded version of this member.
The default implementation of this member will call MouseDown() on it's parent view if one exists.
Parameters
cPositionMouse position in the views coordinate system at the time the mouse was pressed.
nButtonsIndex of the pressed button. Buttons start at 1 for the left button, 2 for the right button, 3 for the middle button. Additional buttons might be supported by the mouse driver and will then be assigned numbers from 4 and up.
See Also
MouseUp(), MouseMove(), WheelMoved()
Author
Kurt Skauen (kurt@.nosp@m.athe.nosp@m.os.cx)

Reimplemented from os::Button.

References os::Button::MouseDown().

void ImageButton::MouseMove ( const Point cNewPos,
int  nCode,
uint32  nButtons,
Message pcData 
)
virtual
Description:
This member is called from the window thread whenever the mouse is moved above the view or if the view has focus.
Oveload this member if your view need to handle mouse-move events.
The default implementation of this member will call MouseMove() on it's parent view if one exists.
Parameters
cNewPosNew mouse position given in the views coordinate system.
nCodeEnter/exit code. This is MOUSE_ENTERED when the mouse first enter the view, MOUSE_EXITED when the mouse leaves the view, MOUSE_INSIDE whenever the mouse move withing the boundary of the view and MOUSE_OUTSIDE when the mouse move outside the view (will only happen if the view has focus).
nButtonsBitmask telling which buttons that are currently pressed. Bit 0 is button 1 (left), bit 1 is button 2 (right), and bit 2 is button 3 (middle), and so on.
pcDataPointer to a Message object containing the dragged data if the user is in the middle of a drag and drop operation. Otherwise this pointer is NULL. Look at BeginDrag() for a more detailed description of the drag and drop system.
See Also
MouseDown(), MouseUp(), WheelMoved(), BeginDrag()
Author
Kurt Skauen (kurt@.nosp@m.athe.nosp@m.os.cx)

Reimplemented from os::Button.

References os::ImageButton::Private::bMouseOver, os::ImageButton::Private::bMouseTwo, os::View::Flush(), os::View::Invalidate(), os::MOUSE_ENTERED, os::MOUSE_EXITED, and os::Button::MouseMove().

void ImageButton::MouseUp ( const Point cPosition,
uint32  nButtons,
Message pcData 
)
virtual
Description:
This member is called from the window thread whenever a mouse button is released above the view. You can overload this member if your view need to know about mouse-up events or if your view support drag and drop.
If mouse-up was the result of ending a drag and drop operation the pcData member will point to a Message containing the dragged data. Look at BeginDrag() for a more detailed description of the drag and drop system.
The default implementation of this member will call MouseDown() on it's parent view if one exists.
Parameters
cPositionMouse position in the views coordinate system at the time the mouse was pressed.
nButtonsIndex of the pressed button. Buttons start at 1 for the left button, 2 for the right button, 3 for the middle button. Additional buttons might be supported by the mouse driver and will then be assigned numbers from 4 and up.
pcDataPointer to a Message object containing the dragged data if this mouse-up was the end of a drag and drop operation. If no data was dragged it will be NULL.
See Also
MouseDown(), MouseMove(), WheelMoved()
Author
Kurt Skauen (kurt@.nosp@m.athe.nosp@m.os.cx)

Reimplemented from os::Button.

References os::Button::MouseUp().

ImageButton & ImageButton::operator= ( const ImageButton cImageButton)
void ImageButton::Paint ( const Rect cUpdateRect)
virtual
Description:
Note:
Warning:
Parameters
cUpdateRectA rectangle enclosing all damaged areas. This is just a rough "worst-case", further fine-grained clipping will be performed by the Application Server to avoid updating non-damaged pixels and make the update as fast and flicker-free as possible.
See Also
Invalidate(), Flush()
Author
Kurt Skauen (kurt@.nosp@m.athe.nosp@m.os.cx)

Reimplemented from os::Button.

References os::Variant::AsBool(), os::ImageButton::Private::bMouseOver, os::ImageButton::Private::bMouseTwo, os::Rect::bottom, os::ImageButton::Private::bShowFrame, os::COL_NORMAL, os::View::ConvertToScreen(), DM_BLEND, DM_COPY, DM_OVER, os::Image::Draw(), os::View::DrawFrame(), os::View::DrawLine(), os::View::DrawText(), DTF_UNDERLINES, os::View::FillRect(), os::FRAME_RAISED, os::FRAME_RECESSED, os::get_default_color(), os::View::GetBounds(), os::View::GetFontHeight(), os::Window::GetFrame(), os::ImageButton::Private::GetGrayImage(), os::ImageButton::Private::GetImage(), os::Control::GetLabel(), os::Image::GetSize(), os::View::GetTextExtent(), os::Control::GetValue(), os::View::GetWindow(), os::View::HasFocus(), os::Rect::Height(), IB_TEXT_BOTTOM, IB_TEXT_LEFT, IB_TEXT_RIGHT, IB_TEXT_TOP, os::Control::IsEnabled(), os::Rect::left, os::font_height::line_gap, os::ImageButton::Private::m_nTextPosition, os::Rect::right, os::View::SetBgColor(), os::View::SetDrawingMode(), os::View::SetEraseColor(), os::View::SetFgColor(), os::Rect::top, os::Rect::Width(), os::Point::x, and os::Point::y.

Referenced by Activated().

void ImageButton::SetImage ( StreamableIO pcStream)
Description:
Reads the BitmapImage for the ImageButton from a data stream.
Parameters
pcStream- A StreamableIO data source for the Bitmap data.
Author
Kristian Van Der Vliet (vande.nosp@m.rs@l.nosp@m.iqwyd.nosp@m..com)

References os::ImageButton::Private::SetImage().

Referenced by os::FileRequester::FileRequester().

void ImageButton::SetImage ( Image pcImage)
Description:
Sets the Image for the ImageButton from another Image.
Parameters
pcImage- The image.
Author
Rick Caudill (cau07.nosp@m.30@c.nosp@m.up.ed.nosp@m.u)

References os::ImageButton::Private::SetImage().

void ImageButton::SetTextPosition ( uint32  nTextPosition)
Description:
Resests the text postion and then flushes the imagebutton.
Parameters
nTextPosition- int that holds the text position. Should be: ID_TEXT_BOTTOM, ID_TEXT_RIGHT, ID_TEXT_TOP, or ID_TEXT_LEFT.
Author
Rick Caudill (cau07.nosp@m.30@c.nosp@m.up.ed.nosp@m.u)

References os::View::Flush(), os::View::Invalidate(), and os::ImageButton::Private::m_nTextPosition.

Member Data Documentation

enum os::ImageButton::ImageButton_Position os::ImageButton::Positon