![]() |
Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members
![]() |
#include <FXTopWindow.h>
Public Types | |
enum | { ID_RESTORE = FXShell::ID_LAST, ID_MAXIMIZE, ID_MINIMIZE, ID_FULLSCREEN, ID_CLOSE, ID_QUERY_DOCK, ID_LAST } |
Public Member Functions | |
virtual void | create () |
virtual void | detach () |
virtual void | destroy () |
virtual void | layout () |
virtual void | setFocus () |
virtual void | killFocus () |
virtual void | show () |
virtual void | hide () |
virtual void | show (FXuint placement) |
void | place (FXuint placement) |
virtual FXint | getDefaultWidth () |
virtual FXint | getDefaultHeight () |
FXbool | getWMBorders (FXint &left, FXint &right, FXint &top, FXint &bottom) |
virtual void | raise () |
virtual void | lower () |
virtual void | move (FXint x, FXint y) |
virtual void | resize (FXint w, FXint h) |
virtual void | position (FXint x, FXint y, FXint w, FXint h) |
virtual void | flash (FXbool yes) |
virtual FXbool | restore (FXbool notify=false) |
virtual FXbool | maximize (FXbool notify=false) |
virtual FXbool | minimize (FXbool notify=false) |
virtual FXbool | fullScreen (FXbool notify=false) |
virtual FXbool | stackingOrder (FXuint order) |
virtual FXbool | close (FXbool notify=false) |
FXbool | isMaximized () const |
FXbool | isMinimized () const |
FXbool | isFullScreen () const |
void | setTitle (const FXString &name) |
FXString | getTitle () const |
void | setPadTop (FXint pt) |
FXint | getPadTop () const |
void | setPadBottom (FXint pb) |
FXint | getPadBottom () const |
void | setPadLeft (FXint pl) |
FXint | getPadLeft () const |
void | setPadRight (FXint pr) |
FXint | getPadRight () const |
FXint | getHSpacing () const |
FXint | getVSpacing () const |
void | setHSpacing (FXint hs) |
void | setVSpacing (FXint vs) |
void | setPackingHints (FXuint ph) |
FXuint | getPackingHints () const |
void | setDecorations (FXuint decorations) |
FXuint | getDecorations () const |
FXIcon * | getIcon () const |
void | setIcon (FXIcon *ic) |
FXIcon * | getMiniIcon () const |
void | setMiniIcon (FXIcon *ic) |
virtual void | save (FXStream &store) const |
virtual void | load (FXStream &store) |
virtual | ~FXTopWindow () |
TopWindows are usually managed by a Window Manager under X11 and therefore borders and window-menus and other decorations like resize- handles are subject to the Window Manager's interpretation of the decoration hints. When a TopWindow is closed, it sends a SEL_CLOSE message to its target. The target should return 0 in response to this message if there is no objection to proceed with the closing of the window, and return 1 otherwise. After the SEL_CLOSE message has been sent and no objection was raised, the window will delete itself. When the session is closed, the window will send a SEL_SESSION_NOTIFY message to its target, allowing the application to write any unsaved data to the disk. If the target returns 0, then the system will proceed to close the session. Subsequently a SEL_SESSION_CLOSED will be received which causes the window to be closed with prejudice by calling the function close(false). When receiving a SEL_UPDATE, the target can update the title string of the window, so that the title of the window reflects the name of the document, for example. For convenience, TopWindow provides the same layout behavior as the Packer widget, as well as docking and undocking of toolbars. TopWindows can be owned by other windows, or be free-floating. Owned TopWindows will usually remain stacked on top of the owner windows. The lifetime of an owned window should not exceed that of the owner.
See also:
anonymous enum |
virtual FX::FXTopWindow::~FXTopWindow | ( | ) | [virtual] |
Destructor.
virtual void FX::FXTopWindow::create | ( | ) | [virtual] |
Create server-side resources.
Reimplemented from FX::FXShell.
Reimplemented in FX::FXMainWindow, FX::FXPrintDialog, FX::FXSplashWindow, and FX::FXToolBarShell.
virtual void FX::FXTopWindow::detach | ( | ) | [virtual] |
Detach the server-side resources for this window.
Reimplemented from FX::FXComposite.
Reimplemented in FX::FXSplashWindow.
virtual void FX::FXTopWindow::destroy | ( | ) | [virtual] |
virtual void FX::FXTopWindow::layout | ( | ) | [virtual] |
virtual void FX::FXTopWindow::setFocus | ( | ) | [virtual] |
virtual void FX::FXTopWindow::killFocus | ( | ) | [virtual] |
virtual void FX::FXTopWindow::show | ( | ) | [virtual] |
virtual void FX::FXTopWindow::hide | ( | ) | [virtual] |
Hide this window.
Reimplemented from FX::FXWindow.
Reimplemented in FX::FXDirDialog, FX::FXFileDialog, and FX::FXSplashWindow.
virtual void FX::FXTopWindow::show | ( | FXuint | placement | ) | [virtual] |
void FX::FXTopWindow::place | ( | FXuint | placement | ) |
Position the window based on placement.
virtual FXint FX::FXTopWindow::getDefaultWidth | ( | ) | [virtual] |
Return the default width of this window.
Reimplemented from FX::FXComposite.
Reimplemented in FX::FXSplashWindow, and FX::FXToolBarShell.
virtual FXint FX::FXTopWindow::getDefaultHeight | ( | ) | [virtual] |
Return the default height of this window.
Reimplemented from FX::FXComposite.
Reimplemented in FX::FXSplashWindow, and FX::FXToolBarShell.
Obtain border sizes added to our window by the window manager.
virtual void FX::FXTopWindow::raise | ( | ) | [virtual] |
virtual void FX::FXTopWindow::lower | ( | ) | [virtual] |
Move this window to the specified position in the parent's coordinates.
Reimplemented from FX::FXWindow.
virtual void FX::FXTopWindow::flash | ( | FXbool | yes | ) | [virtual] |
Flash the window to get user's attention.
Restore window to normal, return true if restored.
Maximize window, return true if maximized.
Minimize or iconify window, return true if minimized.
Make window full screen, return true if success.
Special stacking order level.
Close the window, return true if actually closed.
If notify=true, the target will receive a SEL_CLOSE message to determine if it is OK to close the window. If the target ignores the SEL_CLOSE message or returns 0, the window will be closed, and subsequently deleted. When the last main window has been closed, the application will receive an ID_QUIT message and will be closed.
FXbool FX::FXTopWindow::isMaximized | ( | ) | const |
Return true if maximized.
FXbool FX::FXTopWindow::isMinimized | ( | ) | const |
Return true if minimized.
FXbool FX::FXTopWindow::isFullScreen | ( | ) | const |
Return true if full screen.
void FX::FXTopWindow::setTitle | ( | const FXString & | name | ) |
Change window title.
FXString FX::FXTopWindow::getTitle | ( | ) | const [inline] |
Return window title.
void FX::FXTopWindow::setPadTop | ( | FXint | pt | ) |
Change top padding.
FXint FX::FXTopWindow::getPadTop | ( | ) | const [inline] |
void FX::FXTopWindow::setPadBottom | ( | FXint | pb | ) |
Change bottom padding.
FXint FX::FXTopWindow::getPadBottom | ( | ) | const [inline] |
Get bottom interior padding.
void FX::FXTopWindow::setPadLeft | ( | FXint | pl | ) |
Change left padding.
FXint FX::FXTopWindow::getPadLeft | ( | ) | const [inline] |
Get left interior padding.
void FX::FXTopWindow::setPadRight | ( | FXint | pr | ) |
Change right padding.
FXint FX::FXTopWindow::getPadRight | ( | ) | const [inline] |
Get right interior padding.
FXint FX::FXTopWindow::getHSpacing | ( | ) | const [inline] |
Return horizontal spacing between children.
FXint FX::FXTopWindow::getVSpacing | ( | ) | const [inline] |
Return vertical spacing between children.
void FX::FXTopWindow::setHSpacing | ( | FXint | hs | ) |
Change horizontal spacing between children.
void FX::FXTopWindow::setVSpacing | ( | FXint | vs | ) |
Change vertical spacing between children.
void FX::FXTopWindow::setPackingHints | ( | FXuint | ph | ) |
Change packing hints for children.
FXuint FX::FXTopWindow::getPackingHints | ( | ) | const |
Return packing hints for children.
void FX::FXTopWindow::setDecorations | ( | FXuint | decorations | ) |
Change title and border decorations.
FXuint FX::FXTopWindow::getDecorations | ( | ) | const |
Return current title and border decorations.
FXIcon* FX::FXTopWindow::getIcon | ( | ) | const [inline] |
void FX::FXTopWindow::setIcon | ( | FXIcon * | ic | ) |
FXIcon* FX::FXTopWindow::getMiniIcon | ( | ) | const [inline] |
Return window mini (title) icon.
void FX::FXTopWindow::setMiniIcon | ( | FXIcon * | ic | ) |
Change window mini (title) icon.
virtual void FX::FXTopWindow::save | ( | FXStream & | store | ) | const [virtual] |
Save to stream.
Reimplemented from FX::FXWindow.
Reimplemented in FX::FXChoiceBox, FX::FXColorDialog, FX::FXDirDialog, FX::FXFileDialog, FX::FXFontDialog, FX::FXPrintDialog, FX::FXReplaceDialog, FX::FXSplashWindow, FX::FXToolBarShell, and FX::FXWizard.
virtual void FX::FXTopWindow::load | ( | FXStream & | store | ) | [virtual] |
Load from stream.
Reimplemented from FX::FXWindow.
Reimplemented in FX::FXChoiceBox, FX::FXColorDialog, FX::FXDirDialog, FX::FXFileDialog, FX::FXFontDialog, FX::FXPrintDialog, FX::FXReplaceDialog, FX::FXSplashWindow, FX::FXToolBarShell, and FX::FXWizard.
![]() |