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

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

import org.kde.qt.Qt;
import org.kde.qt.TQColor;
import org.kde.qt.TQMetaObject;
import org.kde.qt.QtSupport;
import org.kde.qt.TQPixmap;
import org.kde.qt.TQMouseEvent;
import org.kde.qt.TQWidget;
import org.kde.qt.TQFrame;

/**

 A KDialogBase with predefined main widget.
 As a KDialogBase it uses your application wide settings
 for KDialogBase
 objects (base frame tiles, main frame tiles etc).
 To use it, simply create a KAboutDialog object, set all (or some) of its
 properties and show it. Do not derive it to create your own about dialog
 until you need some cool features that are unsupported and you have
 contacted me to add them.
 The dialog can be created using two different constructors. The
 difference between these constructors is the available components that
 can be used to build the contents of the dialog. The first (Constructor I)
 provides a number of easy to use methods. Basically it allows you
 to add the components of choice, and the components are placed in a
 predefined layout. You do not have to plan the layout. Everything is
 taken care of.
 The second constructor (Constructor II) works in quite the same manner
 as the first, but you have better control on where the components
 are postioned in the layout and you have access to an extended number
 of components you can install such as titles, product information,
 a tabbed pages (where you can display rich text with url links) and
 a person (developer) information field. The "About KDE" dialog box is
 created with Constructor II.
 For the derived features, see the basic class KDialogBase.
 See {@link KAboutDialogSignals} for signals emitted by KAboutDialog
		@author Mirko Boehm (mirko@kde.org) and Espen Sand (espensa@online.no)

		@short    A KDialogBase with predefined main widget.
		@see KDialogBase

*/
public class KAboutDialog extends KDialogBase  {
	protected KAboutDialog(Class dummy){super((Class) null);}
	/**	
		 Layout formats.
				@short    Layout formats.
	*/
	public static final int AbtPlain = 0x0001;
	public static final int AbtTabbed = 0x0002;
	public static final int AbtTitle = 0x0004;
	public static final int AbtImageLeft = 0x0008;
	public static final int AbtImageRight = 0x0010;
	public static final int AbtImageOnly = 0x0020;
	public static final int AbtProduct = 0x0040;
	public static final int AbtKDEStandard = AbtTabbed|AbtTitle|AbtImageLeft;
	public static final int AbtAppStandard = AbtTabbed|AbtTitle|AbtProduct;
	public static final int AbtImageAndTitle = AbtPlain|AbtTitle|AbtImageOnly;

	public native TQMetaObject metaObject();
	public native String className();
	/**	
		 The standard Qt constructor (Constructor I).
			 Add components with the following methods:
		 setLogo(), setAuthor(), setMaintainer(),
		 addContributor(), or setVersion().
		 The dialog will be laid out automatically.
		     		@short    The standard Qt constructor (Constructor I).
	*/
	public KAboutDialog(TQWidget parent, String name, boolean modal) {
		super((Class) null);
		newKAboutDialog(parent,name,modal);
	}
	private native void newKAboutDialog(TQWidget parent, String name, boolean modal);
	public KAboutDialog(TQWidget parent, String name) {
		super((Class) null);
		newKAboutDialog(parent,name);
	}
	private native void newKAboutDialog(TQWidget parent, String name);
	public KAboutDialog(TQWidget parent) {
		super((Class) null);
		newKAboutDialog(parent);
	}
	private native void newKAboutDialog(TQWidget parent);
	public KAboutDialog() {
		super((Class) null);
		newKAboutDialog();
	}
	private native void newKAboutDialog();
	/**	
		 The extended constructor. (Constructor II).
			 Add components with the methods:
		 setTitle(), setImage(), setImageBackgroundColor(),
		 setImageFrame(), setProduct(), addTextPage(),
		 addContainerPage(), addContainer(), or addPage().
			@param dialogLayout Use a mask of LayoutType flags.
			@param caption The dialog caption. The text you specify is prepended
		        by i18n("About").
			@param buttonMask Specifies what buttons will be visible.
			@param defaultButton Specifies what button will be marked as the default.
			@param parent Parent of the dialog.
			@param name Dialog name (for internal use only)
			@param modal Sets dialog modality. If false, the rest of the
		        program interface (other dialogs, for example) is accessible while
		        the dialog is open.
			@param separator If true, a separator line is drawn between the action
		        buttons an the main widget.
			@param user1 User button1 text.
			@param user2 User button2 text.
			@param user3 User button3 text.
			    		@short    The extended constructor.
	*/
	public KAboutDialog(int dialogLayout, String caption, int buttonMask, int defaultButton, TQWidget parent, String name, boolean modal, boolean separator, String user1, String user2, String user3) {
		super((Class) null);
		newKAboutDialog(dialogLayout,caption,buttonMask,defaultButton,parent,name,modal,separator,user1,user2,user3);
	}
	private native void newKAboutDialog(int dialogLayout, String caption, int buttonMask, int defaultButton, TQWidget parent, String name, boolean modal, boolean separator, String user1, String user2, String user3);
	public KAboutDialog(int dialogLayout, String caption, int buttonMask, int defaultButton, TQWidget parent, String name, boolean modal, boolean separator, String user1, String user2) {
		super((Class) null);
		newKAboutDialog(dialogLayout,caption,buttonMask,defaultButton,parent,name,modal,separator,user1,user2);
	}
	private native void newKAboutDialog(int dialogLayout, String caption, int buttonMask, int defaultButton, TQWidget parent, String name, boolean modal, boolean separator, String user1, String user2);
	public KAboutDialog(int dialogLayout, String caption, int buttonMask, int defaultButton, TQWidget parent, String name, boolean modal, boolean separator, String user1) {
		super((Class) null);
		newKAboutDialog(dialogLayout,caption,buttonMask,defaultButton,parent,name,modal,separator,user1);
	}
	private native void newKAboutDialog(int dialogLayout, String caption, int buttonMask, int defaultButton, TQWidget parent, String name, boolean modal, boolean separator, String user1);
	public KAboutDialog(int dialogLayout, String caption, int buttonMask, int defaultButton, TQWidget parent, String name, boolean modal, boolean separator) {
		super((Class) null);
		newKAboutDialog(dialogLayout,caption,buttonMask,defaultButton,parent,name,modal,separator);
	}
	private native void newKAboutDialog(int dialogLayout, String caption, int buttonMask, int defaultButton, TQWidget parent, String name, boolean modal, boolean separator);
	public KAboutDialog(int dialogLayout, String caption, int buttonMask, int defaultButton, TQWidget parent, String name, boolean modal) {
		super((Class) null);
		newKAboutDialog(dialogLayout,caption,buttonMask,defaultButton,parent,name,modal);
	}
	private native void newKAboutDialog(int dialogLayout, String caption, int buttonMask, int defaultButton, TQWidget parent, String name, boolean modal);
	public KAboutDialog(int dialogLayout, String caption, int buttonMask, int defaultButton, TQWidget parent, String name) {
		super((Class) null);
		newKAboutDialog(dialogLayout,caption,buttonMask,defaultButton,parent,name);
	}
	private native void newKAboutDialog(int dialogLayout, String caption, int buttonMask, int defaultButton, TQWidget parent, String name);
	public KAboutDialog(int dialogLayout, String caption, int buttonMask, int defaultButton, TQWidget parent) {
		super((Class) null);
		newKAboutDialog(dialogLayout,caption,buttonMask,defaultButton,parent);
	}
	private native void newKAboutDialog(int dialogLayout, String caption, int buttonMask, int defaultButton, TQWidget parent);
	public KAboutDialog(int dialogLayout, String caption, int buttonMask, int defaultButton) {
		super((Class) null);
		newKAboutDialog(dialogLayout,caption,buttonMask,defaultButton);
	}
	private native void newKAboutDialog(int dialogLayout, String caption, int buttonMask, int defaultButton);
	/**	
		 Adjusts the dialog.
			 You can call this method after you have set up all
		 the contents but it is not required. It is done automatically when
		 show() is executed.
		   		@short    Adjusts the dialog.
	*/
	public native void adjust();
	/**	
		 Makes a modeless (modal = false in constructor) dialog visible.
			 If you reimplement this method make sure you run it
		 in the new method (e.g., show()). Reimplemented
		 from KDialogBase.
		   		@short    Makes a modeless (modal = false in constructor) dialog visible.
	*/
	public native void show();
	/**	
		 Makes a modeless (modal = false in constructor) dialog visible.
			 If you reimplmement this method make sure you run it
		 in the new method (i.e., show( parent )).
			@param centerParent Center the dialog with respect to this widget.
		   		@short    Makes a modeless (modal = false in constructor) dialog visible.
	*/
	public native void show(TQWidget centerParent);
	/**	
		 (Constructor II only)
		 Sets a title (not caption) in the uppermost area of the dialog.
			@param title Title string.
		   		@short    (Constructor II only)  Sets a title (not caption) in the uppermost area of the dialog.
	*/
	public native void setTitle(String title);
	/**	
		 (Constructor II only)
		 Define an image to be shown in the dialog. The position is dependent
		 on the <code>dialogLayout</code> in the constructor
			@param fileName Path to image file.
		   		@short    (Constructor II only)  Define an image to be shown in the dialog.
	*/
	public native void setImage(String fileName);
	/**	
		 Overloaded version of setProgramLogo(TQPixmap pixmap).
				@short    Overloaded version of setProgramLogo(TQPixmap pixmap).
	*/
	public native void setProgramLogo(String fileName);
	/**	
		 (Constructor II only)
		 Define the program logo to be shown in the dialog.  Use this to override the
		 default program logo. For example, use this function if the 
		 KAboutDialog is for a panel applet and you want to override the
		 appletproxy logo with your own pixmap.
			@param pixmap The logo pixmap.
				@short    (Constructor II only)  Define the program logo to be shown in the dialog.
	*/
	public native void setProgramLogo(TQPixmap pixmap);
	/**	
		 (Constructor II only)
		 The image has a minimum size, but is centered within an area if the
		 dialog box is enlarged by the user. You set the background color
		 of the area with this method.
			@param color Background color.
		   		@short    (Constructor II only)  The image has a minimum size, but is centered within an area if the  dialog box is enlarged by the user.
	*/
	public native void setImageBackgroundColor(TQColor color);
	/**	
		 (Constructor II only)
		 Enables or disables a frame around the image. The frame is, by default,
		 enabled in the constructor
			@param state A value of <code>true</code> enables the frame
		   		@short    (Constructor II only)  Enables or disables a frame around the image.
	*/
	public native void setImageFrame(boolean state);
	/**	
		 (Constructor II only)
		 Prints the application name, KDE version, author, a copyright sign
		 and a year string. To the left of the text the standard application
		 icon is displayed.
			@param appName The application name.
			@param version Application version.
			@param author One or more authors.
			@param year A string telling when the application was made.
		   		@short    (Constructor II only)  Prints the application name, KDE version, author, a copyright sign  and a year string.
	*/
	public native void setProduct(String appName, String version, String author, String year);
	/**	
		 (Constructor II only)
		 Adds a text page to a tab box. The text can be regular text or
		 rich text. The rich text can contain URLs and mail links.
			@param title Tab name.
			@param text The text to display.
			@param richText Set this to <code>true</code> if 'text' is rich text.
			@param numLines The text area height will be adjusted so that this
		        is the minimum number of lines of text that are visible.
				@return The frame that contains the page.
   
		@short    (Constructor II only)  Adds a text page to a tab box.
	*/
	public native TQFrame addTextPage(String title, String text, boolean richText, int numLines);
	public native TQFrame addTextPage(String title, String text, boolean richText);
	public native TQFrame addTextPage(String title, String text);
	/**	
		 (Constructor II only)
		 Adds a license page to a tab box.
			@param title Tab name.
			@param text The text to display.
			@param numLines The text area height will be adjusted so that this
		        is the minimum number of lines of text that are visible.
				@return The frame that contains the page.
   
		@short    (Constructor II only)  Adds a license page to a tab box.
	*/
	public native TQFrame addLicensePage(String title, String text, int numLines);
	public native TQFrame addLicensePage(String title, String text);
	/**	
		 (Constructor II only)
		 Adds a container to a tab box. You can add text and images to a
		 container.
			@param title Tab name.
			@param childAlignment Specifies how the children of the container are
		        aligned with respect to the container.
			@param innerAlignment Specifies how the children are aligned with
		        respect to each other.
				@return The new container.
   
		@short    (Constructor II only)  Adds a container to a tab box.
	*/
	public native KAboutContainer addContainerPage(String title, int childAlignment, int innerAlignment);
	public native KAboutContainer addContainerPage(String title, int childAlignment);
	public native KAboutContainer addContainerPage(String title);
	/**	
		 (Constructor II only)
		 Adds a container inside a TQScrollView to a tab box. You can add text
		 and images to a container.
			@param title Tab name.
			@param childAlignment Specifies how the children of the container are
		        aligned with respect to the container.
			@param innerAlignment Specifies how the children are aligned with
		        respect to each other.
				@return The new container.
   
		@short    (Constructor II only)  Adds a container inside a TQScrollView to a tab box.
	*/
	public native KAboutContainer addScrolledContainerPage(String title, int childAlignment, int innerAlignment);
	public native KAboutContainer addScrolledContainerPage(String title, int childAlignment);
	public native KAboutContainer addScrolledContainerPage(String title);
	/**	
		 (Constructor II only)
		 Adds a container. You can add text and images to a container.
			@param childAlignment Specifies how the children of the container are
		        aligned with respect to the container.
			@param innerAlignment Specifies how the children are aligned with
		        respect to each other.
				@return The new container.
   
		@short    (Constructor II only)  Adds a container.
	*/
	public native KAboutContainer addContainer(int childAlignment, int innerAlignment);
	/**	
		 (Constructor II only)
		 Adds an empty page to a tab box.
			@param title Tab name
				@return The new page.
   
		@short    (Constructor II only)  Adds an empty page to a tab box.
	*/
	public native TQFrame addPage(String title);
	/**	
		 (Constructor I only)
		 Sets the image as the application logo.
		   		@short    (Constructor I only)  Sets the image as the application logo.
	*/
	public native void setLogo(TQPixmap arg1);
	/**	
		 (Constructor I only)
		 Sets the author's name and email address.
		   		@short    (Constructor I only)  Sets the author's name and email address.
	*/
	public native void setAuthor(String name, String email, String url, String work);
	/**	
		 (Constructor I only)
		 Sets the maintainer's name and email address.
		   		@short    (Constructor I only)  Sets the maintainer's name and email address.
	*/
	public native void setMaintainer(String name, String email, String url, String work);
	/**	
		 (Constructor I only)
		 Show this person as one of the major contributors.
		   		@short    (Constructor I only)  Show this person as one of the major contributors.
	*/
	public native void addContributor(String name, String email, String url, String work);
	/**	
		 (Constructor I only)
		 Sets the text describing the version.
		   		@short    (Constructor I only)  Sets the text describing the version.
	*/
	public native void setVersion(String name);
	/**	
		 Create a modal dialog with an image in the upper area with a
		 URL link below.
		   		@short    Create a modal dialog with an image in the upper area with a  URL link below.
	*/
	public static native void imageURL(TQWidget parent, String caption, String path, TQColor imageColor, String url);
	/**	
		 Connected to widget.sendEmail.
		   		@short    Connected to widget.sendEmail.
	*/
	protected native void sendEmailSlot(String name, String email);
	/**	
		 Open this URL.
		   		@short    Open this URL.
	*/
	protected native void openURLSlot(String url);
	/**	
		 (Constructor II only)
		 Tells the position of the mouse cursor when the left mouse button
		 is pressed above an image
		   		@short    (Constructor II only)  Tells the position of the mouse cursor when the left mouse button  is pressed above an image
	*/
	protected native void mouseTrackSlot(int mode, TQMouseEvent e);
	/** 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();
}