Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FX::FXPopup Class Reference

Popup window is used as a container for transitional controls such as menu panes and other ephemeral windows. More...

#include <FXPopup.h>

Inheritance diagram for FX::FXPopup:
FX::FXShell FX::FXComposite FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject FX::FXMenuPane FX::FXMDIMenu FX::FXScrollPane

List of all members.

Public Types

enum  { ID_CHOICE = FXShell::ID_LAST, ID_LAST = ID_CHOICE+1000 }
- Public Types inherited from FX::FXShell
enum  { ID_LAYOUT = FXComposite::ID_LAST, ID_LAST }

Public Member Functions

long onPaint (FXObject *, FXSelector, void *)
long onFocusUp (FXObject *, FXSelector, void *)
long onFocusDown (FXObject *, FXSelector, void *)
long onFocusLeft (FXObject *, FXSelector, void *)
long onFocusRight (FXObject *, FXSelector, void *)
long onFocusNext (FXObject *, FXSelector, void *)
long onFocusPrev (FXObject *, FXSelector, void *)
long onEnter (FXObject *, FXSelector, void *)
long onLeave (FXObject *, FXSelector, void *)
long onMotion (FXObject *, FXSelector, void *)
long onMap (FXObject *, FXSelector, void *)
long onLayout (FXObject *, FXSelector, void *)
long onButtonPress (FXObject *, FXSelector, void *)
long onButtonRelease (FXObject *, FXSelector, void *)
long onUngrabbed (FXObject *, FXSelector, void *)
long onCmdUnpost (FXObject *, FXSelector, void *)
long onKeyPress (FXObject *, FXSelector, void *)
long onKeyRelease (FXObject *, FXSelector, void *)
long onCmdChoice (FXObject *, FXSelector, void *)
 FXPopup (FXWindow *owner, FXuint opts=POPUP_VERTICAL|FRAME_RAISED|FRAME_THICK, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 Construct popup pane.
virtual FXint getDefaultWidth ()
 Return the default width of this window.
virtual FXint getDefaultHeight ()
 Return the default height of this window.
virtual void layout ()
 Perform layout.
FXPopupgetPrevActive () const
 Return a pointer to the prior active popup.
FXPopupgetNextActive () const
 Return a pointer to the next active popup.
virtual void setFocus ()
 Move the focus to this window.
virtual void killFocus ()
 Remove the focus from this window.
virtual void show ()
 Show this window.
virtual void hide ()
 Hide this window.
void setFrameStyle (FXuint style)
 Change frame style.
FXuint getFrameStyle () const
 Return frame style.
FXint getBorderWidth () const
 Return border width.
void setHiliteColor (FXColor clr)
 Change highlight color.
FXColor getHiliteColor () const
 Return highlight color.
void setShadowColor (FXColor clr)
 Change shadow color.
FXColor getShadowColor () const
 Return shadow color.
void setBorderColor (FXColor clr)
 Change border color.
FXColor getBorderColor () const
 Return border color.
void setBaseColor (FXColor clr)
 Change base color.
FXColor getBaseColor () const
 Return base color.
virtual void popup (FXWindow *grabto, FXint x, FXint y, FXint w=0, FXint h=0)
 Popup the menu and grab to the given owner.
virtual void popdown ()
 Pop down the menu.
FXWindowgetGrabOwner () const
 Return current grab owner.
void setOrientation (FXuint orient)
 Change popup orientation.
FXuint getOrientation () const
 Return popup orientation.
void setShrinkWrap (FXbool flag)
 Change shrinkwrap mode.
FXbool getShrinkWrap () const
 Return shrinkwrap mode.
virtual FXbool doesSaveUnder () const
 Does save-unders.
virtual ~FXPopup ()
 Destructor.
- Public Member Functions inherited from FX::FXShell
long onConfigure (FXObject *, FXSelector, void *)
virtual void create ()
 Create server-side resources.
virtual void recalc ()
 Mark this window's layout as dirty.
virtual ~FXShell ()
 Destroy shell.
- Public Member Functions inherited from FX::FXComposite
long onCmdUpdate (FXObject *, FXSelector, void *)
 FXComposite (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 Constructor.
virtual void detach ()
 Detach server-side resources.
virtual void destroy ()
 Destroy server-side resources.
FXint maxChildWidth () const
 Return the width of the widest child window.
FXint maxChildHeight () const
 Return the height of the tallest child window.
virtual FXbool isComposite () const
 Overrides this virtual function to return true.
virtual ~FXComposite ()
 Destructor.
- Public Member Functions inherited from FX::FXWindow
long onUnmap (FXObject *, FXSelector, void *)
long onUpdate (FXObject *, FXSelector, void *)
long onMouseWheel (FXObject *, FXSelector, void *)
long onLeftBtnPress (FXObject *, FXSelector, void *)
long onLeftBtnRelease (FXObject *, FXSelector, void *)
long onMiddleBtnPress (FXObject *, FXSelector, void *)
long onMiddleBtnRelease (FXObject *, FXSelector, void *)
long onRightBtnPress (FXObject *, FXSelector, void *)
long onRightBtnRelease (FXObject *, FXSelector, void *)
long onSpaceBallMotion (FXObject *, FXSelector, void *)
long onSpaceBallButtonPress (FXObject *, FXSelector, void *)
long onSpaceBallButtonRelease (FXObject *, FXSelector, void *)
long onBeginDrag (FXObject *, FXSelector, void *)
long onEndDrag (FXObject *, FXSelector, void *)
long onDragged (FXObject *, FXSelector, void *)
long onDestroy (FXObject *, FXSelector, void *)
long onFocusSelf (FXObject *, FXSelector, void *)
long onFocusIn (FXObject *, FXSelector, void *)
long onFocusOut (FXObject *, FXSelector, void *)
long onSelectionLost (FXObject *, FXSelector, void *)
long onSelectionGained (FXObject *, FXSelector, void *)
long onSelectionRequest (FXObject *, FXSelector, void *)
long onClipboardLost (FXObject *, FXSelector, void *)
long onClipboardGained (FXObject *, FXSelector, void *)
long onClipboardRequest (FXObject *, FXSelector, void *)
long onDNDEnter (FXObject *, FXSelector, void *)
long onDNDLeave (FXObject *, FXSelector, void *)
long onDNDMotion (FXObject *, FXSelector, void *)
long onDNDDrop (FXObject *, FXSelector, void *)
long onDNDRequest (FXObject *, FXSelector, void *)
long onQueryHelp (FXObject *, FXSelector, void *)
long onQueryTip (FXObject *, FXSelector, void *)
long onCmdShow (FXObject *, FXSelector, void *)
long onCmdHide (FXObject *, FXSelector, void *)
long onUpdToggleShown (FXObject *, FXSelector, void *)
long onCmdToggleShown (FXObject *, FXSelector, void *)
long onCmdRaise (FXObject *, FXSelector, void *)
long onCmdLower (FXObject *, FXSelector, void *)
long onCmdEnable (FXObject *, FXSelector, void *)
long onCmdDisable (FXObject *, FXSelector, void *)
long onUpdToggleEnabled (FXObject *, FXSelector, void *)
long onCmdToggleEnabled (FXObject *, FXSelector, void *)
long onUpdYes (FXObject *, FXSelector, void *)
long onCmdDelete (FXObject *, FXSelector, void *)
 FXWindow (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 Constructor.
FXWindowgetParent () const
 Return a pointer to the parent window.
FXWindowgetOwner () const
 Return a pointer to the owner window.
FXWindowgetShell () const
 Return a pointer to the shell window.
FXWindowgetRoot () const
 Return a pointer to the root window.
FXWindowgetNext () const
 Return a pointer to the next (sibling) window, if any.
FXWindowgetPrev () const
 Return a pointer to the previous (sibling) window , if any.
FXWindowgetFirst () const
 Return a pointer to this window's first child window , if any.
FXWindowgetLast () const
 Return a pointer to this window's last child window, if any.
FXWindowgetFocus () const
 Return a pointer to the currently focused child window.
virtual WindowClass getWindowClass () const
 Get window class.
void setKey (FXuint k)
 Change window key.
FXuint getKey () const
 Return window key.
FXWindowgetChildWithKey (FXuint k) const
 Return child window with given window key.
void setTarget (FXObject *t)
 Set the message target object for this window.
FXObjectgetTarget () const
 Get the message target object for this window, if any.
void setSelector (FXSelector sel)
 Set the message identifier for this window.
FXSelector getSelector () const
 Get the message identifier for this window.
FXint getX () const
 Get this window's x-coordinate, in the parent's coordinate system.
FXint getY () const
 Get this window's y-coordinate, in the parent's coordinate system.
virtual FXint getWidthForHeight (FXint givenheight)
 Return width for given height.
virtual FXint getHeightForWidth (FXint givenwidth)
 Return height for given width.
void setX (FXint x)
 Set this window's x-coordinate, in the parent's coordinate system.
void setY (FXint y)
 Set this window's y-coordinate, in the parent's coordinate system.
void setWidth (FXint w)
 Set the window width; and flag the widget as being in need of layout by its parent.
void setHeight (FXint h)
 Set the window height; and flag the widget as being in need of layout by its parent.
void setLayoutHints (FXuint lout)
 Set layout hints for this window.
FXuint getLayoutHints () const
 Get layout hints for this window.
FXAccelTablegetAccelTable () const
 Return a pointer to the accelerator table.
void setAccelTable (FXAccelTable *acceltable)
 Set the accelerator table.
void addHotKey (FXHotKey code)
 Add a hot key.
void remHotKey (FXHotKey code)
 Remove a hot key.
void setHelpTag (const FXString &text)
 Change help tag for this widget.
const FXStringgetHelpTag () const
 Get the help tag for this widget.
FXbool isShell () const
 Return true if window is a shell window.
FXbool isOwnerOf (const FXWindow *window) const
 Return true if specified window is owned by this window.
FXbool isChildOf (const FXWindow *window) const
 Return true if specified window is ancestor of this window.
FXbool containsChild (const FXWindow *child) const
 Return true if this window contains child in its subtree.
FXWindowgetChildAt (FXint x, FXint y) const
 Return the child window at specified coordinates.
FXint numChildren () const
 Return the number of child windows for this window.
FXint indexOfChild (const FXWindow *window) const
 Return the index (starting from zero) of the specified child window, or -1 if the window is not a child or NULL.
FXWindowchildAtIndex (FXint index) const
 Return the child window at specified index, or NULL if the index is negative or out of range.
FXComposeContextgetComposeContext () const
 Return compose context.
void createComposeContext ()
 Create compose context.
void destroyComposeContext ()
 Destroy compose context.
FXbool cursorShown () const
 Is cursor shown.
void showCursor (FXbool flag=true)
 Show or hide the cursor.
void setDefaultCursor (FXCursor *cur)
 Set the default cursor for this window.
FXCursorgetDefaultCursor () const
 Return the default cursor for this window.
void setDragCursor (FXCursor *cur)
 Set the drag cursor for this window.
FXCursorgetDragCursor () const
 Return the drag cursor for this window.
FXbool getCursorPosition (FXint &x, FXint &y, FXuint &buttons) const
 Return the cursor position and mouse button-state.
FXbool setCursorPosition (FXint x, FXint y)
 Warp the cursor to the new position.
FXbool isActive () const
 Return true if the window is active.
virtual FXbool canFocus () const
 Return true if this window is a control capable of receiving the focus.
FXbool hasFocus () const
 Return true if this window has the focus.
FXbool inFocusChain () const
 Return true if this window is in focus chain.
virtual void changeFocus (FXWindow *child)
 Notification that focus moved to new child.
FXbool isDefault () const
 Return true if this is the default window.
virtual void setDefault (FXuchar flag=true)
 This changes the default window which responds to the Return key in a dialog.
FXWindowfindDefault () const
 Find default window among this window's children.
FXbool isInitial () const
 Return true if this is the initial default window.
void setInitial (FXbool flag=true)
 Make this window the initial default window.
FXWindowfindInitial () const
 Find inital default window among this window's children.
FXbool isEnabled () const
 Return true if this window is able to receive mouse and keyboard events.
virtual void enable ()
 Enable the window to receive mouse and keyboard events.
virtual void disable ()
 Disable the window from receiving mouse and keyboard events.
virtual void attach (FXID w)
 Attach foreign window handle to this window.
virtual void setShape (const FXRegion &region)
 Set window shape by means of region.
virtual void setShape (FXBitmap *bitmap)
 Set window shape by means of bitmap.
virtual void setShape (FXIcon *icon)
 Set window shape by means of icon.
virtual void clearShape ()
 Clear window shape.
virtual void raise ()
 Raise this window to the top of the stacking order.
virtual void lower ()
 Lower this window to the bottom of the stacking order.
virtual void move (FXint x, FXint y)
 Move the window immediately, in the parent's coordinate system.
virtual void resize (FXint w, FXint h)
 Resize the window to the specified width and height immediately, updating the server representation as well, if the window was realized.
virtual void position (FXint x, FXint y, FXint w, FXint h)
 Move and resize the window immediately, in the parent's coordinate system.
void forceRefresh ()
 Generate a SEL_UPDATE message for the window and its children.
virtual void reparent (FXWindow *father, FXWindow *other=NULL)
 Reparent this window under new father before other.
void scroll (FXint x, FXint y, FXint w, FXint h, FXint dx, FXint dy) const
 Scroll rectangle x,y,w,h by a shift of dx,dy.
void update (FXint x, FXint y, FXint w, FXint h) const
 Mark the specified rectangle to be repainted later.
void update () const
 Mark the entire window to be repainted later.
void repaint (FXint x, FXint y, FXint w, FXint h) const
 Process any outstanding repaint messages immediately, for the given rectangle.
void repaint () const
 Process any outstanding repaint messages immediately.
FXbool grabbed () const
 Return true if the window has been grabbed.
void grab ()
 Grab the mouse to this window; future mouse events will be reported to this window even while the cursor goes outside of this window.
void ungrab ()
 Release the mouse grab.
FXbool grabbedKeyboard () const
 Return true if active grab is in effect.
void grabKeyboard ()
 Grab keyboard device.
void ungrabKeyboard ()
 Ungrab keyboard device.
FXbool shown () const
 Return true if the window is shown.
FXbool underCursor () const
 Return true if the window is under the cursor.
FXbool hasSelection () const
 Return true if this window owns the primary selection.
FXbool acquireSelection (const FXDragType *types, FXuint numtypes)
 Try to acquire the primary selection, given a list of drag types.
FXbool releaseSelection ()
 Release the primary selection.
FXbool hasClipboard () const
 Return true if this window owns the clipboard.
FXbool acquireClipboard (const FXDragType *types, FXuint numtypes)
 Try to acquire the clipboard, given a list of drag types.
FXbool releaseClipboard ()
 Release the clipboard.
FXbool isDropEnabled () const
 Return true if this window is able to receive drops.
virtual void dropEnable ()
 Enable this window to receive drops.
virtual void dropDisable ()
 Disable this window from receiving drops.
FXbool isDragging () const
 Return true if a drag operaion has been initiated from this window.
FXbool beginDrag (const FXDragType *types, FXuint numtypes)
 Initiate a drag operation with a list of previously registered drag types.
FXbool handleDrag (FXint x, FXint y, FXDragAction action=DRAG_COPY)
 When dragging, inform the drop-target of the new position and the drag action.
FXDragAction endDrag (FXbool drop=true)
 Terminate the drag operation with or without actually dropping the data Returns the action performed by the target.
FXbool isDropTarget () const
 Return true if this window is the target of a drop.
void setDragRectangle (FXint x, FXint y, FXint w, FXint h, FXbool wantupdates=true) const
 When being dragged over, indicate that no further SEL_DND_MOTION messages are required while the cursor is inside the given rectangle.
void clearDragRectangle () const
 When being dragged over, indicate we want to receive SEL_DND_MOTION messages every time the cursor moves.
void acceptDrop (FXDragAction action=DRAG_ACCEPT) const
 When being dragged over, indicate acceptance or rejection of the dragged data.
FXDragAction didAccept () const
 The target accepted our drop.
void dropFinished (FXDragAction action=DRAG_REJECT) const
 Sent by the drop target in response to SEL_DND_DROP.
FXbool inquireDNDTypes (FXDNDOrigin origin, FXDragType *&types, FXuint &numtypes) const
 When being dragged over, inquire the drag types which are being offered.
FXbool offeredDNDType (FXDNDOrigin origin, FXDragType type) const
 When being dragged over, return true if we are offered the given drag type.
FXDragAction inquireDNDAction () const
 When being dragged over, return the drag action.
FXbool setDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *data, FXuint size) const
 Set DND data; the array must be allocated with allocElms() and ownership is transferred to the system.
FXbool setDNDData (FXDNDOrigin origin, FXDragType type, const FXString &string) const
 Set DND data from string value.
FXbool getDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *&data, FXuint &size) const
 Get DND data; the caller becomes the owner of the array and must free it with freeElms().
FXbool getDNDData (FXDNDOrigin origin, FXDragType type, FXString &string) const
 Get DND data into string value.
virtual FXbool contains (FXint parentx, FXint parenty) const
 Return true if window logically contains the given point.
void translateCoordinatesFrom (FXint &tox, FXint &toy, const FXWindow *fromwindow, FXint fromx, FXint fromy) const
 Translate coordinates from fromwindow's coordinate space to this window's coordinate space.
void translateCoordinatesTo (FXint &tox, FXint &toy, const FXWindow *towindow, FXint fromx, FXint fromy) const
 Translate coordinates from this window's coordinate space to towindow's coordinate space.
virtual void setBackColor (FXColor clr)
 Set window background color.
FXColor getBackColor () const
 Get background color.
virtual const FXchar * tr (const FXchar *text, const FXchar *hint=NULL, FXint count=-1) const FX_FORMAT(2)
 Translate message for localization; using the current FXTranslator, an attempt is made to translate the given message into the current language.
virtual void save (FXStream &store) const
 Save window to stream.
virtual void load (FXStream &store)
 Restore window from stream.
virtual ~FXWindow ()
 Destroy window.
- Public Member Functions inherited from FX::FXDrawable
FXVisualgetVisual () const
 Get the visual.
FXint getWidth () const
 Width of drawable.
FXint getHeight () const
 Height of drawable.
void setVisual (FXVisual *vis)
 Change visual.
virtual ~FXDrawable ()
 Cleanup.
- Public Member Functions inherited from FX::FXId
FXAppgetApp () const
 Get application.
FXID id () const
 Get XID handle.
void setUserData (FXptr ptr)
 Set user data pointer.
FXptr getUserData () const
 Get user data pointer.
virtual ~FXId ()
 Destructor.
- Public Member Functions inherited from FX::FXObject
const FXchar * getClassName () const
 Get class name of some object.
FXbool isMemberOf (const FXMetaClass *metaclass) const
 Check if object is member of metaclass.
virtual long tryHandle (FXObject *sender, FXSelector sel, void *ptr)
 Try handle message safely, catching certain exceptions.
virtual long onDefault (FXObject *, FXSelector, void *)
 Called for unhandled messages.
virtual ~FXObject ()
 Virtual destructor.

Protected Member Functions

virtual FXbool doesOverrideRedirect () const
void drawBorderRectangle (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
void drawRaisedRectangle (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
void drawSunkenRectangle (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
void drawRidgeRectangle (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
void drawGrooveRectangle (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
void drawDoubleRaisedRectangle (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
void drawDoubleSunkenRectangle (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
void drawFrame (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h)
- Protected Member Functions inherited from FX::FXShell
 FXShell (FXApp *a, FXuint opts, FXint x, FXint y, FXint w, FXint h)
 FXShell (FXWindow *own, FXuint opts, FXint x, FXint y, FXint w, FXint h)
- Protected Member Functions inherited from FX::FXComposite
 FXComposite (FXApp *a, FXVisual *vis)
 FXComposite (FXApp *a, FXWindow *own, FXuint opts, FXint x, FXint y, FXint w, FXint h)
- Protected Member Functions inherited from FX::FXWindow
 FXWindow (FXApp *a, FXVisual *vis)
 FXWindow (FXApp *a, FXWindow *own, FXuint opts, FXint x, FXint y, FXint w, FXint h)
void addColormapWindows ()
void remColormapWindows ()
- Protected Member Functions inherited from FX::FXDrawable
 FXDrawable (FXApp *a, FXint w, FXint h)
- Protected Member Functions inherited from FX::FXId
 FXId (FXApp *a)

Protected Attributes

FXWindowgrabowner
FXColor baseColor
FXColor hiliteColor
FXColor shadowColor
FXColor borderColor
FXint border

Detailed Description

Popup window is used as a container for transitional controls such as menu panes and other ephemeral windows.

One of its principal characteristics is that no other controls, except the ones inside the popup are capable of interaction. Any click outside of a popup will cause the popup to be closed. Contents of popups may be arranged vertically (POPUP_VERTICAL) or horizontally (POPUP_HORIZONTAL). The special POPUP_SHRINKWRAP option causes the application to recompute the size of the popup window based on its contents at the time it is shown, thus permitting dynamically changing content.


The documentation for this class was generated from the following file:

Copyright © 1997-2016 Jeroen van der Zijp