Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   

VCF::TransparentWindow Class Reference

#include <TransparentWindow.h>

Inheritance diagram for VCF::TransparentWindow:

VCF::Frame VCF::Control VCF::DelegatedContainer< Frame > VCF::UIComponent VCF::AbstractView VCF::Component VCF::View VCF::ObjectWithCallbacks VCF::Object List of all members.

Public Member Functions

 TransparentWindow (Frame *frame)
virtual ~TransparentWindow ()
virtual void setClientBounds (Rect *bounds)
 Sets the client bounds only.
virtual void close ()
 Closes the Frame.
virtual void setFrameStyle (const FrameStyleType &frameStyle)
 Sets the frame style @ see FrameStyleType.
virtual bool allowsActivation ()
 Indicates to the framework whether or not this frame should allow activation.
virtual void setIconImage (Image *icon)
 Sets the icon image.
virtual ImagegetIconImage ()
 Returns the current image for the frames icon.
virtual bool isActiveFrame ()
virtual void setBorderPath (Path *path)
 modifies the border of the frame to follow the series of points contained in the path.
void setAlpha (const double &alphaValue)
double getAlpha ()
void setAlphaImage (Image *img)
virtual void paint (GraphicsContext *context)
 Paints the control.

Protected Member Functions

void onClose (FrameEvent *e)
void postClose (Event *event)

Protected Attributes

TransparentWindowPeertransparentWndPeer_
WindowPeerwindowPeer_
ImagealphaImage_

Constructor & Destructor Documentation

VCF::TransparentWindow::TransparentWindow Frame frame  ) 
 

virtual VCF::TransparentWindow::~TransparentWindow  )  [virtual]
 


Member Function Documentation

virtual bool VCF::TransparentWindow::allowsActivation  )  [inline, virtual]
 

Indicates to the framework whether or not this frame should allow activation.

Som frames do not support becoming activated, for example the tooltip frame, or the frame that houses the dropdown list for the ComboBoxControl. Must be implemented by derived classes.

Implements VCF::Frame.

virtual void VCF::TransparentWindow::close  )  [virtual]
 

Closes the Frame.

Must be implemented by classes that derive from Frame.

Implements VCF::Frame.

double VCF::TransparentWindow::getAlpha  ) 
 

virtual Image* VCF::TransparentWindow::getIconImage  )  [inline, virtual]
 

Returns the current image for the frames icon.

Implements VCF::Frame.

virtual bool VCF::TransparentWindow::isActiveFrame  )  [inline, virtual]
 

Implements VCF::Frame.

void VCF::TransparentWindow::onClose FrameEvent e  )  [protected]
 

virtual void VCF::TransparentWindow::paint GraphicsContext context  )  [virtual]
 

Paints the control.

Called by the underlying windowing system whenever the control needs to be painted. Note that in some cases the GraphicsContext passed in to this method may not be the same pointer as the GraphicsContext that the control holds itself. During the paint() method you should only use the context value for all your drawing and not the one returned in getContext(). The value returned by getContext() should be used for drawing that takes place outside of the paint() method.

If the control allows paint notification, then the framework will fire an event to the BeforeControlPainted delegate prior to calling the control's paint() method. After the paint() method has returned, if the control allows paint notification, the framework will fire an event to the AfterControlPainted delegate. This allows outside observers to take part in the paint cycle, but beware that this does come at a bit of a cost, so use this feature sparingly.

Note: This should NEVER be called by programmers using the VCF, it will be called for you during the course of your applications native event loop, and is only here for providing custom drawing routines for controls. In other words: you implement it, you never call it yourself.

See also:
getAllowPaintNotification

Reimplemented from VCF::Frame.

void VCF::TransparentWindow::postClose Event event  )  [protected]
 

void VCF::TransparentWindow::setAlpha const double &  alphaValue  ) 
 

void VCF::TransparentWindow::setAlphaImage Image img  ) 
 

virtual void VCF::TransparentWindow::setBorderPath Path path  )  [virtual]
 

modifies the border of the frame to follow the series of points contained in the path.

Reimplemented from VCF::Frame.

virtual void VCF::TransparentWindow::setClientBounds Rect bounds  )  [virtual]
 

Sets the client bounds only.

Implements VCF::Frame.

virtual void VCF::TransparentWindow::setFrameStyle const FrameStyleType frameStyle  )  [inline, virtual]
 

Sets the frame style @ see FrameStyleType.

Implements VCF::Frame.

virtual void VCF::TransparentWindow::setIconImage Image icon  )  [inline, virtual]
 

Sets the icon image.

The behaviour of this is partially windowing system dependent, and some systems (Mac OSX, for example, or some X11 window managers) may choose to ignore this. However, typically the icon is displayed in the top left corner of the frame, in the non client area that houses the caption.

Implements VCF::Frame.


Member Data Documentation

Image* VCF::TransparentWindow::alphaImage_ [protected]
 

TransparentWindowPeer* VCF::TransparentWindow::transparentWndPeer_ [protected]
 

WindowPeer* VCF::TransparentWindow::windowPeer_ [protected]
 


The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information