Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Friends

uiMainWin Class Reference

Inheritance diagram for uiMainWin:
uiParent uiBaseObject NamedObject CallBacker uiDialog uiVirtualKeyboard uiSelFonts uiSetFonts

List of all members.

Classes

class  Setup

Public Types

enum  Dock {
  Top, Bottom, Right, Left,
  Minimized, TornOff, Unmanaged
}
 

Dock Selector.

More...
enum  PopupArea {
  TopLeft, TopRight, BottomLeft, BottomRight,
  Middle
}
enum  ActModalTyp {
  None = 0, Main, Message, File,
  Colour, Font, Unknown
}

Public Member Functions

 uiMainWin (uiParent *, const uiMainWin::Setup &)
 uiMainWin (uiParent *, const char *nm="uiMainWin", int nrstatusflds=1, bool withmenubar=true, bool modal=false)
virtual ~uiMainWin ()
uiStatusBarstatusBar ()
uiMenuBarmenuBar ()
void setCaption (const char *)
const char * caption (bool unique=false) const
void setIcon (const ioPixmap &)
 Default icon is set in uiMain.
void setIconText (const char *)
virtual void show ()
void close ()
void raise ()
void showMaximized ()
void showMinimized ()
void showNormal ()
bool isMaximized () const
bool isMinimized () const
bool isHidden () const
bool isModal () const
void setSensitive (bool yn)
void toStatusBar (const char *, int fldidx=0, int msecs=-1)
virtual void reDraw (bool deep)
uiGrouptopGroup ()
void setShrinkAllowed (bool yn)
bool shrinkAllowed ()
void setExitAppOnClose (bool yn)
 automatically set by uiMain::setTopLevel
void setDeleteOnClose (bool yn)
void removeDockWindow (uiDockWin *)
void addDockWindow (uiDockWin &, Dock)
void addToolBar (uiToolBar *)
void removeToolBar (uiToolBar *)
void addToolBarBreak ()
uiPopupMenugetToolbarsMenu () const
void updateToolbarsMenu ()
const ObjectSet< uiToolBar > & toolBars () const
const ObjectSet< uiDockWin > & dockWins () const
void setPopupArea (PopupArea pa)
PopupArea getPopupArea () const
void setCornerPos (int x, int y)
uiRect geometry (bool frame=true) const
 Position of top-left corner in screen pixel coords.
bool poppedUp () const
bool touch ()
 resets pop-up timer if !poppedUp yet
bool finalised () const
virtual uiMainWinmainwin ()
QWidget * qWidget () const
uiParentparent ()
const uiParentparent () const
void translate ()
bool grab (const char *filenm, int zoom=1, const char *format=0, int quality=-1) const
void activateInGUIThread (const CallBack &, bool busywait=true)

Static Public Member Functions

static uiMainWinactiveWindow ()
static void provideHelp (const char *winid=0)
static void showCredits (const char *winid=0)
static uiMainWingtUiWinIfIsBdy (QWidget *mwimpl)
 get uiMainWin for mwimpl if it is a uiMainWinBody
static ActModalTyp activeModalType ()
static uiMainWinactiveModalWindow ()
static const char * activeModalQDlgTitle ()
static const char * activeModalQDlgButTxt (int butnr)
static int activeModalQDlgRetVal (int butnr)
static void closeActiveModalQDlg (int retval)
static void getModalSignatures (BufferStringSet &)
static void getTopLevelWindows (ObjectSet< uiMainWin > &, bool visibleonly=true)
static const char * uniqueWinTitle (const char *txt, QWidget *forwindow=0)
static void programActiveWindow (uiMainWin *)
static uiMainWinprogrammedActiveWindow ()

Public Attributes

Notifier< uiMainWinwindowClosed
 triggered when window exits
Notifier< uiMainWinactivatedone

Protected Member Functions

virtual bool closeOK ()
 confirm window close
 uiMainWin (const char *, uiParent *)
uiObjectmainobject ()
void saveSettings ()
void readSettings ()

Protected Attributes

uiMainWinBody * body_
uiParentparent_
PopupArea popuparea_
BufferString caption_

Friends

class uiMainWinBody

Member Enumeration Documentation

Enumerator:
None 
Main 
Message 
File 
Colour 
Font 
Unknown 

Dock Selector.

Enumerator:
Top 

above the central uiGroup, below the menubar.

Bottom 

below the central uiGroup, above the status bar.

Right 

to the right of the central uiGroup.

Left 

to the left of the central uiGroup.

Minimized 

the toolbar is not shown - all handles of minimized toolbars are drawn in one row below the menu bar.

TornOff 

the dock window floats as its own top level window which always stays on top of the main window.

Unmanaged 

not managed by a uiMainWin

Enumerator:
TopLeft 
TopRight 
BottomLeft 
BottomRight 
Middle 

Constructor & Destructor Documentation

uiMainWin::uiMainWin ( uiParent ,
const uiMainWin::Setup  
)
uiMainWin::uiMainWin ( uiParent ,
const char *  nm = "uiMainWin",
int  nrstatusflds = 1,
bool  withmenubar = true,
bool  modal = false 
)
virtual uiMainWin::~uiMainWin (  )  [virtual]
uiMainWin::uiMainWin ( const char *  ,
uiParent  
) [protected]

Member Function Documentation

void uiMainWin::activateInGUIThread ( const CallBack ,
bool  busywait = true 
)
static const char* uiMainWin::activeModalQDlgButTxt ( int  butnr  )  [static]
static int uiMainWin::activeModalQDlgRetVal ( int  butnr  )  [static]
static const char* uiMainWin::activeModalQDlgTitle (  )  [static]
static ActModalTyp uiMainWin::activeModalType (  )  [static]
static uiMainWin* uiMainWin::activeModalWindow (  )  [static]
static uiMainWin* uiMainWin::activeWindow (  )  [static]
void uiMainWin::addDockWindow ( uiDockWin ,
Dock   
)
void uiMainWin::addToolBar ( uiToolBar  ) 
void uiMainWin::addToolBarBreak (  ) 
const char* uiMainWin::caption ( bool  unique = false  )  const
void uiMainWin::close (  ) 
static void uiMainWin::closeActiveModalQDlg ( int  retval  )  [static]
virtual bool uiMainWin::closeOK (  )  [inline, protected, virtual]

confirm window close

const ObjectSet<uiDockWin>& uiMainWin::dockWins (  )  const
bool uiMainWin::finalised (  )  const

Reimplemented from uiBaseObject.

uiRect uiMainWin::geometry ( bool  frame = true  )  const

Position of top-left corner in screen pixel coords.

static void uiMainWin::getModalSignatures ( BufferStringSet  )  [static]
PopupArea uiMainWin::getPopupArea (  )  const [inline]
uiPopupMenu& uiMainWin::getToolbarsMenu (  )  const
static void uiMainWin::getTopLevelWindows ( ObjectSet< uiMainWin > &  ,
bool  visibleonly = true 
) [static]
bool uiMainWin::grab ( const char *  filenm,
int  zoom = 1,
const char *  format = 0,
int  quality = -1 
) const

zoom=0: grab desktop, zoom=1: grab this window, zoom=2: grab active modal window/qdialog, format = .bpm|.jpg|.jpeg|.png|.ppm|.xbm|.xpm format=0: use filenm suffix quality = 0...100: small compressed to large uncompressed file, quality=-1: use default

static uiMainWin* uiMainWin::gtUiWinIfIsBdy ( QWidget *  mwimpl  )  [static]

get uiMainWin for mwimpl if it is a uiMainWinBody

bool uiMainWin::isHidden (  )  const
bool uiMainWin::isMaximized (  )  const
bool uiMainWin::isMinimized (  )  const
bool uiMainWin::isModal (  )  const

Reimplemented in uiDialog.

uiObject* uiMainWin::mainobject (  )  [protected, virtual]

Reimplemented from uiParent.

virtual uiMainWin* uiMainWin::mainwin (  )  [inline, virtual]

Reimplemented from uiParent.

uiMenuBar* uiMainWin::menuBar (  ) 
uiParent* uiMainWin::parent (  )  [inline]
const uiParent* uiMainWin::parent (  )  const [inline]
bool uiMainWin::poppedUp (  )  const
static void uiMainWin::programActiveWindow ( uiMainWin  )  [static]
static uiMainWin* uiMainWin::programmedActiveWindow (  )  [static]
static void uiMainWin::provideHelp ( const char *  winid = 0  )  [static]
QWidget* uiMainWin::qWidget (  )  const
void uiMainWin::raise (  ) 
void uiMainWin::readSettings (  )  [protected]
virtual void uiMainWin::reDraw ( bool  deep  )  [virtual]

Reimplemented from uiParent.

void uiMainWin::removeDockWindow ( uiDockWin  ) 
void uiMainWin::removeToolBar ( uiToolBar  ) 
void uiMainWin::saveSettings (  )  [protected]
void uiMainWin::setCaption ( const char *   ) 

Reimplemented from uiParent.

Reimplemented in uiDialog.

void uiMainWin::setCornerPos ( int  x,
int  y 
)
void uiMainWin::setDeleteOnClose ( bool  yn  ) 
void uiMainWin::setExitAppOnClose ( bool  yn  ) 

automatically set by uiMain::setTopLevel

void uiMainWin::setIcon ( const ioPixmap  ) 

Default icon is set in uiMain.

void uiMainWin::setIconText ( const char *   ) 
void uiMainWin::setPopupArea ( PopupArea  pa  )  [inline]
void uiMainWin::setSensitive ( bool  yn  ) 

Reimplemented from uiParent.

void uiMainWin::setShrinkAllowed ( bool  yn  ) 
virtual void uiMainWin::show (  )  [virtual]
static void uiMainWin::showCredits ( const char *  winid = 0  )  [static]
void uiMainWin::showMaximized (  ) 
void uiMainWin::showMinimized (  ) 
void uiMainWin::showNormal (  ) 
bool uiMainWin::shrinkAllowed (  ) 
uiStatusBar* uiMainWin::statusBar (  ) 
const ObjectSet<uiToolBar>& uiMainWin::toolBars (  )  const
uiGroup* uiMainWin::topGroup (  ) 
void uiMainWin::toStatusBar ( const char *  ,
int  fldidx = 0,
int  msecs = -1 
)
bool uiMainWin::touch (  ) 

resets pop-up timer if !poppedUp yet

void uiMainWin::translate (  ) 
static const char* uiMainWin::uniqueWinTitle ( const char *  txt,
QWidget *  forwindow = 0 
) [static]
void uiMainWin::updateToolbarsMenu (  ) 

Friends And Related Function Documentation

friend class uiMainWinBody [friend]

Member Data Documentation

uiMainWinBody* uiMainWin::body_ [protected]

Reimplemented from uiBaseObject.

triggered when window exits