Pyro higlevel API
|
Simple push-button class. More...
Classes | |
class | Private |
Public Types | |
enum | InputMode { InputModeNormal, InputModeToggle, InputModeRadio } |
Public Member Functions | |
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 Point | GetPreferredSize (bool bLargest) const |
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 | MouseDown (const Point &cPosition, uint32 nButtons) |
Hook called by the system when a mouse button is pressed. More... | |
virtual void | MouseUp (const Point &cPosition, uint32 nButtons, Message *pcData) |
Hook called by the system when a mouse button is release. More... | |
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 | Activated (bool bIsActive) |
Hook called when the view gain or loose focus. More... | |
virtual void | Paint (const Rect &cUpdateRect) |
Called by the system update "damaged" areas of the view. 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 () |
View * | GetChildAt (const Point &cPos) const |
View * | GetChildAt (int nIndex) const |
View * | GetParent () const |
ScrollBar * | GetVScrollBar () const |
ScrollBar * | GetHScrollBar () const |
Window * | GetWindow () 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 ShortcutKey & | GetShortcut () 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... | |
Menu * | GetContextMenu () 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... | |
Font * | GetFont () 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... | |
Looper * | GetLooper () 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... | |
Handler * | GetNextHandler () const |
Get the next handler in a handler chain. More... | |
void | AddFilter (MessageFilter *pcFilter) |
void | RemoveFilter (MessageFilter *pcFilter) |
const MsgFilterList & | GetFilterList () 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... | |
Message * | GetMessage () 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... | |
Handler * | GetTarget (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... | |
Handler * | GetHandlerForReply () 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... | |
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 |
||
) |
References InputModeNormal, os::Button::Private::m_bClicked, and os::Button::Private::m_eInputMode.
Button::~Button | ( | ) |
|
virtual |
The window is locked when this member is called.
bIsActive | - true if the view gain and false if it loose focus. |
Reimplemented from os::View.
Reimplemented in os::ImageButton.
References os::View::Flush(), and os::View::Invalidate().
|
virtual |
Implements os::Control.
References os::View::Flush(), and os::View::Invalidate().
Button::InputMode Button::GetInputMode | ( | ) | const |
References os::Button::Private::m_eInputMode.
|
virtual |
Reimplemented from os::View.
Reimplemented in os::ImageButton.
References os::View::GetFontHeight(), os::Control::GetLabel(), os::View::GetTextExtent(), os::font_height::line_gap, os::Point::x, and os::Point::y.
Referenced by os::AlertView::AlertView(), and os::ProgressView::Layout().
|
virtual |
pcMessage | Pointer to the message that is about to be sendt. You can do any modification you like to this message (but never delete it). |
Reimplemented from os::Control.
References os::Control::Invoked().
|
virtual |
pzString | String containing a single UTF-8 encoded character. This is the character generated by the pressed key according to the current keymap accounting for any qualifiers that might be pressed. |
pzRawString | Same as pzString except that the key is converted without accounting for qualifiers. Ie. if 'A' is pressed while pressing <SHIFT> pzString will contain 'A' and pzRawString will contain 'a'. |
nQualifiers | Bitmask describing which qualifiers that was active when the key was pressed. |
Reimplemented from os::View.
References os::View::GetShortcut(), os::Control::GetValue(), InputModeNormal, InputModeToggle, os::Control::IsEnabled(), os::View::KeyDown(), os::Button::Private::m_eInputMode, os::View::MakeFocus(), os::Control::SetValue(), and VK_ENTER.
|
virtual |
Reimplemented from os::View.
References os::View::GetShortcut(), os::Control::GetValue(), InputModeNormal, os::Control::IsEnabled(), os::View::KeyDown(), os::View::KeyUp(), os::Button::Private::m_eInputMode, os::Control::SetValue(), and VK_ENTER.
|
virtual |
Reimplemented from os::Control.
References os::View::Flush(), and os::View::Invalidate().
Referenced by os::InputBox::Private::SetCancelButtonText(), and os::InputBox::Private::SetOkButtonText().
|
virtual |
cPosition | Mouse position in the views coordinate system at the time the mouse was pressed. |
nButtons | Index 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. |
Reimplemented from os::View.
Reimplemented in os::ImageButton.
References os::Rect::DoIntersect(), os::View::GetBounds(), os::Control::GetValue(), InputModeRadio, InputModeToggle, os::Control::IsEnabled(), os::Button::Private::m_bClicked, os::Button::Private::m_eInputMode, os::View::MakeFocus(), os::View::MouseDown(), and os::Control::SetValue().
Referenced by os::ImageButton::MouseDown().
|
virtual |
cNewPos | New mouse position given in the views coordinate system. |
nCode | Enter/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). |
nButtons | Bitmask 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. |
pcData | Pointer 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. |
Reimplemented from os::View.
Reimplemented in os::ImageButton.
References os::View::GetMouse(), InputModeNormal, os::Control::IsEnabled(), os::Button::Private::m_bClicked, os::Button::Private::m_eInputMode, os::MOUSE_OUTSIDE, os::View::MouseMove(), and os::Control::SetValue().
Referenced by os::ImageButton::MouseMove().
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. cPosition | Mouse position in the views coordinate system at the time the mouse was pressed. |
nButtons | Index 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. |
pcData | Pointer 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. |
Reimplemented from os::View.
Reimplemented in os::ImageButton.
References os::Control::GetValue(), InputModeNormal, os::Control::IsEnabled(), os::Button::Private::m_bClicked, os::Button::Private::m_eInputMode, os::View::MouseUp(), and os::Control::SetValue().
Referenced by os::ImageButton::MouseUp().
|
virtual |
cUpdateRect | A 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. |
Reimplemented from os::View.
Reimplemented in os::ImageButton.
References os::Variant::AsBool(), os::Rect::bottom, os::COL_FOCUS, os::COL_NORMAL, DM_COPY, DM_OVER, os::View::DrawFrame(), os::View::DrawLine(), os::View::DrawText(), DTF_ALIGN_CENTER, DTF_UNDERLINES, os::FRAME_RAISED, os::FRAME_RECESSED, os::get_default_color(), os::View::GetBounds(), os::Window::GetDefaultButton(), os::Control::GetLabel(), os::Control::GetValue(), os::View::GetWindow(), os::View::HasFocus(), os::Control::IsEnabled(), os::Rect::left, os::Rect::MoveTo(), os::Rect::Resize(), os::Rect::right, os::View::SetBgColor(), os::View::SetDrawingMode(), os::View::SetEraseColor(), os::View::SetFgColor(), and os::Rect::top.
|
virtual |
Reimplemented from os::Control.
References os::View::Flush(), and os::View::Invalidate().
void Button::SetInputMode | ( | InputMode | eInputMode | ) |
References os::View::Flush(), and os::Button::Private::m_eInputMode.