Class FlexFrame

GEOS-SC:  Library toolkit_lib: Class FlexFrame

This type of window is used mostly as a background for the contents of a main screen.

#include <toolkit/frame.h>

Class Data and Methods

public:
// FlexFrame members
FlexFrame();
~FlexFrame();
Result AddTitleListener(TitleListenerInterface& listener);
const TCHAR *GetTitle(void);
void RemoveTitleListener(TitleListenerInterface& listener);
void SetTitle(const TCHAR *title);
protected:

Inherited Data and Methods:
public:
void ComponentAdded (ComponentEvent& event) ; // pure virtual
void ComponentHidden (ComponentEvent& event) ; // pure virtual
void ComponentMoved (ComponentEvent& event) ; // pure virtual
void ComponentRemoving (ComponentEvent& event) ; // pure virtual
void ComponentResized (ComponentEvent& event) ; // pure virtual
void ComponentShown (ComponentEvent& event) ; // pure virtual
void ComponentVisible (ComponentEvent& event) ; // pure virtual
void ComponentNotVisible (ComponentEvent& event) ; // pure virtual
// FlexComponent members
enum HorizontalSizePreference;
enum VerticalSizePreference;
Result AddComponentListener(ComponentListenerInterface& listener);
Result AddFocusListener(FocusListenerInterface& listener);
Result AddKeyListener(KeyListenerInterface& listener);
Result AddMouseListener(MouseListenerInterface& listener);
Result AddMouseMotionListener(MouseMotionListenerInterface& listener);
void AddNotify(void);
Boolean Contains(WinCoord x, WinCoord y);
Boolean Contains(WinXYPoint& point);
void DelayedDelete(void);
void DoLayout(void);
Colorant GetBackground(void);
WinRectangle GetBounds(void) const;
FlexComponent *GetComponentAt(WinCoord x, WinCoord y, Boolean visibleOnly );
FlexComponent *GetComponentAt(WinXYPoint& point, Boolean visibleOnly );
Colorant GetForeground(void);
FlexComponentID GetID(void);
WinXYPoint GetLocation(void);
Dimension GetMinimumSize(void);
FlexContainer *GetParent(void) const;
FlexWindow *GetFlexWindowAncestor(void);
Dimension GetPreferredSize(void);
Dimension GetSize(void) const;
void GetSizePreference(HorizontalSizePreference &horizontalSizePref, VerticalSizePreference &verticalSizePref);
void Invalidate(void);
Boolean IsEnabled(void) const;
Boolean IsFocusTraversable(void);
Boolean IsShowing(void) const;
Boolean IsGeometryValid(void) const;
Boolean IsVisible(void) const;
void Paint(void);
void RemoveComponentListener(ComponentListenerInterface& listener);
void RemoveFocusListener(FocusListenerInterface& listener);
void RemoveKeyListener(KeyListenerInterface& listener);
void RemoveMouseListener(MouseListenerInterface& listener);
void RemoveMouseMotionListener(MouseMotionListenerInterface& listener);
void RemoveNotify(void);
void Repaint(void);
void Repaint(WinCoord x, WinCoord y, uint16 width, uint16 height);
void RequestFocus(void);
Result SetBackground(Colorant color);
void SetBounds(WinCoord x, WinCoord y, uint16 width, uint16 height);
void SetBounds(WinRectangle& rect);
void SetEnabled(Boolean enable);
Result SetForeground(Colorant color);
void SetID(FlexComponentID id);
void SetLocation(WinCoord x, WinCoord y);
void SetLocation(const WinXYPoint& point);
void SetSize(const Dimension& dimension);
void SetSize(uint16 width, uint16 height);
void SetSizePreference(HorizontalSizePreference horizontalSizePref, VerticalSizePreference verticalSizePref);
Result SetVisible(Boolean visible);
void TransferFocus(void);
void Update(WinCoord x, WinCoord y, uint16 width, uint16 height);
void Validate(void);
// Event processing methods
void ProcessActionEvent(ActionEvent& actionEvent);
void ProcessComponentEvent(ComponentEvent& componentEvent);
void ProcessFocusEvent(FocusEvent& focusEvent);
void ProcessKeyEvent(KeyEvent& keyEvent);
void ProcessMouseEvent(MouseEvent& mouseEvent);
void ProcessMouseMotionEvent(MouseEvent& mouseEvent);
// Graphical rendering methods
void *CopyArea(const WinRectangle *bounds) const;
WinCoord FontMetric( FontMetricInfo info, const TextState& textState ) const;
void BrushLine( WinXYPoint p1, WinXYPoint p2, Colorant lineCOlor, WinCoord penWidth );
void DrawLine( WinXYPoint p1, WinXYPoint p2, Colorant lineColor );
void DrawHLine( WinCoord xStart, WinCoord xEnd, WinCoord yCoord, Colorant lineColor );
void DrawVLine( WinCoord xCoord, WinCoord yStart, WinCoord yEnd, Colorant lineColor);
void DrawBitmap(const Bitmap& bitmap, WinXYPoint destUpLeft, Colorant color);
void DrawBitmap(const Bitmap& bitmap, WinXYPoint destUpLeft);
void DrawPoint( WinCoord xPos, WinCoord yPos, Colorant dotColor );
void DrawPoint( WinXYPoint point, Colorant dotColor );
void DrawString( const TCHAR string[], TextState& textState );
void DrawString( const TCHAR string[], int32 numChars, TextState& textState );
void DrawUIShape( const UIShape srcUIShape, const WinXYPoint& basePoint, Colorant fgColor, int16 parm0 , int16 parm1 , int16 parm2 , int16 parm3 );
void InvertUIShape( const UIShape srcUIShape, const WinXYPoint& basePoint, int16 parm0 , int16 parm1 , int16 parm2 , int16 parm3 );
void FillRect( WinCoord leftCorner, WinCoord topCorner, WinCoord rightCorner, WinCoord bottomCorner, Colorant fillColor );
void InvertRect( WinCoord leftCorner, WinCoord topCorner, WinCoord rightCorner, WinCoord bottomCorner );
void InvertLine( WinXYPoint p1, WinXYPoint p2 );
void InvertLine( WinCoord x1, WinCoord y1, WinCoord x2, WinCoord y2 );
void SetClipRect( const WinXYPoint& clipUpLeft, const WinXYPoint& clipLowRight );
void ClearClipRect(void);
void Render(Renderer& renderer);
WinCoord StringWidth( const TCHAR string[], const TextState& textState ) const;
WinCoord StringWidth( const TCHAR string[], int32 numChars, const TextState& textState ) const;
// FlexContainer members
Result Add(FlexComponent *child);
Result Add(FlexComponent *child, uint32 position);
Result Add(LayoutTagType tag, FlexComponent *child);
Result AddContainerListener(ContainerListenerInterface& listener);
uint32 FindFlexComponent(FlexComponent *child);
FlexComponent *GetFlexComponent(uint32 position);
FlexComponent *GetFlexComponent(uint32 position, LayoutTagType& tag);
uint32 GetFlexComponentCount(void);
FlexComponent** GetFlexComponents(void);
FocusManagerInterface *GetFocusManager(void);
LayoutManagerInterface *GetLayout(void);
LayoutTagType GetLayoutTag(uint32 position);
Insets GetInsets(void);
Result GetRelativeBounds(FlexComponent *descendant, WinRectangle &bounds);
Result GetRelativeLocation(FlexComponent *descendant, WinXYPoint point, WinXYPoint &location);
Boolean IsAncestorOf(FlexComponent *child);
FlexComponent *Remove(FlexComponent *child);
FlexComponent *Remove(uint32 position);
void RemoveAll(void);
void RemoveContainerListener(ContainerListenerInterface& listener);
FocusManagerInterface *RemoveFocusManager(void);
LayoutManagerInterface *RemoveLayout(void);
void SetFocusManager(FocusManagerInterface *focusManager);
void SetLayout(LayoutManagerInterface *layoutManager);
void SetLayoutTag(LayoutTagType tag, uint32 position);
// Event processing methods
void ProcessContainerEvent(ContainerEvent& containerEvent);
// FlexWindow members
Result AddWindowListener(WindowListenerInterface& listener);
FlexComponent *GetDefaultFocus(void) const;
Boolean IsMovable(void);
Boolean IsResizable(void);
void RemoveWindowListener(WindowListenerInterface& listener);
void SetDefaultFocus(const FlexComponent *defaultFocus);
void SetMovable(Boolean movable);
void SetResizable(Boolean resizable);
void ToBack(void);
void ToFront(void);
protected:
EC (static void EnsureInAppThread(void));
// FlexFrame members
Result AddTitleListener(TitleListenerInterface& listener);
const TCHAR *GetTitle(void);
void RemoveTitleListener(TitleListenerInterface& listener);
void SetTitle(const TCHAR *title);

Back to the top of FlexFrame

Ancestors

Inheritance tree for FlexFrame, in the order of the most derived to the most ancestral base class:

Italicized classes use protected inheritance.

Back to the top of FlexFrame

Descendants

Class is not inherited by any others.

Back to the top of FlexFrame

Descriptions of Class Data and Methods

FlexFrame();

Class constructor.

Prototype:

    FlexFrame();

Back to the top of FlexFrame

~FlexFrame();

Class destructor.

Prototype:

    ~FlexFrame();

Back to the top of FlexFrame

Result AddTitleListener(TitleListenerInterface& listener);

Registers a TitleListener to intercept title drawing events.

Parameters:

in listener
TitleListener to register.

Return value: FAILURE if there was not enough memory to store the listener.

See also: RemoveTitleListener()

Prototype:

    Result AddTitleListener(TitleListenerInterface& listener);

Back to the top of FlexFrame

const TCHAR *GetTitle(void);

Gets the frame's title text.

Return value: A pointer to the title string, or NULL.

See also: SetTitle()

Prototype:

    const TCHAR *GetTitle(void);

Back to the top of FlexFrame

void RemoveTitleListener(TitleListenerInterface& listener);

Unregisters a TitleListener.

Parameters:

in listener
TitleListener to unregister.

See also: AddTitleListener

Prototype:

    void RemoveTitleListener(TitleListenerInterface& listener);

Back to the top of FlexFrame

void SetTitle(const TCHAR *title);

Sets the frame's title text. The caller is responsible for maintaining the memory for the title (the title string is not copied into the frame).

This may cause the frame to repaint.

Parameters:

in title
Pointer to the new title string.

See also: GetTitle()

Prototype:

    void SetTitle(const TCHAR *title);

Back to the top of FlexFrame

Generated from source by Geoworks on Sat Dec 12 18:31:35 1998 .