Rogue Wave Views Gadgets Package API Reference Guide |
Rogue Wave Views Documentation Home |
Container class. More...
#include <ilviews/gadgets/vframe.h>
Public Types |
Public Member Functions | |
IlvViewFrame (IlvView *parent, const char *title, const IlvRect &rect, IlBoolean visible=IlTrue) | |
Constructor. More... | |
virtual void | closeFrame () |
Is called when the user closes the view frame. More... | |
IlvView * | getClient () const |
Returns the client view managed by the view frame. More... | |
virtual void | getClientBBox (IlvRect &bbox) const |
Returns the bounding box of the client view managed by the view frame. More... | |
int | getCurrentState () const |
The current frame state. More... | |
IlvDesktopManager * | getDesktopManager () const |
Returns the desktop manager that handles the frame. More... | |
IlvBitmap * | getIcon () const |
Returns the bitmap associated with the view frame. More... | |
IlvPopupMenu * | getMenu () const |
Returns the IlvPopupMenu object attached to the frame. More... | |
IlvDim | getMinHeight () const |
Returns the minimum height of the view frame. More... | |
IlvDim | getMinWidth () const |
Returns the minimum width of the view frame. More... | |
const char * | getTitle () const |
Returns the title of the view frame. More... | |
void | getTitleBarBBox (IlvRect &bbox) const |
Returns the bounding box of the title bar of the view frame. More... | |
virtual void | maximizeFrame () |
Is called to maximize the frame to make it fit the view of the desktop manager. More... | |
virtual void | minimizeFrame () |
Is called to minimize the frame so that only its title bar is visible. More... | |
void | registerClientView (IlvView *view) const |
Registers the specified view as a client view of this view frame. More... | |
virtual void | restoreFrame () |
Is called to restore the frame to its normal size. More... | |
void | setIcon (IlvBitmap *bitmap) |
Sets the bitmap associated with the view frame. More... | |
void | setMinHeight (IlvDim size) |
Sets the minimum height of the view frame. More... | |
void | setMinWidth (IlvDim size) |
Sets the minimum width of the view frame. More... | |
virtual void | setTitle (const char *title) |
Sets the title of the view frame. More... | |
void | showMenu (const IlvPoint &point) |
Displays the IlvPopupMenu object attached to the frame at the specified location. More... | |
void | unRegisterClientView (IlvView *view) const |
Unregisters the specified client view of the view frame. More... | |
Public Member Functions inherited from IlvGadgetContainer | |
IlvGadgetContainer (IlvDisplay *display, const char *name, const char *title, const IlvRect &rect, IlBoolean useacc=IlFalse, IlBoolean visible=IlTrue) | |
Constructor. More... | |
IlvGadgetContainer (IlvDisplay *display, const char *name, const char *title, const IlvRect &rect, IlUInt properties, IlBoolean useacc=IlFalse, IlBoolean visible=IlTrue, IlvSystemView transientFor=0) | |
Constructor. More... | |
IlvGadgetContainer (IlvAbstractView *parent, const IlvRect &rect, IlBoolean useacc=IlFalse, IlBoolean visible=IlTrue) | |
Constructor. More... | |
IlvGadgetContainer (IlvDisplay *display, IlvSystemView parent, const IlvRect &rect, IlBoolean useacc=IlFalse, IlBoolean visible=IlTrue) | |
Constructor. More... | |
IlvGadgetContainer (IlvDisplay *display, IlvSystemView window, IlBoolean useacc=IlFalse) | |
Constructor. More... | |
virtual IlBoolean | allowFocus (IlBoolean value) |
Specifies whether the container manages the focus. More... | |
virtual void | applyResize (IlFloat sx, IlFloat sy, IlBoolean redraw=IlTrue) |
Is called to carry out the resize events applying to the gadget container. More... | |
IlBoolean | autoResize (IlBoolean a) |
Sets the auto resize mode of the gadget container. More... | |
IlvButton * | getDefaultButton () const |
Returns the default button of the gadget container. More... | |
virtual IlvGraphic * | getFirstFocusGraphic () const |
Returns the first object that receives the focus in this container. More... | |
virtual IlvGraphic * | getFocus () const |
Returns the object that has the keyboard focus in the gadget container. More... | |
virtual IlvGraphic * | getGrab () const |
Returns the object that is currently grabbing events in the container. More... | |
virtual IlvGraphic * | getLastFocusGraphic () const |
Returns the last object that receives the focus in this container. More... | |
IlvLookFeelHandler * | getLookFeelHandler () const |
Returns the look and feel handler associated with this container. More... | |
virtual IlvGraphic * | getNextFocusGraphic (IlvGraphic *object) const |
Returns the next object that will receive the focus after the specified object. More... | |
IlvGraphic * | getOverriddenFocus () const |
Returns the object that will receive the focus after calling setFocus() . More... | |
virtual IlvGraphic * | getPreviousFocusGraphic (IlvGraphic *object) const |
Returns the previous object that received the focus before the specified object. More... | |
IlBoolean | isAutoResizing () const |
Indicates whether the gadget container gets resized when loading a file. More... | |
virtual IlBoolean | isFocusAllowed () const |
Indicates whether the focus is allowed in the container. More... | |
virtual void | moveFocusAfter (IlBoolean redraw=IlTrue) |
Is called to find the next focusable object. More... | |
virtual void | moveFocusBefore (IlBoolean redraw=IlTrue) |
Is called to find the previous focusable object. More... | |
void | overrideFocus (IlvGraphic *obj) |
Sets the object that will receive the focus after calling setFocus() . More... | |
virtual void | removeGrab () |
Cancels the grabbing settings defined with setGrab() . More... | |
void | setDefaultButton (IlvButton *button, IlBoolean redraw=IlTrue) |
Sets the default button of the gadget container. More... | |
virtual void | setFocus (IlvGraphic *graphic=0, IlBoolean redraw=IlTrue) |
Sets the focus to the specified object of the gadget container. More... | |
virtual void | setGrab (IlvGraphic *object) |
Sets the specified object as the grabbing object. More... | |
void | setLookFeelHandler (IlvLookFeelHandler *lfh) |
Sets the look and feel handler of this container. More... | |
Static Public Member Functions | |
static IlBoolean | IsShowingContentsWhileDragging () |
Indicates whether the entire contents of a view frame is drawn when the view frame is moved or resized. More... | |
static void | ShowContentsWhileDragging (IlBoolean value) |
Specifies whether the entire contents of a view frame is drawn when the view frame is moved or resized. More... | |
Container class.
Library: ilvadvgdt
The IlvViewFrame
class defines a special container that encapsulates a client view. It adds a title bar composed of an icon, a label, and several buttons to the client view. The client view is added to the view frame by creating it as a child view of the view frame. A frame can be in one of the three following states: normal, maximized, or minimized.
Example of an Application Using IlvViewFrame Objects
IlvDesktopManager
. This enumeration defines the various states that IlvViewFrame
objects can take.
IlvViewFrame::getCurrentState
. Enumerator | |
---|---|
IlvFrameNormalState |
The default state for a view frame. The client view is visible, and can be resized by dragging the view frame border.
|
IlvFrameMinimizedState |
In this state, only the title bar of the view frame is visible
|
IlvFrameMaximizedState |
In this state, the view frame occupies the entire desktop view and hides any other view frame.
|
IlvViewFrame::IlvViewFrame | ( | IlvView * | parent, |
const char * | title, | ||
const IlvRect & | rect, | ||
IlBoolean | visible = IlTrue |
||
) |
Constructor.
Initializes a new instance of the class IlvViewFrame
as a child view of parent.
parent | The parent view of the view frame. |
title | The view frame title. This title is displayed in the title bar of the view frame. |
rect | The size and position of the view frame. |
visible | Specifies whether the view frame should be visible. |
IlvViewFrame
must be linked to an IlvDesktopManager
object. If this is not the case, a desktop manager is automatically created by this constructor.
|
virtual |
Is called when the user closes the view frame.
The default implementation calls the destroy callbacks associated with the frame and its client view. To handle the destruction of a view frame you can either override this method in your own subclass of IlvViewFrame
, or use a destroy callback.
IlvView::setDestroyCallback
. IlvView* IlvViewFrame::getClient | ( | ) | const |
Returns the client view managed by the view frame.
0
if there is none.
|
virtual |
Returns the bounding box of the client view managed by the view frame.
bbox | The returned bounding box of the client view. |
int IlvViewFrame::getCurrentState | ( | ) | const |
The current frame state.
IlvFrameState
enumeration. IlvFrameState
, maximizeFrame
, minimizeFrame
, restoreFrame
. IlvDesktopManager* IlvViewFrame::getDesktopManager | ( | ) | const |
Returns the desktop manager that handles the frame.
IlvDesktopManager
. IlvBitmap* IlvViewFrame::getIcon | ( | ) | const |
IlvPopupMenu* IlvViewFrame::getMenu | ( | ) | const |
Returns the IlvPopupMenu
object attached to the frame.
The pop-up menu is displayed when the user clicks the icon of the title bar. This menu contains predefined items for changing the frame state. You can modify this menu by adding or removing items.
IlvPopupMenu
object used by the frame. showMenu
. IlvDim IlvViewFrame::getMinHeight | ( | ) | const |
Returns the minimum height of the view frame.
The view frame cannot be resized to a size smaller than its minimum dimensions.
setMinHeight
, getMinWidth
. IlvDim IlvViewFrame::getMinWidth | ( | ) | const |
Returns the minimum width of the view frame.
The view frame cannot be resized to a size smaller than its minimum dimensions.
setMinWidth
, getMinHeight
. const char* IlvViewFrame::getTitle | ( | ) | const |
Returns the title of the view frame.
The title is displayed in the title bar of the view frame.
setTitle
. void IlvViewFrame::getTitleBarBBox | ( | IlvRect & | bbox | ) | const |
Returns the bounding box of the title bar of the view frame.
bbox | The returned bounding box of the title bar. |
|
static |
Indicates whether the entire contents of a view frame is drawn when the view frame is moved or resized.
If this method returns IlFalse
, only the ghost image of the view frame is drawn when the view frame is moved or resized.
|
virtual |
Is called to maximize the frame to make it fit the view of the desktop manager.
|
virtual |
Is called to minimize the frame so that only its title bar is visible.
IlvFrameState
, restoreFrame
, maximizeFrame
. void IlvViewFrame::registerClientView | ( | IlvView * | view | ) | const |
Registers the specified view as a client view of this view frame.
A client view will forward some events to its view frame. This method is automatically called on the main client view of the view frame. You need to call this method if your main client view contains subviews. In this case, call this method giving each subview as parameter.
view | The view to be registered as a client view. |
unRegisterClientView
.
|
virtual |
Is called to restore the frame to its normal size.
IlvFrameState
, minimizeFrame
, maximizeFrame
. void IlvViewFrame::setIcon | ( | IlvBitmap * | bitmap | ) |
Sets the bitmap associated with the view frame.
The bitmap is displayed in the title bar of the view frame.
bitmap | The new bitmap. The old bitmap, if any, is unlocked, and the new one is locked. 0 is not a valid value. You must provide a valid pointer to an IlvBitmap object. |
void IlvViewFrame::setMinHeight | ( | IlvDim | size | ) |
Sets the minimum height of the view frame.
The view frame cannot be resized to a size smaller than its minimum dimensions.
size | The minimum height of this view frame. |
getMinHeight
, setMinWidth
. void IlvViewFrame::setMinWidth | ( | IlvDim | size | ) |
Sets the minimum width of the view frame.
The view frame cannot be resized to a size smaller than its minimum dimensions.
size | The minimum width of this view frame. |
getMinWidth
, setMinHeight
.
|
virtual |
|
static |
Specifies whether the entire contents of a view frame is drawn when the view frame is moved or resized.
value | A Boolean value specifying whether the entire contents of a view frame contents should be drawn when the view frame is moved or resized. |
IsShowingContentsWhileDragging
. void IlvViewFrame::showMenu | ( | const IlvPoint & | point | ) |
Displays the IlvPopupMenu
object attached to the frame at the specified location.
point | The location where the pop-up menu is displayed. |
getMenu
. void IlvViewFrame::unRegisterClientView | ( | IlvView * | view | ) | const |
Unregisters the specified client view of the view frame.
view | The view to be unregistered. |
registerClientView
. © Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.