path: root/kdejava/koala/org/kde/koala/KPassivePopup.java

//Auto-generated by kalyptus. DO NOT EDIT.
package org.kde.koala;

import org.kde.qt.Qt;
import org.kde.qt.TQRect;
import org.kde.qt.TQHideEvent;
import org.kde.qt.TQMetaObject;
import org.kde.qt.QtSupport;
import org.kde.qt.TQPixmap;
import org.kde.qt.TQPaintEvent;
import org.kde.qt.TQPoint;
import org.kde.qt.TQMouseEvent;
import org.kde.qt.TQWidget;
import org.kde.qt.TQVBox;
import org.kde.qt.TQFrame;

/**

 The simplest uses of KPassivePopup are by using the various message() static
 methods. The position the popup appears at depends on the type of the parent window:

	<li>
	Normal Windows: The popup is placed adjacent to the icon of the window.
	</li>
	
	<li>
	System Tray Windows: The popup is placed adjact to the system tray window itself.
	</li>
	
	<li>
	Skip Taskbar Windows: The popup is placed adjact to the window
	     itself if it is visible, and at the edge of the desktop otherwise.
	</li>
	 You also have the option of calling show with a TQPoint as a parameter that
 removes the automatic placing of KPassivePopup and shows it in the point you want.
 The most basic use of KPassivePopup displays a popup containing a piece of text:
 <pre>
    KPassivePopup.message( "This is the message", this );
 </pre>
 We can create popups with titles and icons too, as this example shows:
 <pre>
    TQPixmap px;
    px.load( "hi32-app-logtracker.png" );
    KPassivePopup.message( "Some title", "This is the main text", px, this );
 </pre>
 For more control over the popup, you can use the setView(TQWidget ) method
 to create a custom popup.
 <pre>
    KPassivePopup pop = new KPassivePopup( parent );
    TQVBox vb = new TQVBox( pop );
     new TQLabel( vb, "<b>Isn't this great?</b>" );
    TQHBox box = new TQHBox( vb );
     new TQPushButton( box, "Yes" );
     new TQPushButton( box, "No" );
    pop.setView( vb );
    pop.show();
 </pre>
 See {@link KPassivePopupSignals} for signals emitted by KPassivePopup
		@author Sascha Cunz, sascha.cunz@tiscali.de
 
		@version $Id$

		@short A dialog-like popup that displays messages without interupting the user.

*/
public class KPassivePopup extends TQFrame  {
	protected KPassivePopup(Class dummy){super((Class) null);}
	/**	
		 Styles that a KPassivePopup can have.
				@short    Styles that a KPassivePopup can have.
	*/
	public static final int Boxed = 0;
	public static final int Balloon = 1;
	public static final int CustomStyle = 128;

	public native TQMetaObject metaObject();
	public native String className();
	/**	
		 Creates a popup for the specified widget.
		     		@short    Creates a popup for the specified widget.
	*/
	public KPassivePopup(TQWidget parent, String name, int f) {
		super((Class) null);
		newKPassivePopup(parent,name,f);
	}
	private native void newKPassivePopup(TQWidget parent, String name, int f);
	public KPassivePopup(TQWidget parent, String name) {
		super((Class) null);
		newKPassivePopup(parent,name);
	}
	private native void newKPassivePopup(TQWidget parent, String name);
	public KPassivePopup(TQWidget parent) {
		super((Class) null);
		newKPassivePopup(parent);
	}
	private native void newKPassivePopup(TQWidget parent);
	public KPassivePopup() {
		super((Class) null);
		newKPassivePopup();
	}
	private native void newKPassivePopup();
	/**	
		 Creates a popup for the specified window.
		     		@short    Creates a popup for the specified window.
	*/
	public KPassivePopup(long parent, String name, int f) {
		super((Class) null);
		newKPassivePopup(parent,name,f);
	}
	private native void newKPassivePopup(long parent, String name, int f);
	public KPassivePopup(long parent, String name) {
		super((Class) null);
		newKPassivePopup(parent,name);
	}
	private native void newKPassivePopup(long parent, String name);
	public KPassivePopup(long parent) {
		super((Class) null);
		newKPassivePopup(parent);
	}
	private native void newKPassivePopup(long parent);
	/**	
		 Creates a popup for the specified widget.
				@short    Creates a popup for the specified widget.
	*/
	public KPassivePopup(int popupStyle, TQWidget parent, String name, int f) {
		super((Class) null);
		newKPassivePopup(popupStyle,parent,name,f);
	}
	private native void newKPassivePopup(int popupStyle, TQWidget parent, String name, int f);
	public KPassivePopup(int popupStyle, TQWidget parent, String name) {
		super((Class) null);
		newKPassivePopup(popupStyle,parent,name);
	}
	private native void newKPassivePopup(int popupStyle, TQWidget parent, String name);
	public KPassivePopup(int popupStyle, TQWidget parent) {
		super((Class) null);
		newKPassivePopup(popupStyle,parent);
	}
	private native void newKPassivePopup(int popupStyle, TQWidget parent);
	public KPassivePopup(int popupStyle) {
		super((Class) null);
		newKPassivePopup(popupStyle);
	}
	private native void newKPassivePopup(int popupStyle);
	/**	
		 Creates a popup for the specified window.
				@short    Creates a popup for the specified window.
	*/
	public KPassivePopup(int popupStyle, long parent, String name, int f) {
		super((Class) null);
		newKPassivePopup(popupStyle,parent,name,f);
	}
	private native void newKPassivePopup(int popupStyle, long parent, String name, int f);
	public KPassivePopup(int popupStyle, long parent, String name) {
		super((Class) null);
		newKPassivePopup(popupStyle,parent,name);
	}
	private native void newKPassivePopup(int popupStyle, long parent, String name);
	public KPassivePopup(int popupStyle, long parent) {
		super((Class) null);
		newKPassivePopup(popupStyle,parent);
	}
	private native void newKPassivePopup(int popupStyle, long parent);
	/**	
		 Sets the main view to be the specified widget (which must be a child of the popup).
		     		@short    Sets the main view to be the specified widget (which must be a child of the popup).
	*/
	public native void setView(TQWidget child);
	/**	
		 Creates a standard view then calls setView(TQWidget) .
		     		@short    Creates a standard view then calls setView(TQWidget ) .
	*/
	public native void setView(String caption, String text);
	public native void setView(String caption);
	/**	
		 Creates a standard view then calls setView(TQWidget) .
		     		@short    Creates a standard view then calls setView(TQWidget ) .
	*/
	public native void setView(String caption, String text, TQPixmap icon);
	/**	
		 Returns a widget that is used as standard view if one of the 
		 setView() methods taking the String arguments is used.
		 You can use the returned widget to customize the passivepopup while 
		 keeping the look similar to the "standard" passivepopups.
			 After customizing the widget, pass it to setView( TQWidget )
			@param caption The window caption (title) on the popup
			@param text The text for the popup
			@param icon The icon to use for the popup
			@param parent The parent widget used for the returned TQVBox. If left null,
		 then "this", i.e. the passive popup object will be used.
				@return a TQVBox containing the given arguments, looking like the
 standard passivepopups.

		@short    Returns a widget that is used as standard view if one of the   setView() methods taking the String arguments is used.
		@see #setView(
		@see org.kde.qt.TQWidget
		@see #setView(
		@see #const
		@see #const
		@see #setView(
		@see #const
		@see #const
		@see #const
		@see org.kde.qt.TQPixmap&
	*/
	public native TQVBox standardView(String caption, String text, TQPixmap icon, TQWidget parent);
	public native TQVBox standardView(String caption, String text, TQPixmap icon);
	/**	
		 Returns the main view.
		     		@short    Returns the main view.
	*/
	public native TQWidget view();
	/**	
		 Returns the delay before the popup is removed automatically.
		     		@short    Returns the delay before the popup is removed automatically.
	*/
	public native int timeout();
	/**	
		 Enables / disables auto-deletion of this widget when the timeout
		 occurs.
		 The default is false. If you use the class-methods message(),
		 auto-delection is turned on by default.
		     		@short    Enables / disables auto-deletion of this widget when the timeout  occurs.
	*/
	public native void setAutoDelete(boolean autoDelete);
	/**	
				@return true if the widget auto-deletes itself when the timeout occurs.

		@short   
		@see #setAutoDelete
	*/
	public native boolean autoDelete();
	/**	
		 Sets the anchor of this balloon. The balloon tries automatically to adjust
		 itself somehow around the point.
				@short    Sets the anchor of this balloon.
	*/
	public native void setAnchor(TQPoint anchor);
	/**	
		 Sets the delay for the popup is removed automatically. Setting the delay to 0
		 disables the timeout, if you're doing this, you may want to connect the
		 clicked() signal to the hide() slot.
		 Setting the delay to -1 makes it use the default value.
				@short    Sets the delay for the popup is removed automatically.
		@see #timeout
	*/
	public native void setTimeout(int delay);
	/**	
		 Reimplemented to reposition the popup.
		     		@short    Reimplemented to reposition the popup.
	*/
	public native void show();
	/**	
		 Shows the popup in the given point
				@short    Shows the popup in the given point
	*/
	public native void show(TQPoint p);
	/**	
		 Convenience method that displays popup with the specified  message  beside the
		 icon of the specified widget.
		 Note that the returned object is destroyed when it is hidden.
				@short    Convenience method that displays popup with the specified  message  beside the  icon of the specified widget.
		@see #setAutoDelete
	*/
	public static native KPassivePopup message(String text, TQWidget parent, String name);
	public static native KPassivePopup message(String text, TQWidget parent);
	/**	
		 Convenience method that displays popup with the specified caption and message
		 beside the icon of the specified widget.
		 Note that the returned object is destroyed when it is hidden.
				@short    Convenience method that displays popup with the specified caption and message  beside the icon of the specified widget.
		@see #setAutoDelete
	*/
	public static native KPassivePopup message(String caption, String text, TQWidget parent, String name);
	public static native KPassivePopup message(String caption, String text, TQWidget parent);
	/**	
		 Convenience method that displays popup with the specified icon, caption and
		 message beside the icon of the specified widget.
		 Note that the returned object is destroyed when it is hidden.
				@short    Convenience method that displays popup with the specified icon, caption and  message beside the icon of the specified widget.
		@see #setAutoDelete
	*/
	public static native KPassivePopup message(String caption, String text, TQPixmap icon, TQWidget parent, String name, int timeout);
	public static native KPassivePopup message(String caption, String text, TQPixmap icon, TQWidget parent, String name);
	public static native KPassivePopup message(String caption, String text, TQPixmap icon, TQWidget parent);
	/**	
		 Convenience method that displays popup with the specified icon, caption and
		 message beside the icon of the specified window.
		 Note that the returned object is destroyed when it is hidden.
				@short    Convenience method that displays popup with the specified icon, caption and  message beside the icon of the specified window.
		@see #setAutoDelete
	*/
	public static native KPassivePopup message(String caption, String text, TQPixmap icon, long parent, String name, int timeout);
	public static native KPassivePopup message(String caption, String text, TQPixmap icon, long parent, String name);
	public static native KPassivePopup message(String caption, String text, TQPixmap icon, long parent);
	/**	
		 Convenience method that displays popup with the specified popup-style and message beside the
		 icon of the specified widget.
		 Note that the returned object is destroyed when it is hidden.
				@short    Convenience method that displays popup with the specified popup-style and message beside the  icon of the specified widget.
		@see #setAutoDelete
	*/
	public static native KPassivePopup message(int popupStyle, String text, TQWidget parent, String name);
	public static native KPassivePopup message(int popupStyle, String text, TQWidget parent);
	/**	
		 Convenience method that displays popup with the specified popup-style, caption and message
		 beside the icon of the specified widget.
		 Note that the returned object is destroyed when it is hidden.
				@short    Convenience method that displays popup with the specified popup-style, caption and message  beside the icon of the specified widget.
		@see #setAutoDelete
	*/
	public static native KPassivePopup message(int popupStyle, String caption, String text, TQWidget parent, String name);
	public static native KPassivePopup message(int popupStyle, String caption, String text, TQWidget parent);
	/**	
		 Convenience method that displays popup with the specified popup-style, icon, caption and
		 message beside the icon of the specified widget.
		 Note that the returned object is destroyed when it is hidden.
				@short    Convenience method that displays popup with the specified popup-style, icon, caption and  message beside the icon of the specified widget.
		@see #setAutoDelete
	*/
	public static native KPassivePopup message(int popupStyle, String caption, String text, TQPixmap icon, TQWidget parent, String name, int timeout);
	public static native KPassivePopup message(int popupStyle, String caption, String text, TQPixmap icon, TQWidget parent, String name);
	public static native KPassivePopup message(int popupStyle, String caption, String text, TQPixmap icon, TQWidget parent);
	/**	
		 Convenience method that displays popup with the specified popup-style, icon, caption and
		 message beside the icon of the specified window.
		 Note that the returned object is destroyed when it is hidden.
				@short    Convenience method that displays popup with the specified popup-style, icon, caption and  message beside the icon of the specified window.
		@see #setAutoDelete
	*/
	public static native KPassivePopup message(int popupStyle, String caption, String text, TQPixmap icon, long parent, String name, int timeout);
	public static native KPassivePopup message(int popupStyle, String caption, String text, TQPixmap icon, long parent, String name);
	public static native KPassivePopup message(int popupStyle, String caption, String text, TQPixmap icon, long parent);
	/**	
		 This method positions the popup.
		     		@short    This method positions the popup.
	*/
	protected native void positionSelf();
	/**	
		 Reimplemented to destroy the object when autoDelete() is
		 enabled.
		     		@short    Reimplemented to destroy the object when autoDelete() is  enabled.
	*/
	protected native void hideEvent(TQHideEvent arg1);
	/**	
		 Moves the popup to be adjacent to the icon of the specified rectangle.
		     		@short    Moves the popup to be adjacent to the icon of the specified rectangle.
	*/
	protected native void moveNear(TQRect target);
	/**	
		 Reimplemented to detect mouse clicks.
		     		@short    Reimplemented to detect mouse clicks.
	*/
	protected native void mouseReleaseEvent(TQMouseEvent e);
	/**	
		 If no relative window (eg taskbar button, system tray window) is
		 available, use this rectangle (pass it to moveNear()).
		 Basically KWinModule.workArea() with width and height set to 0
		 so that moveNear uses the upper-left position.
				@return The TQRect to be passed to moveNear() if no other is
 available.
     
		@short    If no relative window (eg taskbar button, system tray window) is  available, use this rectangle (pass it to moveNear()).
	*/
	protected native TQRect defaultArea();
	/**	
		 Updates the transparency mask. Unused if PopupStyle == Boxed
				@short    Updates the transparency mask.
	*/
	protected native void updateMask();
	/**	
		 Overwrite to paint the border when PopupStyle == Balloon.
		 Unused if PopupStyle == Boxed
		     		@short    Overwrite to paint the border when PopupStyle == Balloon.
	*/
	protected native void paintEvent(TQPaintEvent pe);
	/** Deletes the wrapped C++ instance */
	protected native void finalize() throws InternalError;
	/** Delete the wrapped C++ instance ahead of finalize() */
	public native void dispose();
	/** Has the wrapped C++ instance been deleted? */
	public native boolean isDisposed();
}