AddressFieldButton Class Reference

Addressfield Button. This provides a visual representation of the current path of an item with buttons corresponding to each directory tree level of the address. More...

#include <address_field_button.h>

List of all members.

Public Member Functions

 AddressFieldButton (const os::Rect &cFrame, os::String label, os::Image *bitmap, os::Message *msg, uint32 nResizeMask=os::CF_FOLLOW_LEFT|os::CF_FOLLOW_TOP, uint32 nFlags=os::WID_WILL_DRAW|os::WID_CLEAR_BACKGROUND|os::WID_FULL_UPDATE_ON_RESIZE)
 AddressFieldButton Constructor. This initializes all of the internal variables and calculates the height of the font.
 ~AddressFieldButton ()
 Default Deconstructor. Deletes the _Private object allocated for drawing.
void MouseMove (const os::Point &cNewPos, int nCode, uint32 nButtons, os::Message *pcData)
 MouseMove Handler. This handles whether or not the mouse is over the button and when to start displaying the mouse over view of the button.
virtual void Paint (const os::Rect &cUpdate)
 Draw the Button. This draws the rounded button with its image and label.
virtual os::Point GetPreferredSize (bool bLargest) const
 Return the preferred size of the button.
virtual void AllDetached ()
 AllDetached Overloaded Function. When everything is detached, set the mouse over for the _Private object to false.

Private Attributes

_Privatem

Classes

class  _Private
 Private class used only by AddressFieldButton. More...


Detailed Description

Addressfield Button. This provides a visual representation of the current path of an item with buttons corresponding to each directory tree level of the address.

Todo:
This should be linked to the current EFileBrowser code listed in the source directory so that they do not become too distinct from each other.


Constructor & Destructor Documentation

AddressFieldButton::AddressFieldButton ( const os::Rect &  cFrame,
os::String  label,
os::Image *  bitmap,
os::Message *  msg,
uint32  nResizeMask = os::CF_FOLLOW_LEFT | os::CF_FOLLOW_TOP,
uint32  nFlags = os::WID_WILL_DRAW | os::WID_CLEAR_BACKGROUND | os::WID_FULL_UPDATE_ON_RESIZE 
)

AddressFieldButton Constructor. This initializes all of the internal variables and calculates the height of the font.

Warning:
Do not remove os:: namespace from parameter names or it will mess up the doxygen documentation.
Parameters:
cFrame Rectangular dimensions of the object. This is passed directly to os::Button.
label Label for the address field button.
bitmap Image associated with the button.
msg Message to send to the object. This is passed directly to os::Button.
nResizeMask Resize mask for the object. See os::Button definition for more information.
nFlags Flags for the button. See os::Button definition for more information.


Member Function Documentation

void AddressFieldButton::MouseMove ( const os::Point &  cNewPos,
int  nCode,
uint32  nButtons,
os::Message *  pcData 
)

MouseMove Handler. This handles whether or not the mouse is over the button and when to start displaying the mouse over view of the button.

Warning:
Do not remove os:: namespace from parameter names or it will mess up the doxygen documentation.

void AddressFieldButton::Paint ( const os::Rect &  cUpdate  )  [virtual]

Draw the Button. This draws the rounded button with its image and label.

Warning:
Do not remove os:: namespace from parameter names or it will mess up the doxygen documentation.
Parameters:
cUpdate The region of the window to update.


Member Data Documentation

_Private* AddressFieldButton::m [private]

Private class used only by AddressFieldButton. Pointer to our private class used by AddressFieldButton.


The documentation for this class was generated from the following files:
Generated on Sun Oct 26 21:16:31 2008 for Transferrer by  doxygen 1.5.1