org.kde.koala
Class KCursor

java.lang.Object
  extended by org.kde.qt.Qt
      extended by org.kde.koala.KCursor
All Implemented Interfaces:
org.kde.qt.QtSupport

public class KCursor
extends org.kde.qt.Qt

A wrapper around QCursor that allows for "themed" cursors. Currently, the only themed cursor is a hand shaped cursor. A typical usage would be

 setCursor(KCursor.handCursor());
 

Author:
Kurt Granroth

Field Summary
 
Fields inherited from class org.kde.qt.Qt
AlignAuto, AlignBottom, AlignCenter, AlignHCenter, AlignHorizontal_Mask, AlignJustify, AlignLeft, AlignRight, AlignTop, AlignVCenter, AlignVertical_Mask, AlphaDither_Mask, ALT, AltButton, AnchorHref, AnchorName, AndNotROP, AndROP, ArrowCursor, Ascending, ASCII_ACCEL, AutoColor, AutoDither, AutoText, AvoidDither, BDiagPattern, BeginsWith, BevelJoin, BitmapCursor, BlankCursor, Bottom, BottomLeft, BottomRight, BreakAnywhere, BusyCursor, CaseSensitive, ClearROP, ColorMode_Mask, ColorOnly, Contains, ControlButton, CopyROP, CrossCursor, CrossPattern, CTRL, CustomPattern, DashDotDotLine, DashDotLine, DashLine, Dense1Pattern, Dense2Pattern, Dense3Pattern, Dense4Pattern, Dense5Pattern, Dense6Pattern, Dense7Pattern, Descending, DiagCrossPattern, DiffuseAlphaDither, DiffuseDither, Dither_Mask, DitherMode_Mask, DockBottom, DockLeft, DockMinimized, DockRight, DockTop, DockTornOff, DockUnmanaged, DontClip, DontPrint, DotLine, DownArrow, EndsWith, EraseROP, ExactMatch, ExpandTabs, FDiagPattern, FixedColor, FixedPixmap, FlatCap, ForbiddenCursor, HiEnglishUnit, HiMetricUnit, Horizontal, HorPattern, IbeamCursor, Identical, IncludeTrailingSpaces, ISODate, Key_0, Key_1, Key_2, Key_3, Key_4, Key_5, Key_6, Key_7, Key_8, Key_9, Key_A, Key_aacute, Key_Aacute, Key_acircumflex, Key_Acircumflex, Key_acute, Key_adiaeresis, Key_Adiaeresis, Key_ae, Key_AE, Key_agrave, Key_Agrave, Key_Alt, Key_Ampersand, Key_Any, Key_Apostrophe, Key_aring, Key_Aring, Key_AsciiCircum, Key_AsciiTilde, Key_Asterisk, Key_At, Key_atilde, Key_Atilde, Key_B, Key_Back, Key_Backslash, Key_Backspace, Key_BackSpace, Key_Backtab, Key_BackTab, Key_Bar, Key_BassBoost, Key_BassDown, Key_BassUp, Key_BraceLeft, Key_BraceRight, Key_BracketLeft, Key_BracketRight, Key_brokenbar, Key_C, Key_CapsLock, Key_ccedilla, Key_Ccedilla, Key_cedilla, Key_cent, Key_Clear, Key_Colon, Key_Comma, Key_Control, Key_copyright, Key_currency, Key_D, Key_degree, Key_Delete, Key_diaeresis, Key_Direction_L, Key_Direction_R, Key_division, Key_Dollar, Key_Down, Key_E, Key_eacute, Key_Eacute, Key_ecircumflex, Key_Ecircumflex, Key_ediaeresis, Key_Ediaeresis, Key_egrave, Key_Egrave, Key_End, Key_Enter, Key_Equal, Key_Escape, Key_eth, Key_ETH, Key_Exclam, Key_exclamdown, Key_F, Key_F1, Key_F10, Key_F11, Key_F12, Key_F13, Key_F14, Key_F15, Key_F16, Key_F17, Key_F18, Key_F19, Key_F2, Key_F20, Key_F21, Key_F22, Key_F23, Key_F24, Key_F25, Key_F26, Key_F27, Key_F28, Key_F29, Key_F3, Key_F30, Key_F31, Key_F32, Key_F33, Key_F34, Key_F35, Key_F4, Key_F5, Key_F6, Key_F7, Key_F8, Key_F9, Key_Favorites, Key_Forward, Key_G, Key_Greater, Key_guillemotleft, Key_guillemotright, Key_H, Key_Help, Key_Home, Key_HomePage, Key_Hyper_L, Key_Hyper_R, Key_hyphen, Key_I, Key_iacute, Key_Iacute, Key_icircumflex, Key_Icircumflex, Key_idiaeresis, Key_Idiaeresis, Key_igrave, Key_Igrave, Key_Insert, Key_J, Key_K, Key_L, Key_Launch0, Key_Launch1, Key_Launch2, Key_Launch3, Key_Launch4, Key_Launch5, Key_Launch6, Key_Launch7, Key_Launch8, Key_Launch9, Key_LaunchA, Key_LaunchB, Key_LaunchC, Key_LaunchD, Key_LaunchE, Key_LaunchF, Key_LaunchMail, Key_LaunchMedia, Key_Left, Key_Less, Key_M, Key_macron, Key_masculine, Key_MediaLast, Key_MediaNext, Key_MediaPlay, Key_MediaPrev, Key_MediaRecord, Key_MediaStop, Key_Menu, Key_Meta, Key_Minus, Key_mu, Key_multiply, Key_N, Key_Next, Key_nobreakspace, Key_notsign, Key_ntilde, Key_Ntilde, Key_NumberSign, Key_NumLock, Key_O, Key_oacute, Key_Oacute, Key_ocircumflex, Key_Ocircumflex, Key_odiaeresis, Key_Odiaeresis, Key_ograve, Key_Ograve, Key_onehalf, Key_onequarter, Key_onesuperior, Key_Ooblique, Key_OpenUrl, Key_ordfeminine, Key_oslash, Key_otilde, Key_Otilde, Key_P, Key_PageDown, Key_PageUp, Key_paragraph, Key_ParenLeft, Key_ParenRight, Key_Pause, Key_Percent, Key_Period, Key_periodcentered, Key_Plus, Key_plusminus, Key_Print, Key_Prior, Key_Q, Key_Question, Key_questiondown, Key_QuoteDbl, Key_QuoteLeft, Key_R, Key_Refresh, Key_registered, Key_Return, Key_Right, Key_S, Key_ScrollLock, Key_Search, Key_section, Key_Semicolon, Key_Shift, Key_Slash, Key_Space, Key_ssharp, Key_Standby, Key_sterling, Key_Stop, Key_Super_L, Key_Super_R, Key_SysReq, Key_T, Key_Tab, Key_thorn, Key_THORN, Key_threequarters, Key_threesuperior, Key_TrebleDown, Key_TrebleUp, Key_twosuperior, Key_U, Key_uacute, Key_Uacute, Key_ucircumflex, Key_Ucircumflex, Key_udiaeresis, Key_Udiaeresis, Key_ugrave, Key_Ugrave, Key_Underscore, Key_unknown, Key_Up, Key_V, Key_VolumeDown, Key_VolumeMute, Key_VolumeUp, Key_W, Key_X, Key_Y, Key_yacute, Key_Yacute, Key_ydiaeresis, Key_yen, Key_Z, KeyButtonMask, Keypad, LastCursor, LastROP, Left, LeftArrow, LeftButton, LocalDate, LocalTime, LoEnglishUnit, LogText, LoMetricUnit, MacStyle, META, MetaButton, MidButton, Minimized, MiterJoin, MODIFIER_MASK, MonoOnly, MotifStyle, MouseButtonMask, MPenCapStyle, MPenJoinStyle, MPenStyle, MV_10_DOT_0, MV_10_DOT_1, MV_10_DOT_2, MV_10_DOT_3, MV_10_DOT_4, MV_9, MV_CHEETAH, MV_JAGUAR, MV_PANTHER, MV_PUMA, MV_TIGER, MV_Unknown, NandROP, NoAccel, NoAlpha, NoBackground, NoBrush, NoButton, NoMatch, NoPen, NopROP, NorROP, NotAndROP, NotCopyROP, NotEraseROP, NotOrROP, NotROP, NotXorROP, OpaqueMode, OrderedAlphaDither, OrderedDither, OrNotROP, OrROP, Overline, PaletteBackground, PaletteBase, PaletteBrightText, PaletteButton, PaletteButtonText, PaletteDark, PaletteForeground, PaletteHighlight, PaletteHighlightedText, PaletteLight, PaletteLink, PaletteLinkVisited, PaletteMid, PaletteMidlight, PaletteShadow, PaletteText, PartialMatch, PixelUnit, PlainText, PMStyle, PointingHandCursor, PreferDither, RichText, Right, RightArrow, RightButton, RoundCap, RoundJoin, SetROP, SHIFT, ShiftButton, ShowPrefix, SingleLine, SizeAllCursor, SizeBDiagCursor, SizeFDiagCursor, SizeHorCursor, SizeVerCursor, SolidLine, SolidPattern, SplitHCursor, SplitVCursor, SquareCap, StrikeOut, TextDate, ThresholdAlphaDither, ThresholdDither, Top, TopLeft, TopRight, TornOff, TransparentMode, TwipsUnit, UI_AnimateCombo, UI_AnimateMenu, UI_AnimateToolBox, UI_AnimateTooltip, UI_FadeMenu, UI_FadeTooltip, UI_General, Underline, UNICODE_ACCEL, Unmanaged, UpArrow, UpArrowCursor, UTC, VerPattern, Vertical, WaitCursor, WDestructiveClose, WGroupLeader, WhatsThisCursor, Win3Style, WindowActive, WindowFullScreen, WindowMaximized, WindowMinimized, WindowNoState, WindowsStyle, WMacDrawer, WMacNoSheet, WMouseNoMask, WNoAutoErase, WNoMousePropagation, WNorthWestGravity, WordBreak, WPaintClever, WPaintDesktop, WPaintUnclipped, WRepaintNoErase, WResizeNoErase, WShowModal, WState_AutoMask, WState_BlockUpdates, WState_CompressKeys, WState_ConfigPending, WState_Created, WState_CreatedHidden, WState_Disabled, WState_DND, WState_Exposed, WState_ForceDisabled, WState_ForceHide, WState_FullScreen, WState_HasMouse, WState_InPaintEvent, WState_Maximized, WState_Minimized, WState_MouseTracking, WState_OwnCursor, WState_OwnSizePolicy, WState_Polished, WState_Reparented, WState_Reserved0, WState_Resized, WState_Visible, WStaticContents, WStyle_ContextHelp, WStyle_Customize, WStyle_Dialog, WStyle_DialogBorder, WStyle_Mask, WStyle_Maximize, WStyle_Minimize, WStyle_MinMax, WStyle_NoBorder, WStyle_NoBorderEx, WStyle_NormalBorder, WStyle_Reserved, WStyle_Splash, WStyle_StaysOnTop, WStyle_SysMenu, WStyle_Title, WStyle_Tool, WSubWindow, WType_Desktop, WType_Dialog, WType_Mask, WType_Modal, WType_Popup, WType_TopLevel, WV_2000, WV_2003, WV_32s, WV_95, WV_98, WV_CE, WV_CE_based, WV_CENET, WV_DOS_based, WV_Me, WV_NT, WV_NT_based, WV_XP, WWinOwnDC, WX11BypassWM, X11ParentRelative, XorROP
 
Constructor Summary
  KCursor()
          Constructor.
protected KCursor(java.lang.Class dummy)
           
 
Method Summary
static org.kde.qt.QCursor arrowCursor()
          Returns the proper arrow cursor according to the current GUI style (static function).
static void autoHideEventFilter(org.kde.qt.QObject arg1, org.kde.qt.QEvent arg2)
          KCursor has to install an eventFilter over the widget you want to auto-hide.
static org.kde.qt.QCursor blankCursor()
          Returns a blank or invisible cursor (static function).
static org.kde.qt.QCursor crossCursor()
          Returns the proper cross-hair cursor according to the current GUI style (static function).
 void dispose()
          Delete the wrapped C++ instance ahead of finalize()
protected  void finalize()
          Deletes the wrapped C++ instance
static org.kde.qt.QCursor handCursor()
          Returns the proper hand cursor according to the current GUI style (static function).
static int hideCursorDelay()
          Default is 5000, i.e.
static org.kde.qt.QCursor ibeamCursor()
          Returns the proper text cursor according to the current GUI style (static function).
 boolean isDisposed()
          Has the wrapped C++ instance been deleted?
static void setAutoHideCursor(org.kde.qt.QWidget w, boolean enable)
          Sets auto-hiding the cursor for widget w. Enabling it will result in the cursor being hidden when a key-event happens there are no key-events for a configured time-frame (see setHideCursorDelay()) The cursor will be shown again when the focus is lost or a mouse-event happens.
static void setAutoHideCursor(org.kde.qt.QWidget w, boolean enable, boolean customEventFilter)
          Overloaded method for the case where you have an event-filter installed on the widget you want to enable auto-cursor-hiding.
static void setHideCursorDelay(int ms)
          Sets the delay time in milliseconds for auto-hiding.
static org.kde.qt.QCursor sizeAllCursor()
          Returns the proper all-directions resize cursor according to the current GUI style (static function).
static org.kde.qt.QCursor sizeBDiagCursor()
          Returns the proper diagonal resize (/) cursor according to the current GUI style (static function).
static org.kde.qt.QCursor sizeFDiagCursor()
          Returns the proper diagonal resize (\) cursor according to the current GUI style (static function).
static org.kde.qt.QCursor sizeHorCursor()
          Returns the proper horizontal resize cursor according to the current GUI style (static function).
static org.kde.qt.QCursor sizeVerCursor()
          Returns the proper vertical resize cursor according to the current GUI style (static function).
static org.kde.qt.QCursor upArrowCursor()
          Returns the proper up arrow cursor according to the current GUI style (static function).
static org.kde.qt.QCursor waitCursor()
          Returns the proper hourglass cursor according to the current GUI style (static function).
static org.kde.qt.QCursor whatsThisCursor()
          Returns a WhatsThis cursor (static function).
static org.kde.qt.QCursor workingCursor()
          Returns the proper arrow+hourglass cursor according to the current GUI style (static function).
 
Methods inherited from class org.kde.qt.Qt
bin, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, bitBlt, black, blue, color0, color1, copyBlt, copyBlt, copyBlt, copyBlt, copyBlt, cyan, darkBlue, darkCyan, darkGray, darkGreen, darkMagenta, darkRed, darkYellow, dec, dynamicCast, endl, flush, forbiddenCursor, fromUtf8, gray, green, hex, lightGray, magenta, oct, op_div, op_div, op_div, op_div, op_equals, op_equals, op_equals, op_equals, op_minus, op_minus, op_minus, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_mult, op_not_equals, op_not_equals, op_not_equals, op_not_equals, op_plus, op_plus, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_read, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, op_write, pointingHandCursor, qAlpha, qApp, qAppName, qBlue, qCompress, qCompress, qDebug, qDebug, qDrawArrow, qDrawItem, qDrawItem, qDrawItem, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawPlainRect, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadeLine, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadePanel, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawShadeRect, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinButton, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qDrawWinPanel, qFatal, qFatal, qGLVersion, qGray, qGray, qGreen, qInitNetworkProtocols, qInstallPath, qInstallPathBins, qInstallPathData, qInstallPathDocs, qInstallPathHeaders, qInstallPathLibs, qInstallPathPlugins, qInstallPathSysconf, qInstallPathTranslations, qItemRect, qItemRect, qObsolete, qObsolete, qObsolete, qRed, qRgb, qRgba, qRound, qSharedBuild, qSuppressObsoleteWarnings, qSuppressObsoleteWarnings, qSysInfo, qSystemWarning, qSystemWarning, qUncompress, qUncompress, qVersion, qWarning, qWarning, red, reset, SIGNAL, SLOT, splitHCursor, splitVCursor, white, ws, yellow
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

KCursor

protected KCursor(java.lang.Class dummy)

KCursor

public KCursor()
Constructor. Does not do anything so far.

Method Detail

handCursor

public static org.kde.qt.QCursor handCursor()
Returns the proper hand cursor according to the current GUI style (static function).


workingCursor

public static org.kde.qt.QCursor workingCursor()
Returns the proper arrow+hourglass cursor according to the current GUI style (static function).


arrowCursor

public static org.kde.qt.QCursor arrowCursor()
Returns the proper arrow cursor according to the current GUI style (static function).


upArrowCursor

public static org.kde.qt.QCursor upArrowCursor()
Returns the proper up arrow cursor according to the current GUI style (static function).


crossCursor

public static org.kde.qt.QCursor crossCursor()
Returns the proper cross-hair cursor according to the current GUI style (static function).


waitCursor

public static org.kde.qt.QCursor waitCursor()
Returns the proper hourglass cursor according to the current GUI style (static function).


ibeamCursor

public static org.kde.qt.QCursor ibeamCursor()
Returns the proper text cursor according to the current GUI style (static function).


sizeVerCursor

public static org.kde.qt.QCursor sizeVerCursor()
Returns the proper vertical resize cursor according to the current GUI style (static function).


sizeHorCursor

public static org.kde.qt.QCursor sizeHorCursor()
Returns the proper horizontal resize cursor according to the current GUI style (static function).


sizeBDiagCursor

public static org.kde.qt.QCursor sizeBDiagCursor()
Returns the proper diagonal resize (/) cursor according to the current GUI style (static function).


sizeFDiagCursor

public static org.kde.qt.QCursor sizeFDiagCursor()
Returns the proper diagonal resize (\) cursor according to the current GUI style (static function).


sizeAllCursor

public static org.kde.qt.QCursor sizeAllCursor()
Returns the proper all-directions resize cursor according to the current GUI style (static function).


blankCursor

public static org.kde.qt.QCursor blankCursor()
Returns a blank or invisible cursor (static function).


whatsThisCursor

public static org.kde.qt.QCursor whatsThisCursor()
Returns a WhatsThis cursor (static function).


setAutoHideCursor

public static void setAutoHideCursor(org.kde.qt.QWidget w,
                                     boolean enable)
Sets auto-hiding the cursor for widget w. Enabling it will result in the cursor being hidden when
  • a key-event happens
  • there are no key-events for a configured time-frame (see setHideCursorDelay())
  • The cursor will be shown again when the focus is lost or a mouse-event happens. Side effect: when enabling auto-hide, mouseTracking is enabled for the specified widget, because it's needed to get mouse-move-events. So don't disable mouseTracking for a widget while using auto-hide for it. When disabling auto-hide, mouseTracking will be disabled, so if you need mouseTracking after disabling auto-hide, you have to reenable mouseTracking. If you want to use auto-hiding for widgets that don't take focus, e.g. a QCanvasView, then you have to pass all key-events that should trigger auto-hiding to autoHideEventFilter().


    setAutoHideCursor

    public static void setAutoHideCursor(org.kde.qt.QWidget w,
                                         boolean enable,
                                         boolean customEventFilter)
    Overloaded method for the case where you have an event-filter installed on the widget you want to enable auto-cursor-hiding. In this case set customEventFilter to true and call autoHideEventFilter() from the beginning of your eventFilter().

    See Also:
    autoHideEventFilter(org.kde.qt.QObject, org.kde.qt.QEvent)

    setHideCursorDelay

    public static void setHideCursorDelay(int ms)
    Sets the delay time in milliseconds for auto-hiding. When no keyboard events arrive for that time-frame, the cursor will be hidden. Default is 5000, i.e. 5 seconds.


    hideCursorDelay

    public static int hideCursorDelay()
    Default is 5000, i.e. 5 seconds.

    Returns:
    the current auto-hide delay time.

    autoHideEventFilter

    public static void autoHideEventFilter(org.kde.qt.QObject arg1,
                                           org.kde.qt.QEvent arg2)
    KCursor has to install an eventFilter over the widget you want to auto-hide. If you have an own eventFilter() on that widget and stop some events by returning true, you might break auto-hiding, because KCursor doesn't get those events. In this case, you need to call setAutoHideCursor( widget, true, true ); to tell KCursor not to install an eventFilter. Then you call this method from the beginning of your eventFilter, for example:
                     edit = new KEdit( this, "some edit widget" );
                     edit.installEventFilter( this );
                     KCursor.setAutoHideCursor( edit, true, true );
                             [...]
                             boolean YourClass.eventFilter( QObject o, QEvent e )
                     {
                         if ( o == edit ) // only that widget where you enabled auto-hide!
                             KCursor.autoHideEventFilter( o, e );
                                 // now you can do your own event-processing
                         [...]
                     }
                     
    Note that you must not call KCursor.autoHideEventFilter() when you didn't enable or after disabling auto-hiding.


    finalize

    protected void finalize()
                     throws java.lang.InternalError
    Deletes the wrapped C++ instance

    Overrides:
    finalize in class org.kde.qt.Qt
    Throws:
    java.lang.InternalError

    dispose

    public void dispose()
    Delete the wrapped C++ instance ahead of finalize()

    Overrides:
    dispose in class org.kde.qt.Qt

    isDisposed

    public boolean isDisposed()
    Has the wrapped C++ instance been deleted?

    Overrides:
    isDisposed in class org.kde.qt.Qt